diff options
Diffstat (limited to 'doc/misc')
64 files changed, 3281 insertions, 1701 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 1ca638bb7fe..d756f4fd0f0 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog @@ -1,3 +1,144 @@ +2013-01-05 Andreas Schwab <schwab@linux-m68k.org> + + * ada-mode.texi: Remove braces from @title argument. + * eudc.texi: Likewise. + * smtpmail.texi: Likewise. + * auth.texi (VERSION): Set before first use. + * emacs-gnutls.texi (VERSION): Likewise. + * pgg.texi (VERSION): Likewise. + * ede.texi (Top): Rename from top, all uses changed. + * eshell.texi: Add missing argument to @sp. + * forms.texi (Top): Reorder menu to match structure. + * htmlfontify.texi (Customisation): Add missing @item in + @enumerate. + * org.texi (Advanced features): Add missing argument for @item. + (Property searches): Use @backslashchar{} in macro argument. + * pcl-cvs.texi: Add missing argument to @sp. + (Movement commands): Fix use of @itemx. + * vip.texi (Misc Commands, Viewing the Buffer): Likewise. + * reftex.texi (Options (Creating Citations)): Add missing newline + before @end. + * tramp.texi (Obtaining Tramp): Remove extra dots. + (Configuration): Reorder menu to match structure. + (Remote shell setup): Replace literal NUL character by \0. + * viper.texi (Marking): Add missing argument for @item. + +2013-01-04 Glenn Morris <rgm@gnu.org> + + * Makefile.in (INFO_TARGETS, DVI_TARGETS, PDF_TARGETS): + Add htmlfontify. + (htmlfontify, $(buildinfodir)/htmlfontify$(INFO_EXT)) + (htmlfontify.dvi, htmlfontify.pdf): New targets. + * makefile.w32-in (INFO_TARGETS, DVI_TARGETS, clean): Add htmlfontify. + ($(infodir)/htmlfontify$(INFO_EXT), htmlfontify.dvi): New targets. + + * htmlfontify.texi: Miscellaneous fixes and updates. + Set copyright to FSF, update license to GFDL 1.3+. + +2013-01-04 Vivek Dasmohapatra <vivek@etla.org> + + * htmlfontify.texi: New file. + +2013-01-02 Jay Belanger <jay.p.belanger@gmail.com> + + * calc.texi (Free-Form Dates): Expand on the date reading + algorithm. + +2012-12-27 Glenn Morris <rgm@gnu.org> + + * viper.texi (Rudimentary Changes, Key Bindings, Key Bindings): + Avoid some overfull lines. + + * widget.texi (Programming Example): Break some long lines. + + * wisent.texi (Wisent Overview): Fix xref. + (Grammar format, Understanding the automaton): Avoid overfill. + + * bovine.texi (Optional Lambda Expression): Allow line break. + + * auth.texi (Help for users): Break long lines. + + * ada-mode.texi (Project file variables): + Reword to reduce underfull hbox. + (No project files, Use GNAT project file): + Use smallexample to make some overfull lines less terrible. + + * autotype.texi, bovine.texi, ede.texi, eieio.texi, pcl-cvs.texi: + Fix cross-references to separate manuals. + + * Makefile.in (gfdl): New variable. Use throughout where + appropriate so that targets depend on doclicense.texi. + +2012-12-25 Lars Ingebrigtsen <larsi@gnus.org> + + * gnus.texi (Customizing the IMAP Connection): Mention the other + authenticators. + +2012-12-24 Lars Ingebrigtsen <larsi@gnus.org> + + * gnus.texi (Browse Foreign Server): Document + `gnus-browse-delete-group'. + +2012-12-22 Glenn Morris <rgm@gnu.org> + + * ada-mode.texi, ebrowse.texi, ediff.texi, ert.texi, eshell.texi: + * eudc.texi, idlwave.texi, pcl-cvs.texi, rcirc.texi, reftex.texi: + * remember.texi, ses.texi, speedbar.texi, vip.texi, viper.texi: + * widget.texi, wisent.texi: Nuke hand-written node pointers. + + * Makefile.in (gfdl): New variable. Use throughout where + appropriate so that targets depend on doclicense.texi. + +2012-12-22 Eli Zaretskii <eliz@gnu.org> + + * makefile.w32-in ($(INFO_TARGETS), $(DVI_TARGETS)): Depend on + doclicense.texi. Remove doclicense.texi from all targets that + mentioned it explicitly. + ($(infodir)/woman$(INFO_EXT), woman.dvi): Depend on + $(emacsdir)/emacsver.texi. + ($(infodir)/erc$(INFO_EXT), erc.dvi): Don't depend on gpl.texi. + +2012-12-21 Glenn Morris <rgm@gnu.org> + + * woman.texi (UPDATED, VERSION): Remove in favor of EMACSVER. + Include emacsver.texi. Nuke hand-written node pointers. + * Makefile.in ($(buildinfodir)/woman$(INFO_EXT), woman.dvi, woman.pdf): + Depend on emacsver.texi. + + * auth.texi, emacs-gnutls.texi, epa.texi, ert.texi: + * gnus-coding.texi, info.texi, nxml-mode.texi, sasl.texi: + May as well just include doclicense.texi in everything. + + * ede.texi, eieio.texi, mairix-el.texi: Include a copy of GFDL, + which @copying says is included. + + * ada-mode.texi, auth.texi, autotype.texi, bovine.texi, calc.texi: + * cc-mode.texi, cl.texi, dbus.texi, dired-x.texi, ebrowse.texi: + * ede.texi, ediff.texi, edt.texi, eieio.texi, emacs-gnutls.texi: + * emacs-mime.texi, epa.texi, erc.texi, ert.texi, eshell.texi: + * eudc.texi, flymake.texi, forms.texi, gnus-coding.texi, gnus.texi: + * idlwave.texi, info.texi, mairix-el.texi, message.texi, mh-e.texi: + * newsticker.texi, nxml-mode.texi, pcl-cvs.texi, pgg.texi: + * rcirc.texi, reftex.texi, remember.texi, sasl.texi, sc.texi: + * semantic.texi, ses.texi, sieve.texi, smtpmail.texi, speedbar.texi: + * srecode.texi, tramp.texi, url.texi, vip.texi, viper.texi: + * widget.texi, wisent.texi, woman.texi: Do not mention buying + copies from the FSF, which does not publish these manuals. + + * erc.texi: No need to include gpl in this small manual. + + * org.texi (copying): Include a copy of the GFDL. + (GNU Free Documentation License): New section. + +2012-12-21 Bastien Guerry <bzg@gnu.org> + + * org.texi: Fix typos. + +2012-12-16 Paul Eggert <eggert@cs.ucla.edu> + + * calc.texi (ISO 8601): Rename from ISO-8601, + as it's typically spelled without a hyphen. + 2012-12-16 Jay Belanger <jay.p.belanger@gmail.com> * calc.texi (ISO-8601): New section. @@ -435,7 +576,7 @@ * org.texi (Moving subtrees): Document the ability to archive to a datetree. -2012-09-30 Bastien Guerry <bzg@altern.org> +2012-09-30 Bastien Guerry <bzg@gnu.org> * org.texi (Installation, Feedback, Batch execution): Use (add-to-list 'load-path ... t) for the contrib dir. @@ -1041,7 +1182,7 @@ * org.texi: Edit :noweb no header argument for correctness. -2012-04-01 Bastien Guerry <bzg@altern.org> +2012-04-01 Bastien Guerry <bzg@gnu.org> * org.texi (Customization): Update the approximate number of Org variables. @@ -9812,7 +9953,7 @@ ;; coding: utf-8 ;; End: - Copyright (C) 1993-1999, 2001-2012 Free Software Foundation, Inc. + Copyright (C) 1993-1999, 2001-2013 Free Software Foundation, Inc. This file is part of GNU Emacs. diff --git a/doc/misc/Makefile.in b/doc/misc/Makefile.in index c99657fb9bb..3dac35aafee 100644 --- a/doc/misc/Makefile.in +++ b/doc/misc/Makefile.in @@ -1,6 +1,6 @@ #### Makefile for documentation other than the Emacs manual. -# Copyright (C) 1994, 1996-2012 Free Software Foundation, Inc. +# Copyright (C) 1994, 1996-2013 Free Software Foundation, Inc. # This file is part of GNU Emacs. @@ -27,7 +27,6 @@ srcdir=@srcdir@ ## Where the output files go. buildinfodir = $(srcdir)/../../info ## Directory with emacsver.texi. -## Currently only used by efaq and calc. emacsdir = $(srcdir)/../emacs MKDIR_P = @MKDIR_P@ @@ -44,7 +43,7 @@ MAKEINFO_OPTS = --force -I$(emacsdir) INFO_TARGETS = ada-mode auth autotype bovine calc ccmode cl \ dbus dired-x ebrowse ede ediff edt eieio \ emacs-mime epa erc ert eshell eudc efaq \ - flymake forms gnus emacs-gnutls idlwave info.info \ + flymake forms gnus emacs-gnutls htmlfontify idlwave info.info \ mairix-el message mh-e newsticker nxml-mode \ org pcl-cvs pgg rcirc remember reftex sasl \ sc semantic ses sieve smtpmail speedbar srecode tramp \ @@ -76,6 +75,7 @@ DVI_TARGETS = \ forms.dvi \ gnus.dvi \ emacs-gnutls.dvi \ + htmlfontify.dvi \ idlwave.dvi \ info.dvi \ mairix-el.dvi \ @@ -130,6 +130,7 @@ PDF_TARGETS = \ flymake.pdf \ forms.pdf \ gnus.pdf \ + htmlfontify.pdf \ emacs-gnutls.pdf \ idlwave.pdf \ info.pdf \ @@ -170,6 +171,8 @@ ENVADD = TEXINPUTS="$(srcdir):$(emacsdir):$(TEXINPUTS)" \ mkinfodir = @${MKDIR_P} ${buildinfodir} +gfdl = ${srcdir}/doclicense.texi + .PHONY: info dvi pdf echo-info ## Prevent implicit rule triggering for foo.info. .SUFFIXES: @@ -198,194 +201,195 @@ pdf: $(PDF_TARGETS) # Note: "<" is not portable in ordinary make rules. ada-mode : $(buildinfodir)/ada-mode$(INFO_EXT) -$(buildinfodir)/ada-mode$(INFO_EXT): ${srcdir}/ada-mode.texi +$(buildinfodir)/ada-mode$(INFO_EXT): ${srcdir}/ada-mode.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/ada-mode.texi -ada-mode.dvi: ${srcdir}/ada-mode.texi +ada-mode.dvi: ${srcdir}/ada-mode.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/ada-mode.texi -ada-mode.pdf: ${srcdir}/ada-mode.texi +ada-mode.pdf: ${srcdir}/ada-mode.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/ada-mode.texi auth : $(buildinfodir)/auth$(INFO_EXT) -$(buildinfodir)/auth$(INFO_EXT): ${srcdir}/auth.texi +$(buildinfodir)/auth$(INFO_EXT): ${srcdir}/auth.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/auth.texi -auth.dvi: ${srcdir}/auth.texi +auth.dvi: ${srcdir}/auth.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/auth.texi -auth.pdf: ${srcdir}/auth.texi +auth.pdf: ${srcdir}/auth.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/auth.texi autotype : $(buildinfodir)/autotype$(INFO_EXT) -$(buildinfodir)/autotype$(INFO_EXT): ${srcdir}/autotype.texi +$(buildinfodir)/autotype$(INFO_EXT): ${srcdir}/autotype.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/autotype.texi -autotype.dvi: ${srcdir}/autotype.texi +autotype.dvi: ${srcdir}/autotype.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/autotype.texi -autotype.pdf: ${srcdir}/autotype.texi +autotype.pdf: ${srcdir}/autotype.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/autotype.texi bovine : $(buildinfodir)/bovine$(INFO_EXT) -$(buildinfodir)/bovine$(INFO_EXT): ${srcdir}/bovine.texi +$(buildinfodir)/bovine$(INFO_EXT): ${srcdir}/bovine.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/bovine.texi -bovine.dvi: ${srcdir}/bovine.texi +bovine.dvi: ${srcdir}/bovine.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/bovine.texi -bovine.pdf: ${srcdir}/bovine.texi +bovine.pdf: ${srcdir}/bovine.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/bovine.texi calc : $(buildinfodir)/calc$(INFO_EXT) -$(buildinfodir)/calc$(INFO_EXT): ${srcdir}/calc.texi $(emacsdir)/emacsver.texi +$(buildinfodir)/calc$(INFO_EXT): ${srcdir}/calc.texi $(emacsdir)/emacsver.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/calc.texi -calc.dvi: ${srcdir}/calc.texi $(emacsdir)/emacsver.texi +calc.dvi: ${srcdir}/calc.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/calc.texi -calc.pdf: ${srcdir}/calc.texi $(emacsdir)/emacsver.texi +calc.pdf: ${srcdir}/calc.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/calc.texi ccmode : $(buildinfodir)/ccmode$(INFO_EXT) -$(buildinfodir)/ccmode$(INFO_EXT): ${srcdir}/cc-mode.texi +$(buildinfodir)/ccmode$(INFO_EXT): ${srcdir}/cc-mode.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/cc-mode.texi -cc-mode.dvi: ${srcdir}/cc-mode.texi +cc-mode.dvi: ${srcdir}/cc-mode.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/cc-mode.texi -cc-mode.pdf: ${srcdir}/cc-mode.texi +cc-mode.pdf: ${srcdir}/cc-mode.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/cc-mode.texi cl : $(buildinfodir)/cl$(INFO_EXT) -$(buildinfodir)/cl$(INFO_EXT): ${srcdir}/cl.texi $(emacsdir)/emacsver.texi +$(buildinfodir)/cl$(INFO_EXT): ${srcdir}/cl.texi $(emacsdir)/emacsver.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/cl.texi -cl.dvi: ${srcdir}/cl.texi $(emacsdir)/emacsver.texi +cl.dvi: ${srcdir}/cl.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/cl.texi -cl.pdf: ${srcdir}/cl.texi $(emacsdir)/emacsver.texi +cl.pdf: ${srcdir}/cl.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/cl.texi dbus : $(buildinfodir)/dbus$(INFO_EXT) -$(buildinfodir)/dbus$(INFO_EXT): ${srcdir}/dbus.texi +$(buildinfodir)/dbus$(INFO_EXT): ${srcdir}/dbus.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/dbus.texi -dbus.dvi: ${srcdir}/dbus.texi +dbus.dvi: ${srcdir}/dbus.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/dbus.texi -dbus.pdf: ${srcdir}/dbus.texi +dbus.pdf: ${srcdir}/dbus.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/dbus.texi dired-x : $(buildinfodir)/dired-x$(INFO_EXT) -$(buildinfodir)/dired-x$(INFO_EXT): ${srcdir}/dired-x.texi $(emacsdir)/emacsver.texi +$(buildinfodir)/dired-x$(INFO_EXT): ${srcdir}/dired-x.texi $(emacsdir)/emacsver.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/dired-x.texi -dired-x.dvi: ${srcdir}/dired-x.texi $(emacsdir)/emacsver.texi +dired-x.dvi: ${srcdir}/dired-x.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/dired-x.texi -dired-x.pdf: ${srcdir}/dired-x.texi $(emacsdir)/emacsver.texi +dired-x.pdf: ${srcdir}/dired-x.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/dired-x.texi ebrowse : $(buildinfodir)/ebrowse$(INFO_EXT) -$(buildinfodir)/ebrowse$(INFO_EXT): ${srcdir}/ebrowse.texi +$(buildinfodir)/ebrowse$(INFO_EXT): ${srcdir}/ebrowse.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/ebrowse.texi -ebrowse.dvi: ${srcdir}/ebrowse.texi +ebrowse.dvi: ${srcdir}/ebrowse.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/ebrowse.texi -ebrowse.pdf: ${srcdir}/ebrowse.texi +ebrowse.pdf: ${srcdir}/ebrowse.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/ebrowse.texi ede : $(buildinfodir)/ede$(INFO_EXT) -$(buildinfodir)/ede$(INFO_EXT): ${srcdir}/ede.texi +$(buildinfodir)/ede$(INFO_EXT): ${srcdir}/ede.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/ede.texi -ede.dvi: ${srcdir}/ede.texi +ede.dvi: ${srcdir}/ede.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/ede.texi -ede.pdf: ${srcdir}/ede.texi +ede.pdf: ${srcdir}/ede.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/ede.texi ediff : $(buildinfodir)/ediff$(INFO_EXT) -$(buildinfodir)/ediff$(INFO_EXT): ${srcdir}/ediff.texi +$(buildinfodir)/ediff$(INFO_EXT): ${srcdir}/ediff.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/ediff.texi -ediff.dvi: ${srcdir}/ediff.texi +ediff.dvi: ${srcdir}/ediff.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/ediff.texi -ediff.pdf: ${srcdir}/ediff.texi +ediff.pdf: ${srcdir}/ediff.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/ediff.texi edt : $(buildinfodir)/edt$(INFO_EXT) -$(buildinfodir)/edt$(INFO_EXT): ${srcdir}/edt.texi +$(buildinfodir)/edt$(INFO_EXT): ${srcdir}/edt.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/edt.texi -edt.dvi: ${srcdir}/edt.texi +edt.dvi: ${srcdir}/edt.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/edt.texi -edt.pdf: ${srcdir}/edt.texi +edt.pdf: ${srcdir}/edt.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/edt.texi eieio : $(buildinfodir)/eieio$(INFO_EXT) -$(buildinfodir)/eieio$(INFO_EXT): ${srcdir}/eieio.texi +$(buildinfodir)/eieio$(INFO_EXT): ${srcdir}/eieio.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/eieio.texi -eieio.dvi: ${srcdir}/eieio.texi +eieio.dvi: ${srcdir}/eieio.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/eieio.texi -eieio.pdf: ${srcdir}/eieio.texi +eieio.pdf: ${srcdir}/eieio.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/eieio.texi emacs-gnutls : $(buildinfodir)/emacs-gnutls$(INFO_EXT) -$(buildinfodir)/emacs-gnutls$(INFO_EXT): ${srcdir}/emacs-gnutls.texi +$(buildinfodir)/emacs-gnutls$(INFO_EXT): ${srcdir}/emacs-gnutls.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/emacs-gnutls.texi -emacs-gnutls.dvi: ${srcdir}/emacs-gnutls.texi +emacs-gnutls.dvi: ${srcdir}/emacs-gnutls.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/emacs-gnutls.texi -emacs-gnutls.pdf: ${srcdir}/emacs-gnutls.texi +emacs-gnutls.pdf: ${srcdir}/emacs-gnutls.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/emacs-gnutls.texi emacs-mime : $(buildinfodir)/emacs-mime$(INFO_EXT) -$(buildinfodir)/emacs-mime$(INFO_EXT): ${srcdir}/emacs-mime.texi +$(buildinfodir)/emacs-mime$(INFO_EXT): ${srcdir}/emacs-mime.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) --enable-encoding -o $@ ${srcdir}/emacs-mime.texi -emacs-mime.dvi: ${srcdir}/emacs-mime.texi +emacs-mime.dvi: ${srcdir}/emacs-mime.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/emacs-mime.texi -emacs-mime.pdf: ${srcdir}/emacs-mime.texi +emacs-mime.pdf: ${srcdir}/emacs-mime.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/emacs-mime.texi epa : $(buildinfodir)/epa$(INFO_EXT) -$(buildinfodir)/epa$(INFO_EXT): ${srcdir}/epa.texi +$(buildinfodir)/epa$(INFO_EXT): ${srcdir}/epa.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/epa.texi -epa.dvi: ${srcdir}/epa.texi +epa.dvi: ${srcdir}/epa.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/epa.texi -epa.pdf: ${srcdir}/epa.texi +epa.pdf: ${srcdir}/epa.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/epa.texi erc : $(buildinfodir)/erc$(INFO_EXT) -$(buildinfodir)/erc$(INFO_EXT): ${srcdir}/erc.texi $(emacsdir)/emacsver.texi +$(buildinfodir)/erc$(INFO_EXT): ${srcdir}/erc.texi $(emacsdir)/emacsver.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/erc.texi -erc.dvi: ${srcdir}/erc.texi $(emacsdir)/emacsver.texi +erc.dvi: ${srcdir}/erc.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/erc.texi -erc.pdf: ${srcdir}/erc.texi $(emacsdir)/emacsver.texi +erc.pdf: ${srcdir}/erc.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/erc.texi ert : $(buildinfodir)/ert$(INFO_EXT) -$(buildinfodir)/ert$(INFO_EXT): ${srcdir}/ert.texi +$(buildinfodir)/ert$(INFO_EXT): ${srcdir}/ert.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/ert.texi -ert.dvi: ${srcdir}/ert.texi +ert.dvi: ${srcdir}/ert.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/ert.texi -ert.pdf: ${srcdir}/ert.texi +ert.pdf: ${srcdir}/ert.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/ert.texi eshell : $(buildinfodir)/eshell$(INFO_EXT) -$(buildinfodir)/eshell$(INFO_EXT): ${srcdir}/eshell.texi +$(buildinfodir)/eshell$(INFO_EXT): ${srcdir}/eshell.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/eshell.texi -eshell.dvi: ${srcdir}/eshell.texi +eshell.dvi: ${srcdir}/eshell.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/eshell.texi -eshell.pdf: ${srcdir}/eshell.texi +eshell.pdf: ${srcdir}/eshell.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/eshell.texi eudc : $(buildinfodir)/eudc$(INFO_EXT) -$(buildinfodir)/eudc$(INFO_EXT): ${srcdir}/eudc.texi +$(buildinfodir)/eudc$(INFO_EXT): ${srcdir}/eudc.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/eudc.texi -eudc.dvi: ${srcdir}/eudc.texi +eudc.dvi: ${srcdir}/eudc.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/eudc.texi -eudc.pdf: ${srcdir}/eudc.texi +eudc.pdf: ${srcdir}/eudc.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/eudc.texi +## No gfdl dependency. efaq : $(buildinfodir)/efaq$(INFO_EXT) $(buildinfodir)/efaq$(INFO_EXT): ${srcdir}/faq.texi $(emacsdir)/emacsver.texi $(mkinfodir) @@ -405,292 +409,301 @@ emacs-faq.text: ${srcdir}/faq.texi $(emacsdir)/emacsver.texi $(MAKEINFO) $(MAKEINFO_OPTS) --plaintext -o $@ ${srcdir}/faq.texi flymake : $(buildinfodir)/flymake$(INFO_EXT) -$(buildinfodir)/flymake$(INFO_EXT): ${srcdir}/flymake.texi +$(buildinfodir)/flymake$(INFO_EXT): ${srcdir}/flymake.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/flymake.texi -flymake.dvi: ${srcdir}/flymake.texi +flymake.dvi: ${srcdir}/flymake.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/flymake.texi -flymake.pdf: ${srcdir}/flymake.texi +flymake.pdf: ${srcdir}/flymake.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/flymake.texi forms : $(buildinfodir)/forms$(INFO_EXT) -$(buildinfodir)/forms$(INFO_EXT): ${srcdir}/forms.texi +$(buildinfodir)/forms$(INFO_EXT): ${srcdir}/forms.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/forms.texi -forms.dvi: ${srcdir}/forms.texi +forms.dvi: ${srcdir}/forms.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/forms.texi -forms.pdf: ${srcdir}/forms.texi +forms.pdf: ${srcdir}/forms.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/forms.texi # gnus/message/emacs-mime/sieve/pgg are part of Gnus: gnus : $(buildinfodir)/gnus$(INFO_EXT) -$(buildinfodir)/gnus$(INFO_EXT): ${srcdir}/gnus.texi ${srcdir}/gnus-faq.texi +$(buildinfodir)/gnus$(INFO_EXT): ${srcdir}/gnus.texi ${srcdir}/gnus-faq.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/gnus.texi -gnus.dvi: ${srcdir}/gnus.texi ${srcdir}/gnus-faq.texi +gnus.dvi: ${srcdir}/gnus.texi ${srcdir}/gnus-faq.texi ${gfdl} sed -e '/@iflatex/,/@end iflatex/d' ${srcdir}/gnus.texi > gnustmp.texi $(ENVADD) $(TEXI2DVI) gnustmp.texi cp gnustmp.dvi $@ rm gnustmp.* -gnus.pdf: ${srcdir}/gnus.texi ${srcdir}/gnus-faq.texi +gnus.pdf: ${srcdir}/gnus.texi ${srcdir}/gnus-faq.texi ${gfdl} sed -e '/@iflatex/,/@end iflatex/d' ${srcdir}/gnus.texi > gnustmp.texi $(ENVADD) $(TEXI2PDF) gnustmp.texi cp gnustmp.pdf $@ rm gnustmp.* +htmlfontify : $(buildinfodir)/htmlfontify$(INFO_EXT) +$(buildinfodir)/htmlfontify$(INFO_EXT): ${srcdir}/htmlfontify.texi ${gfdl} + $(mkinfodir) + $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/htmlfontify.texi +htmlfontify.dvi: ${srcdir}/htmlfontify.texi ${gfdl} + $(ENVADD) $(TEXI2DVI) ${srcdir}/htmlfontify.texi +htmlfontify.pdf: ${srcdir}/htmlfontify.texi ${gfdl} + $(ENVADD) $(TEXI2PDF) ${srcdir}/htmlfontify.texi + # NB this one needs --no-split even without a .info extension. idlwave : $(buildinfodir)/idlwave$(INFO_EXT) -$(buildinfodir)/idlwave$(INFO_EXT): ${srcdir}/idlwave.texi +$(buildinfodir)/idlwave$(INFO_EXT): ${srcdir}/idlwave.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/idlwave.texi -idlwave.dvi: ${srcdir}/idlwave.texi +idlwave.dvi: ${srcdir}/idlwave.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/idlwave.texi -idlwave.pdf: ${srcdir}/idlwave.texi +idlwave.pdf: ${srcdir}/idlwave.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/idlwave.texi # NB this one needs --no-split even without a .info extension. # Avoid name clash with overall "info" target. info.info : $(buildinfodir)/info$(INFO_EXT) -$(buildinfodir)/info$(INFO_EXT): ${srcdir}/info.texi +$(buildinfodir)/info$(INFO_EXT): ${srcdir}/info.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/info.texi -info.dvi: ${srcdir}/info.texi +info.dvi: ${srcdir}/info.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/info.texi -info.pdf: ${srcdir}/info.texi +info.pdf: ${srcdir}/info.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/info.texi mairix-el : $(buildinfodir)/mairix-el$(INFO_EXT) -$(buildinfodir)/mairix-el$(INFO_EXT): ${srcdir}/mairix-el.texi +$(buildinfodir)/mairix-el$(INFO_EXT): ${srcdir}/mairix-el.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/mairix-el.texi -mairix-el.dvi: ${srcdir}/mairix-el.texi +mairix-el.dvi: ${srcdir}/mairix-el.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/mairix-el.texi -mairix-el.pdf: ${srcdir}/mairix-el.texi +mairix-el.pdf: ${srcdir}/mairix-el.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/mairix-el.texi message : $(buildinfodir)/message$(INFO_EXT) -$(buildinfodir)/message$(INFO_EXT): ${srcdir}/message.texi +$(buildinfodir)/message$(INFO_EXT): ${srcdir}/message.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/message.texi -message.dvi: ${srcdir}/message.texi +message.dvi: ${srcdir}/message.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/message.texi -message.pdf: ${srcdir}/message.texi +message.pdf: ${srcdir}/message.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/message.texi mh-e : $(buildinfodir)/mh-e$(INFO_EXT) -$(buildinfodir)/mh-e$(INFO_EXT): ${srcdir}/mh-e.texi +$(buildinfodir)/mh-e$(INFO_EXT): ${srcdir}/mh-e.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/mh-e.texi -mh-e.dvi: ${srcdir}/mh-e.texi +mh-e.dvi: ${srcdir}/mh-e.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/mh-e.texi -mh-e.pdf: ${srcdir}/mh-e.texi +mh-e.pdf: ${srcdir}/mh-e.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/mh-e.texi newsticker : $(buildinfodir)/newsticker$(INFO_EXT) -$(buildinfodir)/newsticker$(INFO_EXT): ${srcdir}/newsticker.texi +$(buildinfodir)/newsticker$(INFO_EXT): ${srcdir}/newsticker.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/newsticker.texi -newsticker.dvi: ${srcdir}/newsticker.texi +newsticker.dvi: ${srcdir}/newsticker.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/newsticker.texi -newsticker.pdf: ${srcdir}/newsticker.texi +newsticker.pdf: ${srcdir}/newsticker.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/newsticker.texi nxml-mode : $(buildinfodir)/nxml-mode$(INFO_EXT) -$(buildinfodir)/nxml-mode$(INFO_EXT): ${srcdir}/nxml-mode.texi +$(buildinfodir)/nxml-mode$(INFO_EXT): ${srcdir}/nxml-mode.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/nxml-mode.texi -nxml-mode.dvi: ${srcdir}/nxml-mode.texi +nxml-mode.dvi: ${srcdir}/nxml-mode.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/nxml-mode.texi -nxml-mode.pdf: ${srcdir}/nxml-mode.texi +nxml-mode.pdf: ${srcdir}/nxml-mode.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/nxml-mode.texi org : $(buildinfodir)/org$(INFO_EXT) -$(buildinfodir)/org$(INFO_EXT): ${srcdir}/org.texi +$(buildinfodir)/org$(INFO_EXT): ${srcdir}/org.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/org.texi -org.dvi: ${srcdir}/org.texi +org.dvi: ${srcdir}/org.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/org.texi -org.pdf: ${srcdir}/org.texi +org.pdf: ${srcdir}/org.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/org.texi pcl-cvs : $(buildinfodir)/pcl-cvs$(INFO_EXT) -$(buildinfodir)/pcl-cvs$(INFO_EXT): ${srcdir}/pcl-cvs.texi +$(buildinfodir)/pcl-cvs$(INFO_EXT): ${srcdir}/pcl-cvs.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/pcl-cvs.texi -pcl-cvs.dvi: ${srcdir}/pcl-cvs.texi +pcl-cvs.dvi: ${srcdir}/pcl-cvs.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/pcl-cvs.texi -pcl-cvs.pdf: ${srcdir}/pcl-cvs.texi +pcl-cvs.pdf: ${srcdir}/pcl-cvs.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/pcl-cvs.texi pgg : $(buildinfodir)/pgg$(INFO_EXT) -$(buildinfodir)/pgg$(INFO_EXT): ${srcdir}/pgg.texi +$(buildinfodir)/pgg$(INFO_EXT): ${srcdir}/pgg.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/pgg.texi -pgg.dvi: ${srcdir}/pgg.texi +pgg.dvi: ${srcdir}/pgg.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/pgg.texi -pgg.pdf: ${srcdir}/pgg.texi +pgg.pdf: ${srcdir}/pgg.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/pgg.texi rcirc : $(buildinfodir)/rcirc$(INFO_EXT) -$(buildinfodir)/rcirc$(INFO_EXT): ${srcdir}/rcirc.texi +$(buildinfodir)/rcirc$(INFO_EXT): ${srcdir}/rcirc.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/rcirc.texi -rcirc.dvi: ${srcdir}/rcirc.texi +rcirc.dvi: ${srcdir}/rcirc.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/rcirc.texi -rcirc.pdf: ${srcdir}/rcirc.texi +rcirc.pdf: ${srcdir}/rcirc.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/rcirc.texi reftex : $(buildinfodir)/reftex$(INFO_EXT) -$(buildinfodir)/reftex$(INFO_EXT): ${srcdir}/reftex.texi $(emacsdir)/emacsver.texi +$(buildinfodir)/reftex$(INFO_EXT): ${srcdir}/reftex.texi $(emacsdir)/emacsver.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/reftex.texi -reftex.dvi: ${srcdir}/reftex.texi $(emacsdir)/emacsver.texi +reftex.dvi: ${srcdir}/reftex.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/reftex.texi -reftex.pdf: ${srcdir}/reftex.texi $(emacsdir)/emacsver.texi +reftex.pdf: ${srcdir}/reftex.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/reftex.texi remember : $(buildinfodir)/remember$(INFO_EXT) -$(buildinfodir)/remember$(INFO_EXT): ${srcdir}/remember.texi +$(buildinfodir)/remember$(INFO_EXT): ${srcdir}/remember.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/remember.texi -remember.dvi: ${srcdir}/remember.texi +remember.dvi: ${srcdir}/remember.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/remember.texi -remember.pdf: ${srcdir}/remember.texi +remember.pdf: ${srcdir}/remember.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/remember.texi sasl : $(buildinfodir)/sasl$(INFO_EXT) -$(buildinfodir)/sasl$(INFO_EXT): ${srcdir}/sasl.texi +$(buildinfodir)/sasl$(INFO_EXT): ${srcdir}/sasl.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/sasl.texi -sasl.dvi: ${srcdir}/sasl.texi +sasl.dvi: ${srcdir}/sasl.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/sasl.texi -sasl.pdf: ${srcdir}/sasl.texi +sasl.pdf: ${srcdir}/sasl.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/sasl.texi sc : $(buildinfodir)/sc$(INFO_EXT) -$(buildinfodir)/sc$(INFO_EXT): ${srcdir}/sc.texi +$(buildinfodir)/sc$(INFO_EXT): ${srcdir}/sc.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/sc.texi -sc.dvi: ${srcdir}/sc.texi +sc.dvi: ${srcdir}/sc.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/sc.texi -sc.pdf: ${srcdir}/sc.texi +sc.pdf: ${srcdir}/sc.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/sc.texi semantic : $(buildinfodir)/semantic$(INFO_EXT) -$(buildinfodir)/semantic$(INFO_EXT): ${srcdir}/semantic.texi ${srcdir}/sem-user.texi +$(buildinfodir)/semantic$(INFO_EXT): ${srcdir}/semantic.texi ${srcdir}/sem-user.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/semantic.texi -semantic.dvi: ${srcdir}/semantic.texi ${srcdir}/sem-user.texi +semantic.dvi: ${srcdir}/semantic.texi ${srcdir}/sem-user.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/semantic.texi -semantic.pdf: ${srcdir}/semantic.texi ${srcdir}/sem-user.texi +semantic.pdf: ${srcdir}/semantic.texi ${srcdir}/sem-user.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/semantic.texi ses : $(buildinfodir)/ses$(INFO_EXT) -$(buildinfodir)/ses$(INFO_EXT): ${srcdir}/ses.texi +$(buildinfodir)/ses$(INFO_EXT): ${srcdir}/ses.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/ses.texi -ses.dvi: ${srcdir}/ses.texi +ses.dvi: ${srcdir}/ses.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/ses.texi -ses.pdf: ${srcdir}/ses.texi +ses.pdf: ${srcdir}/ses.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/ses.texi sieve : $(buildinfodir)/sieve$(INFO_EXT) -$(buildinfodir)/sieve$(INFO_EXT): ${srcdir}/sieve.texi +$(buildinfodir)/sieve$(INFO_EXT): ${srcdir}/sieve.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/sieve.texi -sieve.dvi: ${srcdir}/sieve.texi +sieve.dvi: ${srcdir}/sieve.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/sieve.texi -sieve.pdf: ${srcdir}/sieve.texi +sieve.pdf: ${srcdir}/sieve.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/sieve.texi smtpmail : $(buildinfodir)/smtpmail$(INFO_EXT) -$(buildinfodir)/smtpmail$(INFO_EXT): ${srcdir}/smtpmail.texi +$(buildinfodir)/smtpmail$(INFO_EXT): ${srcdir}/smtpmail.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/smtpmail.texi -smtpmail.dvi: ${srcdir}/smtpmail.texi +smtpmail.dvi: ${srcdir}/smtpmail.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/smtpmail.texi -smtpmail.pdf: ${srcdir}/smtpmail.texi +smtpmail.pdf: ${srcdir}/smtpmail.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/smtpmail.texi speedbar : $(buildinfodir)/speedbar$(INFO_EXT) -$(buildinfodir)/speedbar$(INFO_EXT): ${srcdir}/speedbar.texi +$(buildinfodir)/speedbar$(INFO_EXT): ${srcdir}/speedbar.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/speedbar.texi -speedbar.dvi: ${srcdir}/speedbar.texi +speedbar.dvi: ${srcdir}/speedbar.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/speedbar.texi -speedbar.pdf: ${srcdir}/speedbar.texi +speedbar.pdf: ${srcdir}/speedbar.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/speedbar.texi srecode : $(buildinfodir)/srecode$(INFO_EXT) -$(buildinfodir)/srecode$(INFO_EXT): ${srcdir}/srecode.texi +$(buildinfodir)/srecode$(INFO_EXT): ${srcdir}/srecode.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/srecode.texi -srecode.dvi: ${srcdir}/srecode.texi +srecode.dvi: ${srcdir}/srecode.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/srecode.texi -srecode.pdf: ${srcdir}/srecode.texi +srecode.pdf: ${srcdir}/srecode.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/srecode.texi tramp : $(buildinfodir)/tramp$(INFO_EXT) -$(buildinfodir)/tramp$(INFO_EXT): ${srcdir}/tramp.texi ${srcdir}/trampver.texi +$(buildinfodir)/tramp$(INFO_EXT): ${srcdir}/tramp.texi ${srcdir}/trampver.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ -D emacs ${srcdir}/tramp.texi -tramp.dvi: ${srcdir}/tramp.texi ${srcdir}/trampver.texi +tramp.dvi: ${srcdir}/tramp.texi ${srcdir}/trampver.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/tramp.texi -tramp.pdf: ${srcdir}/tramp.texi ${srcdir}/trampver.texi +tramp.pdf: ${srcdir}/tramp.texi ${srcdir}/trampver.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/tramp.texi url : $(buildinfodir)/url$(INFO_EXT) -$(buildinfodir)/url$(INFO_EXT): ${srcdir}/url.texi +$(buildinfodir)/url$(INFO_EXT): ${srcdir}/url.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/url.texi -url.dvi: ${srcdir}/url.texi +url.dvi: ${srcdir}/url.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/url.texi -url.pdf: ${srcdir}/url.texi +url.pdf: ${srcdir}/url.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/url.texi vip : $(buildinfodir)/vip$(INFO_EXT) -$(buildinfodir)/vip$(INFO_EXT): ${srcdir}/vip.texi +$(buildinfodir)/vip$(INFO_EXT): ${srcdir}/vip.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/vip.texi -vip.dvi: ${srcdir}/vip.texi +vip.dvi: ${srcdir}/vip.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/vip.texi -vip.pdf: ${srcdir}/vip.texi +vip.pdf: ${srcdir}/vip.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/vip.texi viper : $(buildinfodir)/viper$(INFO_EXT) -$(buildinfodir)/viper$(INFO_EXT): ${srcdir}/viper.texi +$(buildinfodir)/viper$(INFO_EXT): ${srcdir}/viper.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/viper.texi -viper.dvi: ${srcdir}/viper.texi +viper.dvi: ${srcdir}/viper.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/viper.texi -viper.pdf: ${srcdir}/viper.texi +viper.pdf: ${srcdir}/viper.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/viper.texi widget : $(buildinfodir)/widget$(INFO_EXT) -$(buildinfodir)/widget$(INFO_EXT): ${srcdir}/widget.texi +$(buildinfodir)/widget$(INFO_EXT): ${srcdir}/widget.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/widget.texi -widget.dvi: ${srcdir}/widget.texi +widget.dvi: ${srcdir}/widget.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/widget.texi -widget.pdf: ${srcdir}/widget.texi +widget.pdf: ${srcdir}/widget.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/widget.texi wisent : $(buildinfodir)/wisent$(INFO_EXT) -$(buildinfodir)/wisent$(INFO_EXT): ${srcdir}/wisent.texi +$(buildinfodir)/wisent$(INFO_EXT): ${srcdir}/wisent.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/wisent.texi -wisent.dvi: ${srcdir}/wisent.texi +wisent.dvi: ${srcdir}/wisent.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/wisent.texi -wisent.pdf: ${srcdir}/wisent.texi +wisent.pdf: ${srcdir}/wisent.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/wisent.texi woman : $(buildinfodir)/woman$(INFO_EXT) -$(buildinfodir)/woman$(INFO_EXT): ${srcdir}/woman.texi +$(buildinfodir)/woman$(INFO_EXT): ${srcdir}/woman.texi $(emacsdir)/emacsver.texi ${gfdl} $(mkinfodir) $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/woman.texi -woman.dvi: ${srcdir}/woman.texi +woman.dvi: ${srcdir}/woman.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/woman.texi -woman.pdf: ${srcdir}/woman.texi +woman.pdf: ${srcdir}/woman.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/woman.texi diff --git a/doc/misc/ada-mode.texi b/doc/misc/ada-mode.texi index 8d06ae0de22..926d6a5749c 100644 --- a/doc/misc/ada-mode.texi +++ b/doc/misc/ada-mode.texi @@ -3,7 +3,7 @@ @settitle Ada Mode @copying -Copyright @copyright{} 1999-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1999--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -14,8 +14,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -26,7 +25,7 @@ developing GNU and promoting software freedom.'' @titlepage @sp 10 -@title{Ada Mode} +@title Ada Mode @sp 2 @subtitle An Emacs major mode for programming in Ada @subtitle Ada Mode Version 4.00 @@ -38,7 +37,7 @@ developing GNU and promoting software freedom.'' @contents -@node Top, Overview, (dir), (dir) +@node Top @top Ada Mode @ifnottex @@ -65,7 +64,7 @@ developing GNU and promoting software freedom.'' @end menu -@node Overview, Installation, Top, Top +@node Overview @chapter Overview The Emacs mode for programming in Ada helps the user in understanding @@ -97,7 +96,7 @@ and other GNAT commands. See the Emacs info manual, section 'Running Debuggers Under Emacs', for general information on debugging. -@node Installation, Customization, Overview, Top +@node Installation @chapter Installation Ada mode is part of the standard Emacs distribution; if you use that, @@ -137,7 +136,7 @@ GNAT-specific). @end itemize -@node Customization, Compiling Executing, Installation, Top +@node Customization @chapter Customizing Ada mode Here we assume you are familiar with setting variables in Emacs, @@ -176,7 +175,7 @@ See the Emacs help for each of these variables for more information. * Other customization:: @end menu -@node Non-standard file names, Other compiler, Customization, Customization +@node Non-standard file names @section Non-standard file names By default, Ada mode is configured to use the GNAT file naming @@ -218,7 +217,7 @@ rewrite the function @code{ada-make-filename-from-adaname}. Doing that is beyond the scope of this manual; see the current definitions in @file{ada-mode.el} and @file{ada-xref.el} for examples. -@node Other compiler, Other customization, Non-standard file names, Customization +@node Other compiler @section Other compiler By default, Ada mode is configured to use the Gnu Ada compiler GNAT. @@ -228,7 +227,7 @@ used to run that compiler, either in lisp variables or in Emacs Ada mode project files. See @ref{Project file variables} for the list of project variables, and the corresponding lisp variables. -@node Other customization, , Other compiler, Customization +@node Other customization @section Other customization All user-settable Ada mode variables can be set via the menu @@ -246,7 +245,7 @@ and the syntax to set a variable is the following: (setq variable-name value) @end example -@node Compiling Executing, Project files, Customization, Top +@node Compiling Executing @chapter Compiling Executing Ada projects can be compiled, linked, and executed using commands on @@ -264,7 +263,7 @@ file variables referenced here. * Compiler errors:: @end menu -@node Compile commands, Compiler errors, Compiling Executing, Compiling Executing +@node Compile commands @section Compile commands Here are the commands for building and using an Ada project, as @@ -347,7 +346,7 @@ Invoke @samp{Ada | Project | Load}, and load a project file that specifies @code @end enumerate -@node Compiler errors, , Compile commands, Compiling Executing +@node Compiler errors @section Compiler errors The @code{Check file}, @code{Compile file}, and @code{Build} commands @@ -367,7 +366,7 @@ Some error messages might also include references to other files. These references are also clickable in the same way, or put point after the line number and press @key{RET}. -@node Project files, Compiling Examples, Compiling Executing, Top +@node Project files @chapter Project files An Emacs Ada mode project file specifies what directories hold sources @@ -386,7 +385,7 @@ an Emacs Ada mode project file. * Project file variables:: @end menu -@node Project File Overview, GUI Editor, Project files, Project files +@node Project File Overview @section Project File Overview Project files have a simple syntax; they may be edited directly. Each @@ -451,7 +450,7 @@ file extension; if it is @code{.gpr}, the file is treated as a GNAT project file. Any other extension is treated as an Emacs Ada mode project file. -@node GUI Editor, Project file variables, Project File Overview, Project files +@node GUI Editor @section GUI Editor The project file editor is invoked with the menu @samp{Ada | Projects @@ -462,7 +461,7 @@ modification using the @samp{[save]} button at the bottom of the buffer, or the @kbd{C-x C-s} binding. To cancel your modifications, kill the buffer or click on the @samp{[cancel]} button. -@node Project file variables, , GUI Editor, Project files +@node Project file variables @section Project file variables The following variables can be defined in a project file; some can @@ -522,8 +521,8 @@ ada_project_path_sep=: ada_project_path=$GDS_ROOT/makerules ada_project_path=../opentoken @end example -the environment variable @code{ADA_PROJECT_PATH} will be set to -@code{"/home/shared/makerules:/home/opentoken/"}. +then as a result the environment variable @code{ADA_PROJECT_PATH} will +be set to @code{"/home/shared/makerules:/home/opentoken/"}. The default value is not the current value of this environment variable, because that will typically have been set by another @@ -649,7 +648,7 @@ commands and source navigation. @end table -@node Compiling Examples, Moving Through Ada Code, Project files, Top +@node Compiling Examples @chapter Compiling Examples We present several small projects, and walk thru the process of @@ -671,7 +670,7 @@ website mentioned in @xref{Installation}. * Use multiple GNAT project files:: @end menu -@node No project files, Set compiler options, Compiling Examples, Compiling Examples +@node No project files @section No project files This example uses no project files. @@ -731,7 +730,7 @@ In buffer @file{hello.adb}, invoke @samp{Ada | Check file}. You should get a @code{*compilation*} buffer containing something like (the directory paths will be different): -@example +@smallexample cd c:/Examples/Example_1/ gnatmake -u -c -gnatc -g c:/Examples/Example_1/hello.adb -cargs -gnatq -gnatQ gcc -c -Ic:/Examples/Example_1/ -gnatc -g -gnatq -gnatQ -I- c:/Examples/Example_1/hello.adb @@ -739,7 +738,7 @@ hello.adb:4:04: "Put_Line" is not visible hello.adb:4:04: non-visible declaration at a-textio.ads:264 hello.adb:4:04: non-visible declaration at a-textio.ads:260 gnatmake: "c:/Examples/Example_1/hello.adb" compilation error -@end example +@end smallexample If you have enabled font-lock, the lines with actual errors (starting with @file{hello.adb}) are highlighted, with the file name in red. @@ -837,7 +836,7 @@ Invoke @samp{Ada | Project | Load}, and load a project file that specifies @code @end enumerate -@node Set compiler options, Set source search path, No project files, Compiling Examples +@node Set compiler options @section Set compiler options This example illustrates using an Emacs Ada mode project file to set a @@ -899,7 +898,7 @@ used to set the compiler options. Fixing the error, linking and running the code proceed as in @ref{No project files}. -@node Set source search path, Use GNAT project file, Set compiler options, Compiling Examples +@node Set source search path @section Set source search path In this example, we show how to deal with files in more than one @@ -983,7 +982,7 @@ compiler error message. Fixing the error, linking and running the code proceed as in @ref{No project files}. -@node Use GNAT project file, Use multiple GNAT project files, Set source search path, Compiling Examples +@node Use GNAT project file @section Use GNAT project file In this example, we show how to use a GNAT project file, with no Ada @@ -1046,14 +1045,14 @@ Then, again in @file{hello_4.adb}, invoke @samp{Ada | Set main and Build}. You should get a @code{*compilation*} buffer containing something like (the directory paths will be different): -@example +@smallexample cd c:/Examples/Example_4/Gnat_Project/ gnatmake -o hello_4 hello_4 -Phello_4.gpr -cargs -gnatq -gnatQ -bargs -largs gcc -c -g -gnatyt -gnatq -gnatQ -I- -gnatA c:\Examples\Example_4\Gnat_Project\hello_4.adb gcc -c -g -gnatyt -gnatq -gnatQ -I- -gnatA c:\Examples\Example_4\hello_pkg.adb hello_pkg.adb:2:08: keyword "body" expected here [see file name] gnatmake: "c:\examples\example_4\hello_pkg.adb" compilation error -@end example +@end smallexample Compare the @code{gcc} options to the compiler output in @ref{Set compiler options}; this shows that @file{hello_4.gpr} is being used to @@ -1062,7 +1061,7 @@ set the compiler options. Fixing the error, linking and running the code proceed as in @ref{No project files}. -@node Use multiple GNAT project files, , Use GNAT project file, Compiling Examples +@node Use multiple GNAT project files @section Use multiple GNAT project files In this example, we show how to use multiple GNAT project files, @@ -1113,20 +1112,20 @@ Then, again in @file{hello_5.adb}, invoke @samp{Ada | Set main and Build}. You should get a @code{*compilation*} buffer containing something like (the directory paths will be different): -@example +@smallexample cd c:/Examples/Example_5/ gnatmake -o hello_5 hello_5 -Phello_5.gpr -g -cargs -gnatq -gnatQ -bargs -largs gcc -c -g -gnatyt -g -gnatq -gnatQ -I- -gnatA c:\Examples\Example_5\hello_5.adb gcc -c -g -gnatyt -g -gnatq -gnatQ -I- -gnatA c:\Examples\Example_4\hello_pkg.adb hello_pkg.adb:2:08: keyword "body" expected here [see file name] gnatmake: "c:\examples\example_4\hello_pkg.adb" compilation error -@end example +@end smallexample Now type @kbd{C-x `}. @file{Example_4/hello_pkg.adb} is shown, demonstrating that @file{hello_5.gpr} and @file{hello_4.gpr} are being used to set the compilation search path. -@node Moving Through Ada Code, Identifier completion, Compiling Examples, Top +@node Moving Through Ada Code @chapter Moving Through Ada Code There are several easy to use commands to navigate through Ada code. All @@ -1180,7 +1179,7 @@ If the @code{ada-xref-create-ali} variable is non-@code{nil}, Emacs will try to run GNAT for you whenever cross-reference information is needed, and is older than the current source file. -@node Identifier completion, Automatic Smart Indentation, Moving Through Ada Code, Top +@node Identifier completion @chapter Identifier completion Emacs and Ada mode provide two general ways for the completion of @@ -1225,7 +1224,7 @@ Complete current identifier using cross-reference information. Complete identifier using buffer information (not Ada-specific). @end table -@node Automatic Smart Indentation, Formatting Parameter Lists, Identifier completion, Top +@node Automatic Smart Indentation @chapter Automatic Smart Indentation Ada mode comes with a full set of rules for automatic indentation. You @@ -1302,7 +1301,7 @@ Indent the current line and display the name of the variable used for indentation. @end table -@node Formatting Parameter Lists, Automatic Casing, Automatic Smart Indentation, Top +@node Formatting Parameter Lists @chapter Formatting Parameter Lists @table @kbd @@ -1315,7 +1314,7 @@ This aligns the declarations on the colon (@samp{:}) separating argument names and argument types, and aligns the @code{in}, @code{out} and @code{in out} keywords. -@node Automatic Casing, Statement Templates, Formatting Parameter Lists, Top +@node Automatic Casing @chapter Automatic Casing Casing of identifiers, attributes and keywords is automatically @@ -1404,7 +1403,7 @@ Rereads the exception dictionary from the file @code{ada-case-exception-file} (@code{ada-case-read-exceptions}). @end table -@node Statement Templates, Comment Handling, Automatic Casing, Top +@node Statement Templates @chapter Statement Templates Templates are defined for most Ada statements, using the Emacs @@ -1495,7 +1494,7 @@ exception (@code{ada-exception}). type (@code{ada-type}). @end table -@node Comment Handling, GNU Free Documentation License, Statement Templates, Top +@node Comment Handling @chapter Comment Handling By default, comment lines get indented like Ada code. There are a few @@ -1507,18 +1506,18 @@ Start a comment in default column. @item M-j Continue comment on next line. @item C-c ; -Comment the selected region (add -- at the beginning of lines). +Comment the selected region (add @samp{--} at the beginning of lines). @item C-c : Uncomment the selected region @item M-q autofill the current comment. @end table -@node GNU Free Documentation License, Index, Comment Handling, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Index, , GNU Free Documentation License, Top +@node Index @unnumbered Index @printindex fn diff --git a/doc/misc/auth.texi b/doc/misc/auth.texi index d18a802d600..36ee400acca 100644 --- a/doc/misc/auth.texi +++ b/doc/misc/auth.texi @@ -2,15 +2,15 @@ @include gnus-overrides.texi +@set VERSION 0.3 + @setfilename ../../info/auth @settitle Emacs auth-source Library @value{VERSION} -@set VERSION 0.3 - @copying This file describes the Emacs auth-source library. -Copyright @copyright{} 2008-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2008--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -18,17 +18,10 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the license -is included in the section entitled ``GNU Free Documentation License'' -in the Emacs manual. +is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' - -This document is part of a collection distributed under the GNU Free -Documentation License. If you want to distribute this document -separately from the collection, you can do so by adding a copy of the -license to the document, as described in section 6 of the license. +modify this GNU manual.'' @end quotation @end copying @@ -68,6 +61,7 @@ It is a way for multiple applications to share a single configuration * Secret Service API:: * Help for developers:: * GnuPG and EasyPG Assistant Configuration:: +* GNU Free Documentation License:: The license for this documentation. * Index:: * Function Index:: * Variable Index:: @@ -160,7 +154,8 @@ and simplest configuration is: (setq auth-sources '((:source "~/.authinfo.gpg"))) ;;; even shorter and the @emph{default}: (setq auth-sources '("~/.authinfo.gpg" "~/.authinfo" "~/.netrc")) -;;; use the Secrets API @var{Login} collection (@pxref{Secret Service API}) +;;; use the Secrets API @var{Login} collection +;;; (@pxref{Secret Service API}) (setq auth-sources '("secrets:Login")) @end lisp @@ -173,7 +168,8 @@ have unusual setups and the remaining 10% are @emph{really} unusual). Here's a mixed example using two sources: @lisp -(setq auth-sources '((:source (:secrets default) :host "myserver" :user "joe") +(setq auth-sources '((:source (:secrets default) + :host "myserver" :user "joe") "~/.authinfo.gpg")) @end lisp @@ -522,16 +518,20 @@ To set up gpg-agent, follow the instruction in GnuPG manual To set up elisp passphrase cache, set @code{epa-file-cache-passphrase-for-symmetric-encryption}. +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + @node Index -@chapter Index +@unnumbered Index @printindex cp @node Function Index -@chapter Function Index +@unnumbered Function Index @printindex fn @node Variable Index -@chapter Variable Index +@unnumbered Variable Index @printindex vr @bye diff --git a/doc/misc/autotype.texi b/doc/misc/autotype.texi index aa99b41f204..ad6a2902b1e 100644 --- a/doc/misc/autotype.texi +++ b/doc/misc/autotype.texi @@ -10,7 +10,8 @@ @c @cindex autotypist @copying -Copyright @copyright{} 1994-1995, 1999, 2001-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1994--1995, 1999, 2001--2013 +Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -21,8 +22,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -58,7 +58,7 @@ over and over again. This is especially true of form letters and programming language constructs. Project-specific header comments, flow-control constructs or magic numbers are essentially the same every time. Emacs has various features for doing tedious and repetitive typing chores for you -in addition to the Abbrev features (@pxref{(emacs)Abbrevs}). +in addition to the Abbrev features (@pxref{Abbrevs,,, emacs, The GNU Emacs Manual}). One solution is using skeletons, flexible rules that say what to insert, and how to do it. Various programming language modes offer some @@ -113,7 +113,7 @@ completions and expansions of text at point. programming language you are using, skeletons are a means of accomplishing this. Normally skeletons each have a command of their own, that, when called, will insert the skeleton. These commands can be issued in the usual ways -(@pxref{(emacs)Commands}). Modes that offer various skeletons will often +(@pxref{Commands,,, emacs, The GNU Emacs Manual}). Modes that offer various skeletons will often bind these to key-sequences on the @kbd{C-c} prefix, as well as having an @cite{Insert} menu and maybe even predefined abbrevs for them (@pxref{Skeletons as Abbrevs}). @@ -146,18 +146,18 @@ accomplishing this, and can even, in the case of programming languages, reindent the wrapped code for you. Skeleton commands take an optional numeric prefix argument -(@pxref{(emacs)Arguments}). This is interpreted in two different ways depending +(@pxref{Arguments,,, emacs, The GNU Emacs Manual}). This is interpreted in two different ways depending on whether the prefix is positive, i.e., forwards oriented, or negative, i.e., backwards oriented. A positive prefix means to wrap the skeleton around that many following words. This is accomplished by putting the words there where the point is normally left after that skeleton is inserted (@pxref{Using -Skeletons}). The point (@pxref{(emacs)Point}) is left at the next +Skeletons}). The point (@pxref{Point,,, emacs, The GNU Emacs Manual}) is left at the next interesting spot in the skeleton instead. A negative prefix means to do something similar with that many previously -marked interregions (@pxref{(emacs)Mark}). In the simplest case, if you type +marked interregions (@pxref{Mark,,, emacs, The GNU Emacs Manual}). In the simplest case, if you type @kbd{M--} just before issuing the skeleton command, that will wrap the skeleton around the current region, just like a positive argument would have wrapped it around a number of words. @@ -189,8 +189,8 @@ tried to follow the order in which you marked these points. @cindex skeletons as abbrevs Rather than use a key binding for every skeleton command, you can also -define an abbreviation (@pxref{(emacs)Defining Abbrevs}) that will expand -(@pxref{(emacs)Expanding Abbrevs}) into the skeleton. +define an abbreviation (@pxref{Defining Abbrevs,,, emacs, The GNU Emacs Manual}) that will expand +(@pxref{Expanding Abbrevs,,, emacs, The GNU Emacs Manual}) into the skeleton. Say you want @samp{ifst} to be an abbreviation for the C language if statement. You will tell Emacs that @samp{ifst} expands to the empty string @@ -290,7 +290,7 @@ skeleton. The first argument is the command name, the second is a documentation string, and the rest is an interactor and any number of skeleton elements together forming a skeleton. This skeleton is assigned to a variable of the same name as the command and can thus be overridden from your -@file{~/.emacs} file (@pxref{(emacs)Init File}). +@file{~/.emacs} file (@pxref{Init File,,, emacs, The GNU Emacs Manual}). @@ -309,14 +309,14 @@ fingers backwards, this can be quite relieving too. @findex skeleton-pair-insert-maybe @vindex skeleton-pair - This is done by binding the first key (@pxref{(emacs)Rebinding}) of + This is done by binding the first key (@pxref{Rebinding,,, emacs, The GNU Emacs Manual}) of the pair to @code{skeleton-pair-insert-maybe} instead of @code{self-insert-command}. The ``maybe'' comes from the fact that this at-first surprising behavior is initially turned off. To enable it, you must set @code{skeleton-pair} to some non-@code{nil} value. -And even then, a positive argument (@pxref{(emacs)Arguments}) will +And even then, a positive argument (@pxref{Arguments,,, emacs, The GNU Emacs Manual}) will make this key behave like a self-inserting key -(@pxref{(emacs)Inserting Text}). +(@pxref{Inserting Text,,, emacs, The GNU Emacs Manual}). @vindex skeleton-pair-on-word While this breaks with the stated intention of always balancing pairs, it @@ -354,7 +354,7 @@ the buffer. The main application for this function, as its name suggests, is to have it be called automatically every time an empty, and only an empty file is visited. This is accomplished by putting @code{(add-hook 'find-file-hook 'auto-insert)} into your @file{~/.emacs} file -(@pxref{(emacs)Init File}). +(@pxref{Init File,,, emacs, The GNU Emacs Manual}). @vindex auto-insert-alist What gets inserted, if anything, is determined by the variable @@ -392,10 +392,10 @@ source files insert the usual header, with a copyright of your environment variable @env{$ORGANIZATION} or else the FSF, and prompt for valid keywords describing the contents. Files in a @file{bin} directory for which Emacs could determine no specialized mode -(@pxref{(emacs)Choosing Modes}) are set to Shell script mode. +(@pxref{Choosing Modes,,, emacs, The GNU Emacs Manual}) are set to Shell script mode. @findex define-auto-insert - In Lisp (@pxref{(emacs)Init File}) you can use the function + In Lisp (@pxref{Init File,,, emacs, The GNU Emacs Manual}) you can use the function @code{define-auto-insert} to add to or modify @code{auto-insert-alist}. See its documentation with @kbd{C-h f define-auto-insert}. @@ -438,7 +438,7 @@ expression that matched the filename. @kbd{M-x copyright} is a skeleton inserting command, that adds a copyright notice at the point. The ``by'' part is taken from your environment variable @env{$ORGANIZATION} or if that isn't set you are prompted for it. If the -buffer has a comment syntax (@pxref{(emacs)Comments}), this is inserted as a comment. +buffer has a comment syntax (@pxref{Comments,,, emacs, The GNU Emacs Manual}), this is inserted as a comment. @findex copyright-update @vindex copyright-limit @@ -450,13 +450,13 @@ existing ones, in the same format as the preceding year, i.e., 1994, '94 or 94. If a dash-separated year list up to last year is found, that is extended to current year, else the year is added separated by a comma. Or it replaces them when this is called with a prefix argument. If a header referring to a -wrong version of the GNU General Public License (@pxref{(emacs)Copying}) is found, +wrong version of the GNU General Public License (@pxref{Copying,,, emacs, The GNU Emacs Manual}) is found, that is updated too. An interesting application for this function is to have it be called automatically every time a file is saved. This is accomplished by putting @code{(add-hook 'before-save-hook 'copyright-update)} into -your @file{~/.emacs} file (@pxref{(emacs)Init File}). Alternative, +your @file{~/.emacs} file (@pxref{Init File,,, emacs, The GNU Emacs Manual}). Alternative, you can do @kbd{M-x customize-variable @key{RET} before-save-hook @key{RET}}. @code{copyright-update} is conveniently listed as an option in the customization buffer. diff --git a/doc/misc/bovine.texi b/doc/misc/bovine.texi index a263cadabae..48d5cf9e18a 100644 --- a/doc/misc/bovine.texi +++ b/doc/misc/bovine.texi @@ -23,7 +23,7 @@ @c %**end of header @copying -Copyright @copyright{} 1999-2004, 2012 Free Software Foundation, Inc. +Copyright @copyright{} 1999--2004, 2012--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -34,8 +34,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -139,7 +138,7 @@ of simplified Emacs Lisp expressions for concocting the parse tree. In bison, each time an element of @var{components} is found, it is @dfn{shifted} onto the parser stack. (The stack of matched elements.) When all @var{components}' elements have been matched, it is -@dfn{reduced} to @var{result}. @xref{(bison)Algorithm}. +@dfn{reduced} to @var{result}. @xref{Algorithm,,, bison, The GNU Bison Manual}. A particular @var{result} written into your grammar becomes the parser's goal. It is designated by a @code{%start} statement @@ -369,8 +368,8 @@ Is the kind of tag being create, such as @code{function}, or @code{variable}, though any symbol will work. @item attributes -Is an optional set of labeled values such as @w{@code{:constant-flag t :parent -"parenttype"}}. +Is an optional set of labeled values such as @code{:constant-flag t :parent +"parenttype"}. @end table @item (TAG-VARIABLE @var{name} @var{type} @var{default-value} [@var{attributes}]) diff --git a/doc/misc/calc.texi b/doc/misc/calc.texi index 71a90e1a3b3..5dabf5cd314 100644 --- a/doc/misc/calc.texi +++ b/doc/misc/calc.texi @@ -94,7 +94,7 @@ This file documents Calc, the GNU Emacs calculator, included with GNU Emacs @value{EMACSVER}. @end ifnotinfo -Copyright @copyright{} 1990-1991, 2001-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1990--1991, 2001--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -106,8 +106,7 @@ Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License.'' (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -13417,27 +13416,27 @@ dates. @xref{Specifying Operators}. To avoid confusion with nameless functions, your date formats should avoid using the @samp{#} character. @menu -* ISO-8601:: +* ISO 8601:: * Date Formatting Codes:: * Free-Form Dates:: * Standard Date Formats:: @end menu -@node ISO-8601, Date Formatting Codes, Date Formats, Date Formats -@subsubsection ISO-8601 +@node ISO 8601, Date Formatting Codes, Date Formats, Date Formats +@subsubsection ISO 8601 @noindent -@cindex ISO-8601 +@cindex ISO 8601 The same date can be written down in different formats and Calc tries to allow you to choose your preferred format. Some common formats are ambiguous, however; for example, 10/11/2012 means October 11, 2012 in the United States but it means November 10, 2012 in Europe. To help avoid such ambiguities, the International Organization -for Standardization (ISO) provides the ISO-8601 standard, which +for Standardization (ISO) provides the ISO 8601 standard, which provides three different but easily distinguishable and unambiguous ways to represent a date. -The ISO-8601 calendar date representation is +The ISO 8601 calendar date representation is @example @var{YYYY}-@var{MM}-@var{DD} @@ -13452,9 +13451,9 @@ later.) The year, which should be padded with zeros to ensure it has at least four digits, is the Gregorian year, except that the year before 0001 (1 AD) is the year 0000 (1 BC). The date October 11, 2012 is written 2012-10-11 in this representation and November 10, 2012 is -written 2012-11-10. +written 2012-11-10. -The ISO-8601 ordinal date representation is +The ISO 8601 ordinal date representation is @example @var{YYYY}-@var{DDD} @@ -13463,9 +13462,9 @@ The ISO-8601 ordinal date representation is @noindent where @var{YYYY} is the year, as above, and @var{DDD} is the day of the year. The date December 31, 2011 is written 2011-365 in this representation -and January 1, 2012 is written 2012-001. +and January 1, 2012 is written 2012-001. -The ISO-8601 week date representation is +The ISO 8601 week date representation is @example @var{YYYY}-W@var{ww}-@var{D} @@ -13476,32 +13475,32 @@ where @var{YYYY} is the ISO week-numbering year, @var{ww} is the two digit week number (preceded by a literal ``W''), and @var{D} is the day of the week (1 for Monday through 7 for Sunday). The ISO week-numbering year is based on the Gregorian year but can differ slightly. The first -week of an ISO week-numbering year is the week with the Gregorian year's +week of an ISO week-numbering year is the week with the Gregorian year's first Thursday in it (equivalently, the week containing January 4); any day of that week (Monday through Sunday) is part of the same ISO week-numbering year, any day from the previous week is part of the previous year. For example, January 4, 2013 is on a Friday, and so the first week for the ISO week-numbering year 2013 starts on -Monday, December 31, 2012. The day December 31, 2012 is then part of the +Monday, December 31, 2012. The day December 31, 2012 is then part of the Gregorian year 2012 but ISO week-numbering year 2013. In the week date representation, this week goes from 2013-W01-1 (December 31, 2012) to 2013-W01-7 (January 6, 2013). -All three ISO-8601 representations arrange the numbers from most +All three ISO 8601 representations arrange the numbers from most significant to least significant; as well as being unambiguous representations, they are easy to sort since chronological order in this formats corresponds to lexicographical order. The hyphens are sometimes omitted. -The ISO-8601 standard uses a 24 hour clock; a particular time is +The ISO 8601 standard uses a 24 hour clock; a particular time is represented by @var{hh}:@var{mm}:@var{ss} where @var{hh} is the two-digit hour (from 00 to 24), @var{mm} is the two-digit minute (from 00 to 59) and @var{ss} is the two-digit second. The seconds or minutes and seconds can be omitted, and decimals can be added. If a date with a time is represented, they should be separated by a literal ``T'', so noon -on December 13, 2012 can be represented as 2012-12-13T12:00 +on December 13, 2012 can be represented as 2012-12-13T12:00. -@node Date Formatting Codes, Free-Form Dates, ISO-8601, Date Formats +@node Date Formatting Codes, Free-Form Dates, ISO 8601, Date Formats @subsubsection Date Formatting Codes @noindent @@ -13543,9 +13542,9 @@ Year: ``1991'' for 1991, ``23'' for 23 AD. @item YYYY Year: ``1991'' for 1991, ``+23'' for 23 AD. @item ZYYY -Year: ``1991'' for 1991, ``0023'' for 23 AD., ``0000'' for 1 BC. +Year: ``1991'' for 1991, ``0023'' for 23 AD, ``0000'' for 1 BC. @item IYYY -Year: ISO-8601 week-numbering year. +Year: ISO 8601 week-numbering year. @item aa Year: ``ad'' or blank. @item AA @@ -13607,7 +13606,7 @@ Weekday: ``SUNDAY'' for Sunday. @item Wwww Weekday: ``Sunday'' for Sunday. @item Iww -Week number: ISO-8601 week number, ``W01'' for week 1. +Week number: ISO 8601 week number, ``W01'' for week 1. @item d Day of year: ``34'' for Feb. 3. @item ddd @@ -13718,15 +13717,21 @@ abbreviated to one letter, and the alternate forms @samp{a.m.}, @samp{p.m.}, and @samp{mid} are also understood. Obviously @samp{noon} and @samp{midnight} are allowed only on 12:00:00. The words @samp{noon}, @samp{mid}, and @samp{midnight} are also -recognized with no number attached. +recognized with no number attached. Midnight will represent the +beginning of a day. If there is no AM/PM indicator, the time is interpreted in 24-hour format. -To read the date portion, all words and numbers are isolated -from the string; other characters are ignored. All words must -be either month names or day-of-week names (the latter of which -are ignored). Names can be written in full or as three-letter +When reading the date portion, Calc first checks to see if it is an +ISO 8601 week-numbering date; if the string contains an integer +representing the year, a ``W'' followed by two digits for the week +number, and an integer from 1 to 7 representing the weekday (in that +order), then all other characters are ignored and this information +determines the date. Otherwise, all words and numbers are isolated +from the string; other characters are ignored. All words must be +either month names or day-of-week names (the latter of which are +ignored). Names can be written in full or as three-letter abbreviations. Large numbers, or numbers with @samp{+} or @samp{-} signs, @@ -13792,7 +13797,7 @@ command (@pxref{Mode Settings}). @item 10 @samp{ZYYY-MM-DD Www< hh:mm>} (Org mode format) @item 11 -@samp{IYYY-Iww-w<Thh:mm:ss>} (ISO-8601 week numbering format) +@samp{IYYY-Iww-w<Thh:mm:ss>} (ISO 8601 week numbering format) @end table @node Truncating the Stack, Justification, Date Formats, Display Modes @@ -17436,7 +17441,7 @@ daylight saving computations. This is an internal version of the user-level @code{pwday} function described in the previous section. It takes four arguments: The floating-point date value, the corresponding six-element date list, the day-of-month number, -and the weekday number (0-6). +and the weekday number (0--6). The default daylight saving hook ignores the time zone name, but a more sophisticated hook could use different algorithms for different @@ -36749,7 +36754,7 @@ time zone number or name from the top of the stack. @xref{Time Zones}. @c 17 @item -A prefix argument specifies a day number (0-6, 0-31, or 0-366). +A prefix argument specifies a day number (0--6, 0--31, or 0--366). @c 18 @item diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi index 76d9eb42883..f63c6c54a16 100644 --- a/doc/misc/cc-mode.texi +++ b/doc/misc/cc-mode.texi @@ -156,7 +156,7 @@ CC Mode @copying This manual is for CC Mode in Emacs. -Copyright @copyright{} 1995-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1995--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -167,8 +167,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -220,7 +219,7 @@ Objective-C, Java, CORBA IDL (and the variants PSDL and CIDL), Pike and AWK code. It provides syntax-based indentation, font locking, and has several handy commands and some minor modes to make the editing easier. It does not provide tools to look up and navigate between -functions, classes etc - there are other packages for that. +functions, classes, etc.; there are other packages for that. @insertcopying @end ifnottex @@ -370,7 +369,7 @@ Late in 1997, Martin Stjernholm joined Barry on the @ccmode{} Maintainers Team, and implemented the Pike support. In 2000 Martin took over as the sole maintainer. In 2001 Alan Mackenzie joined the team, implementing AWK support in version 5.30. @ccmode{} did not -originally contain the font lock support for its languages --- that +originally contain the font lock support for its languages; that was added in version 5.30. This manual describes @ccmode{} @@ -442,7 +441,7 @@ increasing detail. @itemize @bullet @item The chapter ``Configuration Basics'' tells you @emph{how} to write -customizations - whether in hooks, in styles, in both, or in neither, +customizations: whether in hooks, in styles, in both, or in neither, depending on your needs. It describes the @ccmode{} style system and lists the standard styles that @ccmode{} supplies. @@ -469,7 +468,7 @@ The FAQ contains a list of common problems and questions. @item The next two chapters tell you how to get in touch with the @ccmode{} -project - whether for updating @ccmode{} or submitting bug reports. +project: whether for updating @ccmode{} or submitting bug reports. @end itemize @noindent @@ -716,7 +715,7 @@ current line. When it is @code{nil}, @key{TAB} (re)indents the line only if point is to the left of the first non-whitespace character on the line. Otherwise it inserts some whitespace (a tab or an equivalent number of -spaces - see below) at point. +spaces; see below) at point. @item With some other value, the line is reindented. Additionally, if point is within a string or comment, some whitespace is inserted. @@ -821,10 +820,10 @@ often (in seconds) progress messages are to be displayed. @kindex C-c C-c @findex comment-region This command comments out the lines that start in the region. With a -negative argument, it does the opposite - it deletes the comment +negative argument, it does the opposite: it deletes the comment delimiters from these lines. @xref{Multi-Line Comments,,, emacs, GNU Emacs Manual}, for fuller details. @code{comment-region} isn't -actually part of @ccmode{} - it is given a @ccmode{} binding for +actually part of @ccmode{}; it is given a @ccmode{} binding for convenience. @item @kbd{M-;} (@code{comment-dwim} or @code{indent-for-comment} @footnote{The name of this command varies between (X)Emacs versions.}) @@ -1148,7 +1147,7 @@ them yourself, e.g., after typing @samp{@}}s. Its action is suppressed when electric mode is disabled. @item hungry-delete mode This lets you delete a contiguous block of whitespace with a single -key - for example, the newline and indentation just inserted by +key: for example, the newline and indentation just inserted by auto-newline when you want to back up and write a comment after the last statement. @item subword mode @@ -1177,7 +1176,7 @@ are enabled but the other two modes are disabled. @ccmode{} displays the current state of the first four of these minor modes on the modeline by appending letters to the major mode's name, -one letter for each enabled minor mode - @samp{l} for electric mode, +one letter for each enabled minor mode: @samp{l} for electric mode, @samp{a} for auto-newline mode, @samp{h} for hungry delete mode, and @samp{w} for subword mode. If all these modes were enabled, you'd see @samp{C/lahw}@footnote{The @samp{C} would be replaced with the name of @@ -1235,7 +1234,7 @@ turn it (or them) off. @cindex electric characters @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -Most punctuation keys provide @dfn{electric} behavior - as well as +Most punctuation keys provide @dfn{electric} behavior: as well as inserting themselves they perform some other action, such as reindenting the line. This reindentation saves you from having to reindent a line manually after typing, say, a @samp{@}}. A few @@ -2102,7 +2101,7 @@ initialization and the result is prepended. For an example, see @code{javadoc-font-lock-keywords} in @file{cc-fonts.el}. If you add support for another doc comment style, please consider -contributing it - send a note to @email{bug-cc-mode@@gnu.org}. +contributing it: send a note to @email{bug-cc-mode@@gnu.org}. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2250,7 +2249,7 @@ more sophisticated facilities, hooks and styles. An Emacs @dfn{hook} is a place to put Lisp functions that you want Emacs to execute later in specific circumstances. @xref{Hooks,,,@lispref{}, @lispreftitle{}}. @ccmode{} supplies a main -hook and a language-specific hook for each language it supports - any +hook and a language-specific hook for each language it supports; any functions you put onto these hooks get executed as the last part of a buffer's initialization. Typically you put most of your customization within the main hook, and use the language-specific hooks to vary the @@ -2684,7 +2683,7 @@ string. If none of the built-in styles is appropriate, you'll probably want to create a new @dfn{style definition}, possibly based on an existing style. To do this, put the new style's settings into a list with the -following format - the list can then be passed as an argument to the +following format; the list can then be passed as an argument to the function @code{c-add-style}. You can see an example of a style definition in @ref{Sample .emacs File}. @@ -3167,7 +3166,7 @@ different ways, depending on the character just typed: @item Braces and Colons @ccmode{} first determines the syntactic context of the brace or colon (@pxref{Syntactic Symbols}), then looks for a corresponding element in -an alist. This element specifies where to put newlines - this is any +an alist. This element specifies where to put newlines: this is any combination of before and after the brace or colon. If no alist element is found, newlines are inserted both before and after a brace, but none are inserted around a colon. See @ref{Hanging Braces} and @@ -3268,7 +3267,7 @@ syntactic symbol, the associated value is either @code{nil}, a list, or a function. @table @asis -@item The Key - the syntactic symbol +@item The Key: the syntactic symbol The syntactic symbols that are useful as keys in this list are @code{brace-list-intro}, @code{statement-cont}, @code{inexpr-class-open}, @code{inexpr-class-close}, and all the @@ -3291,7 +3290,7 @@ lists in this regard, even though they do for normal indentation purposes. It's currently not possible to set automatic newlines on these constructs. -@item The associated value - the ``ACTION'' list or function +@item The associated value: the ``ACTION'' list or function The value associated with each syntactic symbol in this association list is called an @var{action}, which can be either a list or a function which returns a list. @xref{Custom Braces}, for how to use @@ -3461,7 +3460,7 @@ that the brace appears on a line by itself. Using a mechanism similar to brace hanging (@pxref{Hanging Braces}), colons can also be made to hang using the style variable -@code{c-hanging-colons-alist} - When a colon is typed, @ccmode +@code{c-hanging-colons-alist}: when a colon is typed, @ccmode determines its syntactic context, looks this up in the alist @code{c-changing-colons-alist} and inserts up to two newlines accordingly. Here, however, If @ccmode fails to find an entry for a @@ -3472,17 +3471,17 @@ newly typed colon. @vindex hanging-colons-alist (c-) @table @asis -@item The Key - the syntactic symbol +@item The Key: the syntactic symbol The syntactic symbols appropriate as keys in this association list are: @code{case-label}, @code{label}, @code{access-label}, @code{member-init-intro}, and @code{inher-intro}. @xref{Syntactic Symbols}. Elements with any other value as a key get ignored. -@item The associate value - the ``ACTION'' list +@item The associated value: the ``ACTION'' list The @var{action} here is simply a list containing a combination of the symbols @code{before} and @code{after}. Unlike in @code{c-hanging-braces-alist}, functions as @var{actions} are not -supported - there doesn't seem to be any need for them. +supported; there doesn't seem to be any need for them. @end table @end defopt @@ -3914,7 +3913,7 @@ recognized, e.g., @code{statement}, @code{substatement}, @code{class-open}, @code{class-close}, etc. @xref{Syntactic Symbols}, for a complete list of currently recognized syntactic symbols and their semantics. The remaining entries are various data associated -with the recognized construct - there might be zero or more. +with the recognized construct; there might be zero or more. @cindex anchor position Conceptually, a line of code is always indented relative to some @@ -4571,7 +4570,7 @@ example: Here, lines 4, 7, and 10 are all assigned @code{case-label} syntax, while lines 5 and 8 are assigned @code{statement-case-intro}. Line 11 is treated slightly differently since it contains a brace that opens a -block --- it is given @code{statement-case-open} syntax. +block; it is given @code{statement-case-open} syntax. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @node Brace List Symbols, External Scope Symbols, Switch Statement Symbols, Syntactic Symbols @@ -4799,7 +4798,7 @@ Line 2 is assigned the @code{func-decl-cont} syntax. @ssindex comment-intro Line 4 is assigned both @code{defun-block-intro} @emph{and} @code{comment-intro} syntax. A syntactic element with -@code{comment-intro} has no anchor point --- It is always accompanied +@code{comment-intro} has no anchor point. It is always accompanied by another syntactic element which does have one. @item @@ -5283,15 +5282,15 @@ values that the special symbols correspond to: @item + @code{c-basic-offset} times 1 @item - -@code{c-basic-offset} times -1 +@code{c-basic-offset} times @minus{}1 @item ++ @code{c-basic-offset} times 2 @item -- -@code{c-basic-offset} times -2 +@code{c-basic-offset} times @minus{}2 @item * @code{c-basic-offset} times 0.5 @item / -@code{c-basic-offset} times -0.5 +@code{c-basic-offset} times @minus{}0.5 @end table @item A vector @@ -5333,10 +5332,10 @@ Use the first offset that doesn't evaluate to @code{nil}. Subsequent elements of the list don't get evaluated. @item min Use the minimum of all the offsets. All must be either relative or -absolute - they can't be mixed. +absolute; they can't be mixed. @item max Use the maximum of all the offsets. All must be either relative or -absolute - they can't be mixed. +absolute; they can't be mixed. @item add Add all the evaluated offsets together. Exactly one of them may be absolute, in which case the result is absolute. Any relative offsets @@ -5494,7 +5493,7 @@ any problems writing custom line-up functions for AWK mode. The calling convention for line-up functions is described fully in @ref{Custom Line-Up}. Roughly speaking, the return value is either an offset itself (such as @code{+} or @code{[0]}) or it's @code{nil}, -meaning ``this function is inappropriate in this case - try a +meaning ``this function is inappropriate in this case; try a different one''. @xref{c-offsets-alist}. The subsections below describe all the standard line-up functions, @@ -6515,12 +6514,12 @@ your setup for this by using the access functions @vindex c-syntactic-context @vindex syntactic-context (c-) Some syntactic symbols, e.g., @code{arglist-cont-nonempty}, have more -info in the syntactic element - typically other positions that can be +info in the syntactic element: typically other positions that can be interesting besides the anchor position. That info can't be accessed through the passed argument, which is a cons cell. Instead, you can get this information from the variable @code{c-syntactic-element}, which is dynamically bound to the complete syntactic element. The -variable @code{c-syntactic-context} might also be useful - it gets +variable @code{c-syntactic-context} might also be useful: it gets dynamically bound to the complete syntactic context. @xref{Custom Braces}. diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi index 725ac4269af..c3657415078 100644 --- a/doc/misc/cl.texi +++ b/doc/misc/cl.texi @@ -6,7 +6,7 @@ @copying This file documents the GNU Emacs Common Lisp emulation package. -Copyright @copyright{} 1993, 2001-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1993, 2001--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -17,8 +17,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying diff --git a/doc/misc/dbus.texi b/doc/misc/dbus.texi index 1f9a401df90..c40a5e313f5 100644 --- a/doc/misc/dbus.texi +++ b/doc/misc/dbus.texi @@ -9,7 +9,7 @@ @syncodeindex fn cp @copying -Copyright @copyright{} 2007-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2007--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -20,8 +20,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying diff --git a/doc/misc/dired-x.texi b/doc/misc/dired-x.texi index cd1ad79eab5..2cf25641350 100644 --- a/doc/misc/dired-x.texi +++ b/doc/misc/dired-x.texi @@ -19,7 +19,7 @@ @comment %**end of header (This is for running Texinfo on a region.) @copying -Copyright @copyright{} 1994-1995, 1999, 2001-2012 +Copyright @copyright{} 1994--1995, 1999, 2001--2013 Free Software Foundation, Inc. @quotation @@ -31,8 +31,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying diff --git a/doc/misc/ebrowse.texi b/doc/misc/ebrowse.texi index e13ca4714a7..c7f3e3b1a61 100644 --- a/doc/misc/ebrowse.texi +++ b/doc/misc/ebrowse.texi @@ -10,7 +10,7 @@ @copying This file documents Ebrowse, a C++ class browser for GNU Emacs. -Copyright @copyright{} 2000-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2000--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -21,8 +21,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -45,7 +44,7 @@ developing GNU and promoting software freedom.'' @contents @ifnottex -@node Top, Overview, (dir), (dir) +@node Top @top Ebrowse You can browse C++ class hierarchies from within Emacs by using @@ -68,7 +67,7 @@ Ebrowse. -@node Overview, Generating browser files, Top, Top +@node Overview @chapter Introduction When working in software projects using C++, I frequently missed @@ -178,8 +177,7 @@ them, if you like. -@node Generating browser files, Loading a Tree, Overview, Top -@comment node-name, next, previous, up +@node Generating browser files @chapter Processing Source Files @cindex @command{ebrowse}, the program @@ -226,7 +224,7 @@ available command line options.@refill @comment name, next, prev, up -@node Input files, Output file, Generating browser files, Generating browser files +@node Input files @section Specifying Input Files @table @samp @@ -267,7 +265,7 @@ properly identifying friend functions of a class. @comment name, next, prev, up -@node Output file, Structs and unions, Input files, Generating browser files +@node Output file @section Changing the Output File Name @table @samp @@ -302,7 +300,7 @@ with this command line option. @comment name, next, prev, up -@node Structs and unions, Matching, Output file, Generating browser files +@node Structs and unions @section Structs and Unions @cindex structs @cindex unions @@ -322,7 +320,7 @@ tree. @comment name, next, prev, up -@node Matching, Verbosity, Structs and unions, Generating browser files +@node Matching @section Regular Expressions @cindex regular expressions, recording @@ -375,8 +373,7 @@ the probability that it will no longer match after editing the file. -@node Verbosity, , Matching, Generating browser files -@comment node-name, next, previous, up +@node Verbosity @section Verbose Mode @cindex verbose operation @@ -396,8 +393,7 @@ the names of the classes seen. -@node Loading a Tree, Tree Buffers, Generating browser files, Top -@comment node-name, next, previous, up +@node Loading a Tree @chapter Starting to Browse @cindex loading @cindex browsing @@ -437,8 +433,7 @@ where no highlight is displayed. @comment *** @comment **************************************************************** -@node Tree Buffers, Member Buffers, Loading a Tree, Top -@comment node-name, next, previous, up +@node Tree Buffers @chapter Tree Buffers @cindex tree buffer mode @cindex class trees @@ -469,8 +464,7 @@ buffers. -@node Source Display, Member Display, Tree Buffers, Tree Buffers -@comment node-name, next, previous, up +@node Source Display @section Viewing and Finding Class Declarations @cindex viewing, class @cindex finding a class @@ -498,8 +492,7 @@ The same functionality is available from the menu opened with -@node Member Display, Go to Class, Source Display, Tree Buffers -@comment node-name, next, previous, up +@node Member Display @section Displaying Members @cindex @samp{*Members*} buffer @cindex @samp{*Globals*} @@ -562,8 +555,7 @@ These lists are also available from the class' context menu invoked with -@node Go to Class, Quitting, Member Display, Tree Buffers -@comment node-name, next, previous, up +@node Go to Class @section Finding a Class @cindex locate class @cindex expanding branches @@ -590,8 +582,7 @@ local copy of the regular expression last searched in it. -@node Quitting, File Name Display, Go to Class, Tree Buffers -@comment node-name, next, previous, up +@node Quitting @section Burying a Tree Buffer @cindex burying tree buffer @@ -603,8 +594,7 @@ Is a synonym for @kbd{M-x bury-buffer}. -@node File Name Display, Expanding and Collapsing, Quitting, Tree Buffers -@comment node-name, next, previous, up +@node File Name Display @section Displaying File Names @table @kbd @@ -634,8 +624,7 @@ Here is an example of a tree buffer with file names displayed. @end example -@node Expanding and Collapsing, Tree Indentation, File Name Display, Tree Buffers -@comment node-name, next, previous, up +@node Expanding and Collapsing @section Expanding and Collapsing a Tree @cindex expand tree branch @cindex collapse tree branch @@ -674,8 +663,7 @@ This command expands all collapsed branches in the tree. -@node Tree Indentation, Killing Classes, Expanding and Collapsing, Tree Buffers -@comment node-name, next, previous, up +@node Tree Indentation @section Changing the Tree Indentation @cindex tree indentation @cindex indentation of the tree @@ -690,8 +678,7 @@ available from the tree buffer's context menu. -@node Killing Classes, Saving a Tree, Tree Indentation, Tree Buffers -@comment node-name, next, previous, up +@node Killing Classes @section Removing Classes from the Tree @cindex killing classes @cindex class, remove from tree @@ -706,9 +693,7 @@ deletion is actually performed. -@node Saving a Tree, Statistics, Killing Classes, Tree Buffers -@comment node-name, next, previous, up -@comment node-name, next, previous, up +@node Saving a Tree @section Saving a Tree @cindex save tree to a file @cindex tree, save to a file @@ -726,8 +711,8 @@ Writes the tree to a file whose name is read from the minibuffer. -@node Statistics, Marking Classes, Saving a Tree, Tree Buffers -@comment node-name, next, previous, up +@node Statistics +@section Statistics @cindex statistics for a tree @cindex tree statistics @cindex class statistics @@ -742,8 +727,8 @@ context menu. -@node Marking Classes, , Statistics, Tree Buffers -@comment node-name, next, previous, up +@node Marking Classes +@section Marking Classes @cindex marking classes @cindex operations on marked classes @@ -784,8 +769,7 @@ display, like in the following example @c *** @c **************************************************************** -@node Member Buffers, Tags-like Functions, Tree Buffers, Top -@comment node-name, next, previous, up +@node Member Buffers @chapter Member Buffers @cindex members @cindex member buffer mode @@ -835,8 +819,7 @@ buffer: members, classes, and the buffer itself. -@node Switching Member Lists, Finding/Viewing, Member Buffers, Member Buffers -@comment node-name, next, previous, up +@node Switching Member Lists @section Switching Member Lists @cindex member lists, in member buffers @cindex static members @@ -882,8 +865,7 @@ context menu. -@node Finding/Viewing, Inherited Members, Switching Member Lists, Member Buffers -@comment node-name, next, previous, up +@node Finding/Viewing @section Finding and Viewing Member Source @cindex finding members, in member buffers @cindex viewing members, in member buffers @@ -920,8 +902,7 @@ displayed when clicking @kbd{Mouse-2} on a member name. -@node Inherited Members, Searching Members, Finding/Viewing, Member Buffers -@comment node-name, next, previous, up +@node Inherited Members @section Display of Inherited Members @cindex superclasses, members @cindex base classes, members @@ -936,8 +917,7 @@ buffer. This is also in the buffer's context menu. -@node Searching Members, Switching to Tree, Inherited Members, Member Buffers -@comment node-name, next, previous, up +@node Searching Members @section Searching Members @cindex searching members @@ -966,8 +946,7 @@ a mouse. -@node Switching to Tree, Filters, Searching Members, Member Buffers -@comment node-name, next, previous, up +@node Switching to Tree @section Switching to Tree Buffer @cindex tree buffer, switch to @cindex buffer switching @@ -985,8 +964,7 @@ displayed in the member buffer. -@node Filters, Attributes, Switching to Tree, Member Buffers -@comment node-name, next, previous, up +@node Filters @section Filters @cindex filters @@ -1030,8 +1008,7 @@ These commands are also found in the buffer's context menu. -@node Attributes, Long and Short Display, Filters, Member Buffers -@comment node-name, next, previous, up +@node Attributes @section Displaying Member Attributes @cindex attributes @cindex member attribute display @@ -1087,8 +1064,7 @@ This command is also in the buffer's context menu. -@node Long and Short Display, Regexp Display, Attributes, Member Buffers -@comment node-name, next, previous, up +@node Long and Short Display @section Long and Short Member Display @cindex display form @cindex long display @@ -1122,8 +1098,7 @@ not been produced with the @command{ebrowse} option @samp{--no-regexps}. -@node Regexp Display, Switching Classes, Long and Short Display, Member Buffers -@comment node-name, next, previous, up +@node Regexp Display @section Display of Regular Expressions @cindex regular expression display @@ -1141,8 +1116,7 @@ see @ref{Matching, --no-regexps, Regular Expressions}. -@node Switching Classes, Killing/Burying, Regexp Display, Member Buffers -@comment node-name, next, previous, up +@node Switching Classes @section Displaying Another Class @cindex base class, display @cindex derived class, display @@ -1174,8 +1148,7 @@ Switch to the next sibling of the class in the class tree. -@node Killing/Burying, Column Width, Switching Classes, Member Buffers -@comment node-name, next, previous, up +@node Killing/Burying @section Burying a Member Buffer @cindex burying member buffers @@ -1187,8 +1160,7 @@ This command is a synonym for @kbd{M-x bury-buffer}. -@node Column Width, Redisplay, Killing/Burying, Member Buffers -@comment node-name, next, previous, up +@node Column Width @section Setting the Column Width @cindex column width @cindex member indentation @@ -1203,8 +1175,7 @@ This command sets the column width depending on the display form used -@node Redisplay, Getting Help, Column Width, Member Buffers -@comment node-name, next, previous, up +@node Redisplay @section Forced Redisplay @cindex redisplay of member buffers @@ -1219,8 +1190,8 @@ columns. -@node Getting Help, , Redisplay, Member Buffers -@comment node-name, next, previous, up +@node Getting Help +@section Getting Help @cindex help @table @kbd @@ -1235,8 +1206,7 @@ This key is bound to @code{describe-mode}. @comment *** TAGS LIKE FUNCTIONS @comment ************************************************************** -@node Tags-like Functions, GNU Free Documentation License, Member Buffers, Top -@comment node-name, next, previous, up +@node Tags-like Functions @chapter Tags-like Functions Ebrowse provides tags functions similar to those of the standard @@ -1255,8 +1225,7 @@ Emacs Tags facility, but better suited to the needs of C++ programmers. -@node Finding and Viewing, Position Stack, Tags-like Functions, Tags-like Functions -@comment node-name, next, previous, up +@node Finding and Viewing @section Finding and Viewing Members @cindex finding class member, in C++ source @cindex viewing class member, in C++ source @@ -1315,8 +1284,7 @@ View a member's declaration in another frame. -@node Position Stack, Search & Replace, Finding and Viewing, Tags-like Functions -@comment node-name, next, previous, up +@node Position Stack @section The Position Stack @cindex position stack @@ -1352,8 +1320,7 @@ view a position with @kbd{v}. -@node Search & Replace, Members in Files, Position Stack, Tags-like Functions -@comment node-name, next, previous, up +@node Search & Replace @section Searching and Replacing @cindex searching multiple C++ files @cindex replacing in multiple C++ files @@ -1390,8 +1357,7 @@ This restarts the last tags operation with the next file in the list. -@node Members in Files, Apropos, Search & Replace, Tags-like Functions -@comment node-name, next, previous, up +@node Members in Files @section Members in Files @cindex files @cindex members in file, listing @@ -1404,8 +1370,7 @@ name is read from the minibuffer with completion. -@node Apropos, Symbol Completion, Members in Files, Tags-like Functions -@comment node-name, next, previous, up +@node Apropos @section Member Apropos @cindex apropos on class members @cindex members, matching regexp @@ -1422,8 +1387,7 @@ command @kbd{C-c C-m f}, for example, to jump to a specific member. -@node Symbol Completion, Member Buffer Display, Apropos, Tags-like Functions -@comment node-name, next, previous, up +@node Symbol Completion @section Symbol Completion @cindex completion @cindex symbol completion @@ -1433,7 +1397,7 @@ The command @kbd{C-c C-m @key{TAB}} completes the symbol in front of point. -@node Member Buffer Display, , Symbol Completion, Tags-like Functions +@node Member Buffer Display @section Quick Member Display @cindex member buffer, for member at point @@ -1441,12 +1405,12 @@ You can quickly display a member buffer containing the member the cursor in on with the command @kbd{C-c C-m m}. -@node GNU Free Documentation License, Concept Index, Tags-like Functions, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Concept Index, , GNU Free Documentation License, Top +@node Concept Index @unnumbered Concept Index @printindex cp diff --git a/doc/misc/ede.texi b/doc/misc/ede.texi index 34ec72fc193..cadd815025c 100644 --- a/doc/misc/ede.texi +++ b/doc/misc/ede.texi @@ -5,7 +5,8 @@ @copying This file describes EDE, the Emacs Development Environment. -Copyright @copyright{} 1998-2001, 2004-2005, 2008-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1998--2001, 2004--2005, 2008--2013 +Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -16,8 +17,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License.'' (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -63,7 +63,7 @@ developing GNU and promoting software freedom.'' @contents -@node top, EDE Project Concepts, (dir), (dir) +@node Top, EDE Project Concepts, (dir), (dir) @top EDE @comment node-name, next, previous, up @@ -88,9 +88,10 @@ learn and adopt GNU ways of doing things. * Building and Debugging:: Initiating a build or debug session. * Miscellaneous commands:: Other project related commands. * Extending EDE:: Programming and extending @ede{}. +* GNU Free Documentation License:: The license for this documentation. @end menu -@node EDE Project Concepts, EDE Mode, top, top +@node EDE Project Concepts, EDE Mode, Top, Top @chapter @ede{} Project Concepts @ede{} is a generic interface for managing projects. It specifies a @@ -125,7 +126,7 @@ of search to files in a single target, or to discover the location of documentation or interface files. @ede{} can provide this information. -@node EDE Mode, Quick Start, EDE Project Concepts, top +@node EDE Mode, Quick Start, EDE Project Concepts, Top @chapter @ede{} Mode @ede{} is implemented as a minor mode, which augments other modes such @@ -142,7 +143,7 @@ bar. This menu provides several menu items for high-level @ede{} commands. These menu items, and their corresponding keybindings, are independent of the type of project you are actually working on. -@node Quick Start, Creating a project, EDE Mode, top +@node Quick Start, Creating a project, EDE Mode, Top @chapter Quick Start Once you have @ede{} enabled, you can create a project. This chapter @@ -438,7 +439,7 @@ C-c . R RET RET If your program takes command line arguments, you can type them in when it offers the command line you want to use to run your program. -@node Creating a project, Modifying your project, Quick Start, top +@node Creating a project, Modifying your project, Quick Start, Top @chapter Creating a project To create a new project, first visit a file that you want to include @@ -496,7 +497,7 @@ the top-most project's makefile as a starting place for the build. How the toplevel project handles subprojects in the build process is dependent on that project's type. -@node Modifying your project, Building and Debugging, Creating a project, top +@node Modifying your project, Building and Debugging, Creating a project, Top @chapter Modifying your project In this chapter, we describe the generic features for manipulating @@ -677,7 +678,7 @@ block for ``configurations''. Add a new named configuration here. To switch between different active configurations, modify the ``configuration default'' slot. -@node Building and Debugging, Miscellaneous commands, Modifying your project, top +@node Building and Debugging, Miscellaneous commands, Modifying your project, Top @chapter Building and Debugging @ede{} provides the following ``project-aware'' compilation and @@ -696,7 +697,7 @@ Build a distribution file for your project. These commands are also available from the @samp{Development} menu. -@node Miscellaneous commands, Extending EDE, Building and Debugging, top +@node Miscellaneous commands, Extending EDE, Building and Debugging, Top @chapter Miscellaneous commands If you opt to go in and edit @ede{} project files directly---for @@ -1092,7 +1093,7 @@ You can add your own locate tool but subclassing from methods. See the code in @file{ede-locate.el} for GNU Global as a simple example. -@node Extending EDE, , Miscellaneous commands, top +@node Extending EDE, GNU Free Documentation License, Miscellaneous commands, Top @chapter Extending @ede{} This chapter is intended for users who want to write new parts or fix @@ -1109,7 +1110,7 @@ superclasses. In this way, specific behaviors such as how a project is saved, or how a target is compiled can be customized by a project author in detail. @ede{} communicates to these project objects via an API using methods. The commands you use in @ede{} mode are high-level -functional wrappers over these methods. @xref{(eieio)Top}. For +functional wrappers over these methods. @xref{Top,,, eieio, EIEIO manual}. For details on using @eieio{} to extending classes, and writing methods. If you intend to extend @ede{}, it is most likely that a new target type is @@ -1360,7 +1361,8 @@ association when a file is loaded. It is generally unnecessary to override this unless you keep auxiliary files. @end table -These methods are used by the semantic package extensions @xref{(semantic)Top}. +These methods are used by the semantic package extensions. +@xref{Top,,, semantic, Semantic manual}. @table @code @item ede-buffer-header-file @@ -4436,4 +4438,8 @@ For example, C code uses .o on unix, and Emacs Lisp uses .elc. @end table @end table +@node GNU Free Documentation License, , Extending EDE, Top +@appendix GNU Free Documentation License +@include doclicense.texi + @bye diff --git a/doc/misc/ediff.texi b/doc/misc/ediff.texi index 55bfb9f6cb8..1e4c888a9e7 100644 --- a/doc/misc/ediff.texi +++ b/doc/misc/ediff.texi @@ -25,7 +25,7 @@ This file documents Ediff, a comprehensive visual interface to Unix diff and patch utilities. -Copyright @copyright{} 1995-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1995--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -36,8 +36,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -62,7 +61,7 @@ developing GNU and promoting software freedom.'' @contents -@node Top, Introduction, (dir), (dir) +@node Top @top Ediff @insertcopying @@ -80,7 +79,7 @@ developing GNU and promoting software freedom.'' * Index:: @end menu -@node Introduction, Major Entry Points, Top, Top +@node Introduction @chapter Introduction @cindex Comparing files and buffers @@ -128,7 +127,7 @@ functions are adaptations from Emerge. Although Ediff subsumes and greatly extends Emerge, much of the functionality in Ediff is influenced by Emerge. The architecture and the interface are, of course, drastically different. -@node Major Entry Points, Session Commands, Introduction, Top +@node Major Entry Points @chapter Major Entry Points When Ediff starts up, it displays a small control window, which accepts the @@ -398,7 +397,7 @@ Moreover, the functions @code{ediff-directory-revisions}, related Ediff sessions by taking a directory and comparing (or merging) versions of files in that directory. -@node Session Commands, Registry of Ediff Sessions, Major Entry Points, Top +@node Session Commands @chapter Session Commands All Ediff commands are displayed in a Quick Help window, unless you type @@ -431,7 +430,7 @@ command (see @kbd{ga}, @kbd{gb}, and @kbd{gc}). * Other Session Commands:: Commands that are not bound to keys. @end menu -@node Quick Help Commands,Other Session Commands,,Session Commands +@node Quick Help Commands @section Quick Help Commands @cindex command help @cindex important commands @@ -557,8 +556,8 @@ Makes the next difference region current. Makes the very first difference region current. @kbd{-j} makes the last region current. Typing a number, N, and then `j' -makes the difference region N current. Typing -N (a negative number) then -`j' makes current the region Last - N. +makes the difference region N current. Typing @minus{}N (a negative number) then +`j' makes current the region Last @minus{} N. @item ga @kindex ga @@ -912,7 +911,7 @@ merge buffer and then select regions in those buffers. @end table -@node Other Session Commands,,Quick Help Commands,Session Commands +@node Other Session Commands @section Other Session Commands The following commands can be invoked from within any Ediff session, @@ -955,7 +954,7 @@ difference. @vindex ediff-use-toolbar-p The use of the toolbar can also be specified via the variable @code{ediff-use-toolbar-p} (default is @code{t}). This variable can be set -only in @file{.emacs} --- do @strong{not} change it interactively. Use the +only in @file{.emacs}: do @strong{not} change it interactively. Use the function @code{ediff-toggle-use-toolbar} instead. @item ediff-revert-buffers-then-recompute-diffs @@ -978,7 +977,7 @@ making it run faster. The function @code{ediff-profile} toggles profiling of ediff commands. @end table -@node Registry of Ediff Sessions, Session Groups, Session Commands, Top +@node Registry of Ediff Sessions @chapter Registry of Ediff Sessions Ediff maintains a registry of all its invocations that are @@ -1009,7 +1008,7 @@ and @kbd{DEL} (previous registry record). There are other commands as well, but you don't need to memorize them, since they are listed at the top of the registry buffer. -@node Session Groups, Remote and Compressed Files, Registry of Ediff Sessions, Top +@node Session Groups @chapter Session Groups Several major entries of Ediff perform comparison and merging on @@ -1128,7 +1127,7 @@ user whether or not to do a recursive descent. -@node Remote and Compressed Files, Customization, Session Groups, Top +@node Remote and Compressed Files @chapter Remote and Compressed Files Ediff works with remote, compressed, and encrypted files. Ediff @@ -1151,7 +1150,7 @@ i.e., the original is renamed into @file{source-name.orig} and the result of the patch is placed into the file source-name (@file{_orig} is used on systems like DOS, etc.) -@node Customization, Credits, Remote and Compressed Files, Top +@node Customization @chapter Customization Ediff has a rather self-explanatory interface, and in most cases you @@ -1187,7 +1186,7 @@ refer to Emacs manual for the information on how to set Emacs X resources. * Notes on Heavy-duty Customization:: Customization for the gurus. @end menu -@node Hooks, Quick Help Customization, Customization, Customization +@node Hooks @section Hooks The bulk of customization can be done via the following hooks: @@ -1327,13 +1326,13 @@ Hooks run just before exiting a session group. @item ediff-meta-buffer-keymap-setup-hook @vindex ediff-meta-buffer-keymap-setup-hook @vindex ediff-meta-buffer-map -Hooks run just after setting up the @code{ediff-meta-buffer-map} --- the +Hooks run just after setting up the @code{ediff-meta-buffer-map}, the map that controls key bindings in the meta buffer. Since @code{ediff-meta-buffer-map} is a local variable, you can set different bindings for different kinds of meta buffers. @end table -@node Quick Help Customization, Window and Frame Configuration, Hooks, Customization +@node Quick Help Customization @section Quick Help Customization @vindex ediff-use-long-help-message @vindex ediff-control-buffer @@ -1357,7 +1356,7 @@ basis, you must use @code{ediff-startup-hook} to change the value of the variable @code{ediff-help-message}, which is local to @code{ediff-control-buffer}. -@node Window and Frame Configuration, Selective Browsing, Quick Help Customization, Customization +@node Window and Frame Configuration @section Window and Frame Configuration On a non-windowing display, Ediff sets things up in one frame, splitting @@ -1494,7 +1493,7 @@ can switch between sessions by suspending one session and then switching to another control panel. (Different control panel buffers are distinguished by a numerical suffix, e.g., @samp{Ediff Control Panel<3>}.) -@node Selective Browsing, Highlighting Difference Regions, Window and Frame Configuration, Customization +@node Selective Browsing @section Selective Browsing Sometimes it is convenient to be able to step through only some difference @@ -1609,7 +1608,7 @@ ignoring letter case or not. It can be set in @file{.emacs} using When case sensitivity is toggled, all difference regions are recomputed. -@node Highlighting Difference Regions, Narrowing, Selective Browsing, Customization +@node Highlighting Difference Regions @section Highlighting Difference Regions The following variables control the way Ediff highlights difference @@ -1736,7 +1735,7 @@ faces, you can modify them when Ediff is being loaded using or @code{set/make-face-@dots{}} as shown above. Emacs's low-level face-manipulation functions should be avoided. -@node Narrowing, Refinement of Difference Regions, Highlighting Difference Regions, Customization +@node Narrowing @section Narrowing If buffers being compared are narrowed at the time of invocation of @@ -1768,7 +1767,7 @@ Controls whether on quitting Ediff should restore the accessible range that existed before the current invocation. @end table -@node Refinement of Difference Regions, Patch and Diff Programs, Narrowing, Customization +@node Refinement of Difference Regions @section Refinement of Difference Regions Ediff has variables to control the way fine differences are @@ -1840,7 +1839,7 @@ command @kbd{@@}. Repeated typing of this key cycles through three different states: auto-refining, no-auto-refining, and no-highlighting of fine differences. -@node Patch and Diff Programs, Merging and diff3, Refinement of Difference Regions, Customization +@node Patch and Diff Programs @section Patch and Diff Programs This section describes variables that specify the programs to be used for @@ -1949,7 +1948,7 @@ Specifies the default directory to look for patches. @code{diff}. Instead, make sure you are using some implementation of POSIX @code{diff}, such as @code{gnudiff}. -@node Merging and diff3, Support for Version Control, Patch and Diff Programs, Customization +@node Merging and diff3 @section Merging and diff3 Ediff supports three-way comparison via the functions @code{ediff-files3} and @@ -2153,7 +2152,7 @@ When merge buffers are saved automatically as directed by specified by the variable @code{ediff-merge-filename-prefix}. The default is @code{merge_}, but this can be changed by the user. -@node Support for Version Control, Customizing the Mode Line, Merging and diff3, Customization +@node Support for Version Control @section Support for Version Control @@ -2198,7 +2197,7 @@ In case of @file{pcl-cvs.el}, Ediff can also be invoked via the function @code{run-ediff-from-cvs-buffer}---see the documentation string for this function. -@node Customizing the Mode Line, Miscellaneous, Support for Version Control, Customization +@node Customizing the Mode Line @section Customizing the Mode Line When Ediff is running, the mode line of @samp{Ediff Control Panel} @@ -2217,7 +2216,7 @@ don't like the way Ediff changes the mode line, you can use @pindex @file{uniquify.el} @pindex @file{mode-line.el} -@node Miscellaneous, Notes on Heavy-duty Customization, Customizing the Mode Line, Customization +@node Miscellaneous @section Miscellaneous Here are a few other variables for customizing Ediff: @@ -2334,7 +2333,7 @@ Try different settings and see which one is for you. @end table -@node Notes on Heavy-duty Customization, , Miscellaneous, Customization +@node Notes on Heavy-duty Customization @section Notes on Heavy-duty Customization Some users need to customize Ediff in rather sophisticated ways, which @@ -2403,7 +2402,7 @@ non-@code{nil} only if Ediff uses the multiframe display, i.e., when the control buffer is in its own frame. @end table -@node Credits, GNU Free Documentation License, Customization, Top +@node Credits @chapter Credits Ediff was written by Michael Kifer <kifer@@cs.stonybrook.edu>. It was inspired @@ -2521,12 +2520,12 @@ Ilya Zakharevich (ilya at math.ohio-state.edu), Eli Zaretskii (eliz at is.elta.co.il) @end example -@node GNU Free Documentation License, Index, Credits, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Index, , GNU Free Documentation License, Top +@node Index @unnumbered Index @printindex cp diff --git a/doc/misc/edt.texi b/doc/misc/edt.texi index 12e65100e4e..339d59bd123 100644 --- a/doc/misc/edt.texi +++ b/doc/misc/edt.texi @@ -5,7 +5,7 @@ @copying This file documents the EDT emulation package for Emacs. -Copyright @copyright{} 1986, 1992, 1994-1995, 1999-2012 +Copyright @copyright{} 1986, 1992, 1994--1995, 1999--2013 Free Software Foundation, Inc. @quotation @@ -17,8 +17,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -103,25 +102,25 @@ how to customize it to your liking. @itemize @item -@file{edt.texi} - This manual. +@file{edt.texi}---This manual. @item -@file{edt-user.el} - An example customization file. +@file{edt-user.el}---An example customization file. @item -@file{edt.el} - EDT emulation functions and default configuration. +@file{edt.el}---EDT emulation functions and default configuration. @item -@file{edt-lk201.el} - Built-in support for DEC LK-201 keyboards. +@file{edt-lk201.el}---Built-in support for DEC LK-201 keyboards. @item -@file{edt-vt100.el} - Built-in support for DEC VT-100 (and above) terminals. +@file{edt-vt100.el}---Built-in support for DEC VT-100 (and above) terminals. @item -@file{edt-pc.el} - Built-in support for PC 101 Keyboards under MS-DOS. +@file{edt-pc.el}---Built-in support for PC 101 Keyboards under MS-DOS. @item -@file{edt-mapper.el} - Create an EDT LK-201 map file for keyboards +@file{edt-mapper.el}---Create an EDT LK-201 map file for keyboards without built-in support. @end itemize diff --git a/doc/misc/eieio.texi b/doc/misc/eieio.texi index fc92a76ff36..b16144e98a2 100644 --- a/doc/misc/eieio.texi +++ b/doc/misc/eieio.texi @@ -11,7 +11,7 @@ @copying This manual documents EIEIO, an object framework for Emacs Lisp. -Copyright @copyright{} 2007-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2007--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -22,8 +22,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License.'' (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -77,6 +76,7 @@ Emacs. * Naming Conventions:: Name your objects in an Emacs friendly way. * CLOS compatibility:: What are the differences? * Wish List:: Things about EIEIO that could be improved. +* GNU Free Documentation License:: The license for this documentation. * Function Index:: @end menu @@ -446,7 +446,7 @@ that default value with @code{oset-default}. @ref{Accessing Slots}. @item :type An unquoted type specifier used to validate data set into this slot. -@xref{(cl)Type Predicates}. +@xref{Type Predicates,,,cl,Common Lisp Extensions}. Here are some examples: @table @code @item symbol @@ -1571,7 +1571,7 @@ all these classes, subsection headings, and indexes. Each class will be indexed using the texinfo labeled index @var{indexstring} which is a two letter description. -@xref{(texinfo) New Indices}. +@xref{New Indices,,,texinfo,Texinfo manual}. To use this command, the texinfo macro @@ -1874,8 +1874,9 @@ instead pre-builds a method that gets the slot's value. @item :type Specifier uses the @code{typep} function from the @file{cl} -package. @xref{(cl)Type Predicates}. It therefore has the same issues as -that package. Extensions include the ability to provide object names. +package. @xref{Type Predicates,,,cl,Common Lisp Extensions}. +It therefore has the same issues as that package. Extensions include +the ability to provide object names. @end table Defclass also supports class options, but does not currently use values @@ -1950,6 +1951,10 @@ buffers. Allow method overloading of method-like functions in Emacs. @end enumerate +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + @node Function Index @unnumbered Function Index diff --git a/doc/misc/emacs-gnutls.texi b/doc/misc/emacs-gnutls.texi index 12e65c9e8dd..740dfee41ed 100644 --- a/doc/misc/emacs-gnutls.texi +++ b/doc/misc/emacs-gnutls.texi @@ -1,14 +1,14 @@ \input texinfo @c -*-texinfo-*- +@set VERSION 0.3 + @setfilename ../../info/emacs-gnutls @settitle Emacs GnuTLS Integration @value{VERSION} -@set VERSION 0.3 - @copying This file describes the Emacs GnuTLS integration. -Copyright @copyright{} 2012 Free Software Foundation, Inc. +Copyright @copyright{} 2012--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -16,17 +16,10 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the license -is included in the section entitled ``GNU Free Documentation License'' -in the Emacs manual. +is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' - -This document is part of a collection distributed under the GNU Free -Documentation License. If you want to distribute this document -separately from the collection, you can do so by adding a copy of the -license to the document, as described in section 6 of the license. +modify this GNU manual.'' @end quotation @end copying @@ -61,6 +54,7 @@ Emacs Lisp library. * Overview:: Overview of the GnuTLS integration. * Help For Users:: * Help For Developers:: +* GNU Free Documentation License:: The license for this documentation. * Function Index:: * Variable Index:: @end menu @@ -185,12 +179,16 @@ Please see @file{gnutls.el} for the @var{spec} details and for usage, but do not rely on this function's interface if possible. @end defun +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + @node Function Index -@chapter Function Index +@unnumbered Function Index @printindex fn @node Variable Index -@chapter Variable Index +@unnumbered Variable Index @printindex vr @bye diff --git a/doc/misc/emacs-mime.texi b/doc/misc/emacs-mime.texi index 966cace7f6e..216e4733cd1 100644 --- a/doc/misc/emacs-mime.texi +++ b/doc/misc/emacs-mime.texi @@ -11,7 +11,7 @@ @copying This file documents the Emacs MIME interface functionality. -Copyright @copyright{} 1998-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1998--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -22,8 +22,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -1856,7 +1855,7 @@ Conformance Criteria and Examples Languages, and Continuations @item RFC1843 -HZ - A Data Format for Exchanging Files of Arbitrarily Mixed Chinese and +HZ---A Data Format for Exchanging Files of Arbitrarily Mixed Chinese and @acronym{ASCII} characters @item draft-ietf-drums-msg-fmt-05.txt diff --git a/doc/misc/epa.texi b/doc/misc/epa.texi index 9dfdf5ff0c3..e21851ef37a 100644 --- a/doc/misc/epa.texi +++ b/doc/misc/epa.texi @@ -9,7 +9,7 @@ @copying This file describes EasyPG Assistant @value{VERSION}. -Copyright @copyright{} 2007-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2007--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -17,17 +17,10 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the license -is included in the section entitled ``GNU Free Documentation License'' -in the Emacs manual. +is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' - -This document is part of a collection distributed under the GNU Free -Documentation License. If you want to distribute this document -separately from the collection, you can do so by adding a copy of the -license to the document, as described in section 6 of the license. +modify this GNU manual.'' @end quotation @end copying @@ -68,6 +61,7 @@ called EasyPG Library. * Commands:: * Caching Passphrases:: * Bug Reports:: +* GNU Free Documentation License:: The license for this documentation. @end menu @node Overview @@ -493,6 +487,10 @@ Before reporting the bug, you should set @code{epg-debug} in the of the @samp{ *epg-debug*} buffer. Note that the first letter of the buffer name is a whitespace. +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + @bye @c End: diff --git a/doc/misc/erc.texi b/doc/misc/erc.texi index 8c8e0b56cd0..cc61cd1ab5b 100644 --- a/doc/misc/erc.texi +++ b/doc/misc/erc.texi @@ -9,7 +9,7 @@ @copying This manual is for ERC as distributed with Emacs @value{EMACSVER}. -Copyright @copyright{} 2005-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2005--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -20,8 +20,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' All Emacs Lisp code contained in this document may be used, distributed, and modified without restriction. @@ -62,10 +61,6 @@ and modified without restriction. * Advanced Usage:: Cool ways of using ERC. * Getting Help and Reporting Bugs:: * History:: The history of ERC. -* Copying:: The GNU General Public License gives you - permission to redistribute ERC on - certain terms; it also explains that - there is no warranty. * GNU Free Documentation License:: The license for this documentation. * Concept Index:: Search for terms. @@ -855,10 +850,6 @@ is maintained as part of Emacs. @end itemize -@node Copying -@appendix GNU GENERAL PUBLIC LICENSE -@include gpl.texi - @node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi diff --git a/doc/misc/ert.texi b/doc/misc/ert.texi index 146a6ccbc35..8728d53ea27 100644 --- a/doc/misc/ert.texi +++ b/doc/misc/ert.texi @@ -10,7 +10,7 @@ @end direntry @copying -Copyright @copyright{} 2008, 2010-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2008, 2010--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -18,21 +18,14 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the license -is included in the section entitled ``GNU Free Documentation License'' -in the Emacs manual. +is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' - -This document is part of a collection distributed under the GNU Free -Documentation License. If you want to distribute this document -separately from the collection, you can do so by adding a copy of the -license to the document, as described in section 6 of the license. +modify this GNU manual.'' @end quotation @end copying -@node Top, Introduction, (dir), (dir) +@node Top @top ERT: Emacs Lisp Regression Testing ERT is a tool for automated testing in Emacs Lisp. Its main features @@ -53,6 +46,7 @@ traditional software development methods. * How to Debug Tests:: What to do if a test fails. * Extending ERT:: ERT is extensible in several ways. * Other Testing Concepts:: Features not in ERT. +* GNU Free Documentation License:: The license for this documentation. @detailmenu --- The Detailed Node Listing --- @@ -85,15 +79,19 @@ Other Testing Concepts * Mocks and Stubs:: Stubbing out code that is irrelevant to the test. * Fixtures and Test Suites:: How ERT differs from tools for other languages. +Appendix + +* GNU Free Documentation License:: The license for this documentation. + @end detailmenu @end menu -@node Introduction, How to Run Tests, Top, Top +@node Introduction @chapter Introduction ERT allows you to define @emph{tests} in addition to functions, macros, variables, and the other usual Lisp constructs. Tests are -simply Lisp code --- code that invokes other code and checks whether +simply Lisp code: code that invokes other code and checks whether it behaves as expected. ERT keeps track of the tests that are defined and provides convenient @@ -134,8 +132,8 @@ will pass if the three calls to @code{equal} all return true better error reporting. @xref{The @code{should} Macro}. Each test should have a name that describes what functionality it tests. -Test names can be chosen arbitrarily --- they are in a -namespace separate from functions and variables --- but should follow +Test names can be chosen arbitrarily---they are in a +namespace separate from functions and variables---but should follow the usual Emacs Lisp convention of having a prefix that indicates which package they belong to. Test names are displayed by ERT when reporting failures and can be used when selecting which tests to run. @@ -156,7 +154,7 @@ test. Tests should clean up even if they fail. @xref{Tests and Their Environment}. -@node How to Run Tests, How to Write Tests, Introduction, Top +@node How to Run Tests @chapter How to Run Tests You can run tests either in the Emacs you are working in, or on the @@ -174,7 +172,7 @@ different Emacs versions. @end menu -@node Running Tests Interactively, Running Tests in Batch Mode, How to Run Tests, How to Run Tests +@node Running Tests Interactively @section Running Tests Interactively You can run the tests that are currently defined in your Emacs with @@ -253,7 +251,7 @@ while point is on a test failure will increase the limits to show more of the expression. -@node Running Tests in Batch Mode, Test Selectors, Running Tests Interactively, How to Run Tests +@node Running Tests in Batch Mode @section Running Tests in Batch Mode ERT supports automated invocations from the command line or from @@ -277,7 +275,7 @@ additional @code{-L} flags to ensure that @code{my-tests.el} and all the files that it requires are on your @code{load-path}. -@node Test Selectors, , Running Tests in Batch Mode, How to Run Tests +@node Test Selectors @section Test Selectors Functions like @code{ert} accept a @emph{test selector}, a Lisp @@ -316,7 +314,7 @@ result in the last run, and tag-based selectors such as @code{(not @code{:causes-redisplay}. -@node How to Write Tests, How to Debug Tests, How to Run Tests, Top +@node How to Write Tests @chapter How to Write Tests ERT lets you define tests in the same way you define functions. You @@ -336,7 +334,7 @@ to find where a test was defined if the test was loaded from a file. * Useful Techniques:: Some examples. @end menu -@node The @code{should} Macro, Expected Failures, How to Write Tests, How to Write Tests +@node The @code{should} Macro @section The @code{should} Macro Test bodies can include arbitrary code; but to be useful, they need to @@ -400,7 +398,7 @@ default. @code{should} reports. -@node Expected Failures, Tests and Their Environment, The @code{should} Macro, How to Write Tests +@node Expected Failures @section Expected Failures Some bugs are complicated to fix, or not very important, and are left as @@ -453,7 +451,7 @@ versions, specific architectures, etc.: @end lisp -@node Tests and Their Environment, Useful Techniques, Expected Failures, How to Write Tests +@node Tests and Their Environment @section Tests and Their Environment The outcome of running a test should not depend on the current state @@ -504,11 +502,11 @@ buffer if one is already visiting the requested file; and it runs Instead, it is better to use lower-level mechanisms with simple and predictable semantics like @code{with-temp-buffer}, @code{insert} or @code{insert-file-contents-literally}, and to activate any desired mode -by calling the corresponding function directly --- after binding the +by calling the corresponding function directly, after binding the hook variables to nil. This avoids the above problems. -@node Useful Techniques, , Tests and Their Environment, How to Write Tests +@node Useful Techniques @section Useful Techniques when Writing Tests Testing simple functions that have no side effects and no dependencies @@ -561,9 +559,9 @@ could be used instead. The reason why this test only checks the first line of the backtrace is that the remainder of the backtrace is dependent on ERT's internals as well as whether the code is running interpreted or compiled. By -looking only at the first line, the test checks a useful property ---- that the backtrace correctly captures the call to @code{signal} that -results from the call to @code{ert-fail} --- without being brittle. +looking only at the first line, the test checks a useful property---that +the backtrace correctly captures the call to @code{signal} that +results from the call to @code{ert-fail}---without being brittle. This example also shows that writing tests is much easier if the code under test was structured with testing in mind. @@ -589,7 +587,7 @@ for testing. Usually, this makes the interfaces easier to use as well. -@node How to Debug Tests, Extending ERT, How to Write Tests, Top +@node How to Debug Tests @chapter How to Debug Tests This section describes how to use ERT's features to understand why @@ -602,7 +600,7 @@ a test failed. @end menu -@node Understanding Explanations, Interactive Debugging, How to Debug Tests, How to Debug Tests +@node Understanding Explanations @section Understanding Explanations Failed @code{should} forms are reported like this: @@ -669,7 +667,7 @@ ERT only provides explanations for predicates that have an explanation function registered. @xref{Defining Explanation Functions}. -@node Interactive Debugging, , Understanding Explanations, How to Debug Tests +@node Interactive Debugging @section Interactive Debugging Debugging failed tests essentially works the same way as debugging any @@ -701,12 +699,12 @@ strips them out, so it is more convenient. failed. This can be useful to figure out how far it got. @item You can instrument tests for debugging the same way you instrument -@code{defun}s for debugging --- go to the source code of the test and +@code{defun}s for debugging: go to the source code of the test and type @kbd{@kbd{C-u} @kbd{C-M-x}}. Then, go back to the ERT buffer and re-run the test with @kbd{r} or @kbd{d}. @item If you have been editing and rearranging tests, it is possible that -ERT remembers an old test that you have since renamed or removed --- +ERT remembers an old test that you have since renamed or removed: renamings or removals of definitions in the source code leave around a stray definition under the old name in the running process (this is a common problem in Lisp). In such a situation, hit @kbd{D} to let ERT @@ -714,7 +712,7 @@ forget about the obsolete test. @end itemize -@node Extending ERT, Other Testing Concepts, How to Debug Tests, Top +@node Extending ERT @chapter Extending ERT There are several ways to add functionality to ERT. @@ -725,7 +723,7 @@ There are several ways to add functionality to ERT. @end menu -@node Defining Explanation Functions, Low-Level Functions for Working with Tests, Extending ERT, Extending ERT +@node Defining Explanation Functions @section Defining Explanation Functions The explanation function for a predicate is a function that takes the @@ -743,7 +741,7 @@ The value of the property should be the symbol that names the explanation function. -@node Low-Level Functions for Working with Tests, , Defining Explanation Functions, Extending ERT +@node Low-Level Functions for Working with Tests @section Low-Level Functions for Working with Tests Both @code{ert-run-tests-interactively} and @code{ert-run-tests-batch} @@ -759,7 +757,7 @@ meant to be usable by other code. But there is no mature API yet. Contributions to ERT are welcome. -@node Other Testing Concepts, , Extending ERT, Top +@node Other Testing Concepts @chapter Other Testing Concepts For information on mocks, stubs, fixtures, or test suites, see below. @@ -770,7 +768,7 @@ For information on mocks, stubs, fixtures, or test suites, see below. * Fixtures and Test Suites:: How ERT differs from tools for other languages. @end menu -@node Mocks and Stubs, Fixtures and Test Suites, Other Testing Concepts, Other Testing Concepts +@node Mocks and Stubs @section Other Tools for Emacs Lisp Stubbing out functions or using so-called @emph{mocks} can make it @@ -783,7 +781,7 @@ ERT does not have built-in support for mocks or stubs. The package offers mocks for Emacs Lisp and can be used in conjunction with ERT. -@node Fixtures and Test Suites, , Mocks and Stubs, Other Testing Concepts +@node Fixtures and Test Suites @section Fixtures and Test Suites In many ways, ERT is similar to frameworks for other languages like @@ -842,6 +840,10 @@ e.g., to run quick tests during interactive development and slow tests less often. This can be achieved with the @code{:tag} argument to @code{ert-deftest} and @code{tag} test selectors. +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + @bye @c LocalWords: ERT JUnit namespace docstring ERT's diff --git a/doc/misc/eshell.texi b/doc/misc/eshell.texi index 81bc1edc169..504940c5c6b 100644 --- a/doc/misc/eshell.texi +++ b/doc/misc/eshell.texi @@ -8,7 +8,7 @@ @copying This manual is for Eshell, the Emacs shell. -Copyright @copyright{} 1999-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1999--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -19,8 +19,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -33,9 +32,9 @@ developing GNU and promoting software freedom.'' @sp 4 @c The title is printed in a large font. @center @titlefont{User's Guide} -@sp +@sp 1 @center @titlefont{to} -@sp +@sp 1 @center @titlefont{Eshell: The Emacs Shell} @ignore @sp 2 @@ -58,7 +57,7 @@ developing GNU and promoting software freedom.'' @c ================================================================ @ifnottex -@node Top, What is Eshell?, (dir), (dir) +@node Top @top Eshell Eshell is a shell-like command interpreter diff --git a/doc/misc/eudc.texi b/doc/misc/eudc.texi index a21e73019b9..5b06cc7f11a 100644 --- a/doc/misc/eudc.texi +++ b/doc/misc/eudc.texi @@ -12,7 +12,7 @@ EUDC is the Emacs Unified Directory Client, a common interface to directory servers using various protocols such as LDAP or the CCSO white pages directory system (PH/QI) -Copyright @copyright{} 1998, 2000-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1998, 2000--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -23,8 +23,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -36,8 +35,8 @@ developing GNU and promoting software freedom.'' @footnotestyle end @titlepage -@title{EUDC Manual} -@subtitle{The Emacs Unified Directory Client} +@title EUDC Manual +@subtitle The Emacs Unified Directory Client @author by Oscar Figueiredo @code{1.30b} @@ -49,9 +48,8 @@ developing GNU and promoting software freedom.'' @contents @ifnottex -@node Top, Overview, (dir), (dir) +@node Top @top Emacs Unified Directory Client -@comment node-name, next, previous, up @insertcopying @end ifnottex @@ -70,8 +68,7 @@ developing GNU and promoting software freedom.'' -@node Overview, Installation, Top, Top -@comment node-name, next, previous, up +@node Overview @chapter Overview EUDC, the @dfn{Emacs Unified Directory Client}, provides a common user @@ -116,8 +113,7 @@ Interface to BBDB to let you insert server records into your own BBDB database -@node LDAP, CCSO PH/QI, Overview, Overview -@comment node-name, next, previous, up +@node LDAP @section LDAP LDAP, @dfn{the Lightweight Directory Access Protocol}, is a communication @@ -143,8 +139,7 @@ EUDC requires external support to access LDAP directory servers (@pxref{LDAP Requirements}) -@node CCSO PH/QI, BBDB, LDAP, Overview -@comment node-name, next, previous, up +@node CCSO PH/QI @section CCSO PH/QI The Central Computing Services Office (CCSO) of the University of @@ -165,8 +160,7 @@ possible to change records in the database. This is not implemented in EUDC. -@node BBDB, , CCSO PH/QI, Overview -@comment node-name, next, previous, up +@node BBDB @section BBDB BBDB is the @dfn{Big Brother's Insidious Database}, a package for Emacs @@ -188,8 +182,7 @@ performing queries on multiple servers. EUDC also offers a means to insert results from directory queries into your own local BBDB (@pxref{Creating BBDB Records}) -@node Installation, Usage, Overview, Top -@comment node-name, next, previous, up +@node Installation @chapter Installation Add the following to your @file{.emacs} init file: @@ -219,8 +212,7 @@ email composition buffers (@pxref{Inline Query Expansion}) * LDAP Requirements:: EUDC needs external support for LDAP @end menu -@node LDAP Requirements, , Installation, Installation -@comment node-name, next, previous, up +@node LDAP Requirements @section LDAP Requirements LDAP support is added by means of @file{ldap.el}, which is part of Emacs. @@ -229,8 +221,7 @@ LDAP support is added by means of @file{ldap.el}, which is part of Emacs. (@url{http://www.openldap.org/}). -@node Usage, Credits, Installation, Top -@comment node-name, next, previous, up +@node Usage @chapter Usage This chapter describes the usage of EUDC@. Most functions and @@ -249,8 +240,7 @@ submenu of the @samp{Tools} submenu. @end menu -@node Querying Servers, Query Form, Usage, Usage -@comment node-name, next, previous, up +@node Querying Servers @section Querying Servers EUDC's basic functionality is to let you query a directory server and @@ -264,7 +254,7 @@ to customize in this process. * Duplicate Attributes:: What to do when records have duplicate attributes @end menu -@node Selecting a Server, Return Attributes, Querying Servers, Querying Servers +@node Selecting a Server @subsection Selecting a Server Before doing any query you will need to set the directory server. You @@ -303,7 +293,7 @@ This command accessible from @samp{New Server} submenu lets you specify a new directory server and protocol. @end deffn -@node Return Attributes, Duplicate Attributes, Selecting a Server, Querying Servers +@node Return Attributes @subsection Return Attributes Directory servers may be configured to return a default set of @@ -327,7 +317,7 @@ If non-@code{nil}, entries that do not contain all the requested return attributes are ignored. Default is @code{t}. @end defopt -@node Duplicate Attributes, , Return Attributes, Querying Servers +@node Duplicate Attributes @subsection Duplicate Attributes Directory standards may authorize different instances of the same @@ -382,8 +372,7 @@ to all attribute names. Available methods are: @code{list}, -@node Query Form, Display of Query Results, Querying Servers, Usage -@comment node-name, next, previous, up +@node Query Form @section Query Form The simplest way to query your directory server is to use the query @@ -437,8 +426,7 @@ Otherwise, directory query/response forms display the user attribute names defined in @code{eudc-user-attribute-names-alist}. @end defvar -@node Display of Query Results, Inline Query Expansion, Query Form, Usage -@comment node-name, next, previous, up +@node Display of Query Results @section Display of Query Results Upon successful completion of a form query, EUDC will display a buffer @@ -515,8 +503,7 @@ be passed to the program. @end defvar -@node Inline Query Expansion, The Server Hotlist, Display of Query Results, Usage -@comment node-name, next, previous, up +@node Inline Query Expansion @section Inline Query Expansion Inline query expansion is a powerful method to get completion from your @@ -616,8 +603,7 @@ Default is @code{select} -@node The Server Hotlist, Multi-server Queries, Inline Query Expansion, Usage -@comment node-name, next, previous, up +@node The Server Hotlist @section The Server Hotlist EUDC lets you maintain a list of frequently used servers so that you @@ -655,8 +641,7 @@ loaded. * The Hotlist Edit Buffer:: An interactive hotlist editing facility @end menu -@node The Hotlist Edit Buffer, , The Server Hotlist, The Server Hotlist -@comment node-name, next, previous, up +@node The Hotlist Edit Buffer @subsection The Hotlist Edit Buffer The hotlist edit buffer offers a means to manage a list of frequently @@ -692,8 +677,7 @@ Save the changes and quit the hotlist edit buffer. Use @kbd{x} or @end deffn -@node Multi-server Queries, Creating BBDB Records, The Server Hotlist, Usage -@comment node-name, next, previous, up +@node Multi-server Queries @section Multi-server Queries When using inline query expansion (@pxref{Inline Query Expansion}), EUDC @@ -724,8 +708,7 @@ that all available servers should be tried. -@node Creating BBDB Records, Server/Protocol Locals, Multi-server Queries, Usage -@comment node-name, next, previous, up +@node Creating BBDB Records @section Creating BBDB Records @findex eudc-insert-record-at-point-into-bbdb @@ -840,8 +823,7 @@ Note that only a subset of the attributes you selected with actually be inserted as part of the newly created BBDB record. -@node Server/Protocol Locals, , Creating BBDB Records, Usage -@comment node-name, next, previous, up +@node Server/Protocol Locals @section Server/Protocol Locals EUDC can be customized independently for each server or directory @@ -853,8 +835,7 @@ like buffer-local bindings but on a per server or per protocol basis. * Manipulating local bindings:: Functions to set and query local bindings @end menu -@node Manipulating local bindings, , Server/Protocol Locals, Server/Protocol Locals -@comment node-name, next, previous, up +@node Manipulating local bindings @subsection Manipulating local bindings EUDC offers functions that let you set and query variables on a per @@ -931,8 +912,7 @@ Update all EUDC variables according to their local settings. -@node Credits, GNU Free Documentation License, Usage, Top -@comment node-name, next, previous, up +@node Credits @chapter Credits EUDC was written by Oscar Figueiredo based on @file{ph.el} by the @@ -941,18 +921,16 @@ same author. Thanks to Soren Dayton for his suggestions, his enthusiasm and his help in testing and proofreading the code and docs of @file{ph.el}. -@node GNU Free Documentation License, Command and Function Index, Credits, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Command and Function Index, Variables Index, GNU Free Documentation License, Top -@comment node-name, next, previous, up +@node Command and Function Index @unnumbered Command and Function Index @printindex fn -@node Variables Index, , Command and Function Index, Top -@comment node-name, next, previous, up +@node Variables Index @unnumbered Variables Index @printindex vr diff --git a/doc/misc/faq.texi b/doc/misc/faq.texi index ec0d6bfe4cc..8f3c0c2d623 100644 --- a/doc/misc/faq.texi +++ b/doc/misc/faq.texi @@ -11,7 +11,7 @@ @c appreciate a notice if you do). @copying -Copyright @copyright{} 2001-2012 Free Software Foundation, Inc.@* +Copyright @copyright{} 2001--2013 Free Software Foundation, Inc.@* Copyright @copyright{} 1994, 1995, 1996, 1997, 1998, 1999, 2000 Reuven M. Lerner@* Copyright @copyright{} 1992, 1993 Steven Byrnes@* @@ -2738,7 +2738,7 @@ type @kbd{C-h C-p} to read it. Old versions (i.e., anything before 19.29) of Emacs had problems editing files larger than 8 megabytes. In versions 19.29 and later, the maximum -buffer size is at least 2^27-1, or 134,217,727 bytes, or 132 MBytes. +buffer size is at least 2^27@minus{}1, or 134,217,727 bytes, or 132 MBytes. The maximum buffer size on 32-bit machines increased to 256 MBytes in Emacs 22, and again to 512 MBytes in Emacs 23.2. diff --git a/doc/misc/flymake.texi b/doc/misc/flymake.texi index e82bfdfa6c5..1807f108e3b 100644 --- a/doc/misc/flymake.texi +++ b/doc/misc/flymake.texi @@ -11,8 +11,7 @@ This manual is for GNU Flymake (version @value{VERSION}, @value{UPDATED}), which is a universal on-the-fly syntax checker for GNU Emacs. -Copyright @copyright{} 2004-2012 -Free Software Foundation, Inc. +Copyright @copyright{} 2004--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -23,8 +22,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -357,8 +355,8 @@ Which fringe (if any) should show the warning/error bitmaps. @cindex Adding support for a new syntax check tool @menu -* Example -- Configuring a tool called directly:: -* Example -- Configuring a tool called via make:: +* Example---Configuring a tool called directly:: +* Example---Configuring a tool called via make:: @end menu Syntax check tools are configured using the @@ -408,8 +406,8 @@ the @code{flymake-err-line-patterns} list. The following sections contain some examples of configuring Flymake support for various syntax check tools. -@node Example -- Configuring a tool called directly -@subsection Example -- Configuring a tool called directly +@node Example---Configuring a tool called directly +@subsection Example---Configuring a tool called directly @cindex Adding support for perl In this example, we will add support for @code{perl} as a syntax check @@ -457,8 +455,8 @@ Finally, we add an entry to @code{flymake-err-line-patterns}: flymake-err-line-patterns)) @end lisp -@node Example -- Configuring a tool called via make -@subsection Example -- Configuring a tool called via make +@node Example---Configuring a tool called via make +@subsection Example---Configuring a tool called via make @cindex Adding support for C (gcc+make) In this example we will add support for C files syntax checked by @@ -530,7 +528,7 @@ check-syntax: Syntax check is started by calling @code{flymake-start-syntax-check-for-current-buffer}. Flymake first determines whether it is able to do syntax check. It then saves a copy of the buffer in a temporary file in the -buffer's directory (or in the system temp directory -- for java +buffer's directory (or in the system temp directory, for java files), creates a syntax check command and launches a process with this command. The output is parsed using a list of error message patterns, and error information (file name, line number, type and text) is diff --git a/doc/misc/forms.texi b/doc/misc/forms.texi index 7f84de9754b..43ffab26c9b 100644 --- a/doc/misc/forms.texi +++ b/doc/misc/forms.texi @@ -18,7 +18,7 @@ @copying This file documents Forms mode, a form-editing major mode for GNU Emacs. -Copyright @copyright{} 1989, 1997, 2001-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1989, 1997, 2001--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -29,8 +29,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -88,8 +87,8 @@ how to present it. * Miscellaneous:: Forms mode messages and other remarks. * Error Messages:: List of error messages forms mode can produce. * Long Example:: A more complex control file example. -* GNU Free Documentation License:: The license for this documentation. * Credits:: Thanks everyone. +* GNU Free Documentation License:: The license for this documentation. * Index:: Index to this manual. @end menu @end ifnottex diff --git a/doc/misc/gnus-coding.texi b/doc/misc/gnus-coding.texi index 2bc064071ec..15393ad8032 100644 --- a/doc/misc/gnus-coding.texi +++ b/doc/misc/gnus-coding.texi @@ -7,26 +7,19 @@ @syncodeindex pg cp @copying -Copyright @copyright{} 2004-2005, 2007-2012 Free Software +Copyright @copyright{} 2004--2005, 2007--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no -Invariant Sections, with the Front-Cover texts being ``A GNU -Manual'', and with the Back-Cover Texts as in (a) below. A copy of the -license is included in the section entitled ``GNU Free Documentation -License'' in the Gnus manual. +Invariant Sections, with the Front-Cover texts being ``A GNU Manual'', +and with the Back-Cover Texts as in (a) below. A copy of the license +is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' - -This document is part of a collection distributed under the GNU Free -Documentation License. If you want to distribute this document -separately from the collection, you can do so by adding a copy of the -license to the document, as described in section 6 of the license. +modify this GNU manual.'' @end quotation @end copying @@ -54,6 +47,7 @@ This manual describes @dots{} @menu * Gnus Coding Style:: Gnus Coding Style * Gnus Maintenance Guide:: Gnus Maintenance Guide +* GNU Free Documentation License:: The license for this documentation. @end menu @c @ref{Gnus Reference Guide, ,Gnus Reference Guide, gnus, The Gnus Newsreader} @@ -306,7 +300,7 @@ reason. @c (typically so far the only exception has been that the changes @c already exist in the trunk in modified form). Because of this, when the next major version of Gnus will be included in -Emacs, it should be very easy -- just plonk in the files from the Gnus +Emacs, it should be very easy---just plonk in the files from the Gnus trunk without worrying about lost changes from the Emacs tree. The effect of this is that as hacker, you should generally only have to @@ -320,7 +314,7 @@ tree, and it will show up in the Gnus tree a few days later. If you don't have Emacs bzr access (or it's inconvenient), you can change such a file in the v5-10 branch, and it should propagate to Emacs -bzr -- however, it will get some extra scrutiny (by Miles) to see if the +bzr---however, it will get some extra scrutiny (by Miles) to see if the changes are possibly controversial and need discussion on the mailing list. Many changes are obvious bug-fixes however, so often there won't be any problem. @@ -335,7 +329,7 @@ including improvements on the documentation. If you know that there will be conflicts (perhaps because the affected source code is different in v5-10 and the Gnus git trunk), then you can install your change in both places, and when I try to sync them, there -will be a conflict -- however, since in most such cases there would be a +will be a conflict---however, since in most such cases there would be a conflict @emph{anyway}, it's often easier for me to resolve it simply if I see two @samp{identical} changes, and can just choose the proper one, rather than having to actually fix the code. @@ -387,6 +381,10 @@ If the variable is new in No Gnus use @code{:version "23.1" ;; No Gnus}. The same applies for customizable variables when its default value was changed. +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + @c Local Variables: @c mode: texinfo @c coding: iso-8859-1 diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi index 038b78cced3..2a1f5ac2cc1 100644 --- a/doc/misc/gnus-faq.texi +++ b/doc/misc/gnus-faq.texi @@ -1,7 +1,7 @@ @c \input texinfo @c -*-texinfo-*- @c Uncomment 1st line before texing this file alone. @c %**start of header -@c Copyright (C) 1995, 2001-2012 Free Software Foundation, Inc. +@c Copyright (C) 1995, 2001-2013 Free Software Foundation, Inc. @c @setfilename gnus-faq.info @settitle Frequently Asked Questions @@ -80,7 +80,7 @@ want. This FAQ was maintained by Justin Sheehy until March 2002. He would like to thank Steve Baur and Per Abrahamsen for doing a wonderful -job with this FAQ before him. We would like to do the same - thanks, +job with this FAQ before him. We would like to do the same: thanks, Justin! This version is much nicer than the unofficial hypertext @@ -1038,7 +1038,7 @@ mail groups. Is this a bug? No, that's a matter of design of Gnus, fixing this would mean reimplementation of major parts of Gnus' -back ends. Gnus thinks "highest-article-number - +back ends. Gnus thinks "highest-article-number @minus{} lowest-article-number = total-number-of-articles". This works OK for Usenet groups, but if you delete and move many messages in mail groups, this fails. To cure the diff --git a/doc/misc/gnus-news.el b/doc/misc/gnus-news.el index 0c083c85a4d..ff082e4ecf0 100644 --- a/doc/misc/gnus-news.el +++ b/doc/misc/gnus-news.el @@ -1,5 +1,5 @@ ;;; gnus-news.el --- a hack to create GNUS-NEWS from texinfo source -;; Copyright (C) 2004-2012 Free Software Foundation, Inc. +;; Copyright (C) 2004-2013 Free Software Foundation, Inc. ;; Author: Reiner Steib <Reiner.Steib@gmx.de> ;; Keywords: tools @@ -26,7 +26,7 @@ (defvar gnus-news-header-disclaimer "GNUS NEWS -- history of user-visible changes. -Copyright (C) 1999-2012 Free Software Foundation, Inc. +Copyright (C) 1999-2013 Free Software Foundation, Inc. See the end of the file for license conditions. Please send Gnus bug reports to bugs@gnus.org. diff --git a/doc/misc/gnus-news.texi b/doc/misc/gnus-news.texi index 19bbe01667c..9c1ecb19748 100644 --- a/doc/misc/gnus-news.texi +++ b/doc/misc/gnus-news.texi @@ -1,6 +1,6 @@ @c -*-texinfo-*- -@c Copyright (C) 2004-2012 Free Software Foundation, Inc. +@c Copyright (C) 2004-2013 Free Software Foundation, Inc. @c Permission is granted to anyone to make or distribute verbatim copies @c of this document as received, in any medium, provided that the diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index dfc422479e3..b5029e5d6a8 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi @@ -11,7 +11,7 @@ @documentencoding UTF-8 @copying -Copyright @copyright{} 1995-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1995--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -22,8 +22,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -1297,7 +1296,7 @@ subscribing these groups. variable defaults to @code{gnus-subscribe-alphabetically}. The ``options -n'' format is very simplistic. The syntax above is all -that is supports -- you can force-subscribe hierarchies, or you can +that is supports: you can force-subscribe hierarchies, or you can deny hierarchies, and that's it. @vindex gnus-options-not-subscribe @@ -2144,14 +2143,14 @@ In groups in some news servers, there might be a big gap between a few very old articles that will never be expired and the recent ones. In such a case, the server will return the data like @code{(1 . 30000000)} for the @code{LIST ACTIVE group} command, for example. Even if there -are actually only the articles 1-10 and 29999900-30000000, Gnus doesn't +are actually only the articles 1--10 and 29999900--30000000, Gnus doesn't know it at first and prepares for getting 30000000 articles. However, it will consume hundreds megabytes of memories and might make Emacs get stuck as the case may be. If you use such news servers, set the variable @code{gnus-newsgroup-maximum-articles} to a positive number. The value means that Gnus ignores articles other than this number of the latest ones in every group. For instance, the value 10000 makes Gnus -get only the articles 29990001-30000000 (if the latest article number is +get only the articles 29990001--30000000 (if the latest article number is 30000000 in a group). Note that setting this variable to a number might prevent you from reading very old articles. The default value of the variable @code{gnus-newsgroup-maximum-articles} is @code{nil}, which @@ -3646,6 +3645,15 @@ Describe the current group (@code{gnus-browse-describe-group}). @findex gnus-browse-describe-briefly Describe browse mode briefly (well, there's not much to describe, is there) (@code{gnus-browse-describe-briefly}). + +@item DEL +@kindex DEL (Browse) +@findex gnus-browse-delete-group +This function will delete the current group +(@code{gnus-browse-delete-group}). If given a prefix, this function +will actually delete all the articles in the group, and forcibly +remove the group itself from the face of the Earth. Use a prefix only +if you are absolutely sure of what you are doing. @end table @@ -3824,7 +3832,7 @@ So, to move a topic to the beginning of the list of topics, just hit @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then, move the cursor to the beginning of the buffer (just below the ``Gnus'' topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and -paste. Like I said -- E-Z. +paste. Like I said---E-Z. You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So you can move topics around as well as groups. @@ -13666,7 +13674,7 @@ server. The default value of this variable is @code{("XOVER" @vindex nntp-nov-gap @code{nntp} normally sends just one big request for @acronym{NOV} lines to the server. The server responds with one huge list of lines. However, -if you have read articles 2-5000 in the group, and only want to read +if you have read articles 2--5000 in the group, and only want to read article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV} lines that you will not need. This variable says how big a gap between two consecutive articles is allowed to be before the @@ -14200,7 +14208,11 @@ what you need. @item nnimap-authenticator Some @acronym{IMAP} servers allow anonymous logins. In that case, -this should be set to @code{anonymous}. +this should be set to @code{anonymous}. If this variable isn't set, +the normal login methods will be used. If you wish to specify a +specific login method to be used, you can set this variable to either +@code{login} (the traditional @acronym{IMAP} login method), +@code{plain} or @code{cram-md5}. @item nnimap-expunge If non-@code{nil}, expunge articles after deleting them. This is always done @@ -15962,7 +15974,7 @@ Decode Quoted Readable encoding. If you are a member of a couple of mailing lists, you will sometimes receive two copies of the same mail. This can be quite annoying, so @code{nnmail} checks for and treats any duplicates it might find. To do -this, it keeps a cache of old @code{Message-ID}s--- +this, it keeps a cache of old @code{Message-ID}s: @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by default. The approximate maximum number of @code{Message-ID}s stored there is controlled by the @code{nnmail-message-id-cache-length} @@ -16626,8 +16638,8 @@ future. Here are some high and low points on each: @table @code @item nnmbox -UNIX systems have historically had a single, very common, and well- -defined format. All messages arrive in a single @dfn{spool file}, and +UNIX systems have historically had a single, very common, and well-defined +format. All messages arrive in a single @dfn{spool file}, and they are delineated by a line whose regular expression matches @samp{^From_}. (My notational use of @samp{_} is to indicate a space, to make it clear in this instance that this is not the RFC-specified @@ -21174,7 +21186,7 @@ features (inspired by the Google search input language): AND, OR, and NOT are supported, and parentheses can be used to control operator precedence, e.g., (emacs OR xemacs) AND linux. Note that operators must be written with all capital letters to be -recognized. Also preceding a term with a - sign is equivalent to NOT +recognized. Also preceding a term with a @minus{} sign is equivalent to NOT term. @item Automatic AND queries @@ -21222,7 +21234,8 @@ Note that operators must be written with all capital letters to be recognized. @item Required and excluded terms -+ and - can be used to require or exclude terms, e.g., football -american ++ and @minus{} can be used to require or exclude terms, e.g., football +@minus{}american @item Unicode handling The search engine converts all text to utf-8, so searching should work @@ -21359,7 +21372,7 @@ This engine is obsolete. @table @code @item nnir-method-default-engines -Alist of server backend - search engine pairs. The default associations +Alist of pairs of server backends and search engines. The default associations are @example (nnimap . imap) @@ -22574,7 +22587,7 @@ configuration function will use @code{group} as the key. A full list of possible names is listed below. The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer -should occupy. To take the @code{article} split as an example - +should occupy. To take the @code{article} split as an example: @lisp (article (vertical 1.0 (summary 0.25 point) @@ -26351,9 +26364,9 @@ with the information when possible). On the January 31th 2012, Ma Gnus was begun. -If you happen upon a version of Gnus that has a prefixed name -- -``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'', -``Pterodactyl Gnus'', ``Oort Gnus'', ``No Gnus'', ``Ma Gnus'' -- don't +If you happen upon a version of Gnus that has a prefixed name---``(ding) +Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'', +``Pterodactyl Gnus'', ``Oort Gnus'', ``No Gnus'', ``Ma Gnus''---don't panic. Don't let it know that you're frightened. Back away. Slowly. Whatever you do, don't run. Walk away, calmly, until you're out of its reach. Find a proper released version of Gnus and snuggle up to @@ -26500,14 +26513,14 @@ on Son-of-RFC 1036. They have produced a number of drafts proposing various changes to the format of news articles. The Gnus towers will look into implementing the changes when the draft is accepted as an RFC. -@item MIME - RFC 2045-2049 etc +@item MIME---RFC 2045--2049 etc @cindex @acronym{MIME} All the various @acronym{MIME} RFCs are supported. -@item Disposition Notifications - RFC 2298 +@item Disposition Notifications---RFC 2298 Message Mode is able to request notifications from the receiver. -@item PGP - RFC 1991 and RFC 2440 +@item PGP---RFC 1991 and RFC 2440 @cindex RFC 1991 @cindex RFC 2440 RFC 1991 is the original @acronym{PGP} message specification, @@ -26517,15 +26530,15 @@ non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both encoding (signing and encryption) and decoding (verification and decryption). -@item PGP/MIME - RFC 2015/3156 +@item PGP/MIME---RFC 2015/3156 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC 1991) describes the @acronym{MIME}-wrapping around the RFC 1991/2440 format. Gnus supports both encoding and decoding. -@item S/MIME - RFC 2633 +@item S/MIME---RFC 2633 RFC 2633 describes the @acronym{S/MIME} format. -@item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731 +@item IMAP---RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5 authentication for @acronym{IMAP}. RFC 2086 describes access control @@ -26580,7 +26593,7 @@ circles) @dfn{snapshots}. During this phase, Gnus is assumed to be unstable and should not be used by casual users. Gnus alpha releases have names like ``Oort Gnus'' and ``No Gnus''. @xref{Gnus Versions}. -After futzing around for 10-100 alpha releases, Gnus is declared +After futzing around for 10--100 alpha releases, Gnus is declared @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix, and is called things like ``Gnus 5.10.1'' instead. Normal people are supposed to be able to use these, and these are mostly discussed on the @@ -28167,7 +28180,7 @@ The behavior can be changed by customizing @code{message-insert-canlock}. @item Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC -2015/3156) and @acronym{S/MIME} (RFC 2630-2633). +2015/3156) and @acronym{S/MIME} (RFC 2630--2633). It needs an external @acronym{S/MIME} and OpenPGP implementation, but no additional Lisp libraries. This add several menu items to the @@ -28586,10 +28599,10 @@ know that the server makes wrong @acronym{NOV} data. @item level @cindex levels -Each group is subscribed at some @dfn{level} or other (1-9). The ones +Each group is subscribed at some @dfn{level} or other (1--9). The ones that have a lower level are ``more'' subscribed than the groups with a -higher level. In fact, groups on levels 1-5 are considered -@dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9 +higher level. In fact, groups on levels 1--5 are considered +@dfn{subscribed}; 6--7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9 are @dfn{killed}. Commands for listing groups and scanning for new articles will all use the numeric prefix as @dfn{working level}. @@ -29165,8 +29178,8 @@ return value. Some back ends could be said to be @dfn{server-forming} back ends, and some might be said not to be. The latter are back ends that generally -only operate on one group at a time, and have no concept of ``server'' ----they have a group, and they deliver info on that group and nothing +only operate on one group at a time, and have no concept of ``server''; +they have a group, and they deliver info on that group and nothing more. Gnus identifies each message by way of group name and article number. A diff --git a/doc/misc/htmlfontify.texi b/doc/misc/htmlfontify.texi new file mode 100644 index 00000000000..911cdd3cd5f --- /dev/null +++ b/doc/misc/htmlfontify.texi @@ -0,0 +1,1612 @@ +\input texinfo +@comment %**start of header +@setfilename ../../info/htmlfontify +@settitle Htmlfontify User Manual +@exampleindent 2 +@comment %**end of header + +@copying +This manual documents Htmlfontify, a source code -> crosslinked + +formatted + syntax colorised html transformer. + +Copyright @copyright{} 2002, 2003, 2013 Free Software Foundation, Inc. + +@quotation +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' +and with the Back-Cover Texts as in (a) below. A copy of the license +is included in the section entitled ``GNU Free Documentation License''. + +(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and +modify this GNU manual.'' +@end quotation +@end copying + +@dircategory Emacs misc features +@direntry +* Htmlfontify: (htmlfontify). Convert source code to html. +@end direntry + +@titlepage +@title Htmlfontify User Manual +@sp 4 +@subtitle Htmlfontify version 0.20 +@sp 1 +@subtitle Jun 2002 +@sp 5 +@author Vivek Dasmohapatra +@page + +@vskip 0pt plus 1filll +@noindent +@insertcopying +@end titlepage + +@contents + +@ifnottex +@node Top +@top Htmlfontify + +@insertcopying +@end ifnottex + +@menu +* Introduction:: About Htmlfontify. +* Usage & Examples:: How to use Htmlfontify. +* Customisation:: Fine-tuning Htmlfontify's behaviour. +* Requirements:: External programs used by Htmlfontify. +* GNU Free Documentation License:: The license for this documentation. +* Index:: Index of contents. +@end menu + +@node Introduction +@chapter Introduction +@cindex Introduction + +Htmlfontify provides a means of converting individual Emacs buffers, +source files, or entire source trees to html, preserving formatting +and Emacs colorisation / syntax highlighting as much as possible +through careful application of CSS stylesheets and html tags. + +It can also turn instances of functions, methods and (for some +languages) variables and other constructs and items into links +to their definitions, and create an index file (or files) of +all such symbols, also linked to their points of definition. + +Htmlfontify also provides several customisation items, which should +allow it to mesh more-or-less seamlessly with various templating or +publishing systems (in the event, for instance, that you don't want +to produce the html pages directly). + +@node Usage & Examples +@chapter Usage & Examples +@cindex Usage & Examples + +Htmlfontify can be used both interactively and as part of another +elisp function. If you're running it in a modern Emacs, it will also +run when attached to a terminal (i.e., without X) or even when in +batch mode. + +@menu +* Interactive:: Using Htmlfontify interactively. +* Non-interactive:: Using Htmlfontify from elisp. +* Variables:: Variables (other than customisation entries). +* Data Structures:: Important data structures. +* Examples:: Example(s) of Htmlfontify in use. +@end menu + +@node Interactive +@section Interactive +@cindex Interactive +@cindex functions (interactive) + +Htmlfontify provides the following interactive functions: + +@table @code +@item htmlfontify-buffer +@findex htmlfontify-buffer +@anchor{htmlfontify-buffer} + +@lisp + +(htmlfontify-buffer &optional @var{srcdir} @var{file}) +@end lisp + +Create a new buffer, named for the current buffer + a .html extension, +containing an inline CSS-stylesheet and formatted CSS-markup html that +reproduces the look of the current Emacs buffer as closely as possible. + +``Dangerous'' characters in the existing buffer are turned into html +entities, so you should even be able to do html-within-html fontified +display. + +You should, however, note that random control or eight-bit characters +such as ^L (\x0c) or ¤ (\xa4) won't get mapped yet. + +If the @var{srcdir} and @var{file} arguments are set, lookup etags +derived entries in the @ref{hfy-tags-cache} and add html anchors +and hyperlinks as appropriate. + +@item htmlfontify-run-etags +@findex htmlfontify-run-etags +@anchor{htmlfontify-run-etags} + +@lisp + +(htmlfontify-run-etags @var{srcdir}) +@end lisp + +Load the etags cache for @var{srcdir}. See @ref{hfy-load-tags-cache}. + +@item htmlfontify-copy-and-link-dir +@findex htmlfontify-copy-and-link-dir +@anchor{htmlfontify-copy-and-link-dir} + +@lisp + +(htmlfontify-copy-and-link-dir @var{srcdir} @var{dstdir} &optional @var{f-ext} @var{l-ext}) +@end lisp + +Trawl @var{srcdir} and write fontified-and-hyperlinked output in +@var{dstdir}. @var{f-ext} and @var{l-ext} specify values for +@ref{hfy-extn} and @ref{hfy-link-extn}. + +You may also want to set @ref{hfy-page-header} and @ref{hfy-page-footer}. + +@item htmlfontify-load-rgb-file +@findex htmlfontify-load-rgb-file +@anchor{htmlfontify-load-rgb-file} + +@lisp + +(htmlfontify-load-rgb-file &optional @var{file}) +@end lisp + +Load an X11 style rgb.txt file (search @code{hfy-rgb-load-path} if +@var{file} is not specified). + +Note that this is not necessary if all you want is the standard X11 +(XFree86 4.1.0) color name -> rgb triplet mapping. Htmlfontify has +a copy built in, for use when it cannot contact an X server. + +Loads the variable @code{hfy-rgb-txt-color-map}, which is used by +@ref{hfy-fallback-color-values}. + +@item htmlfontify-unload-rgb-file +@findex htmlfontify-unload-rgb-file +@anchor{htmlfontify-unload-rgb-file} + +@lisp + +(htmlfontify-unload-rgb-file) +@end lisp + +Unload the currently loaded X11 style rgb.txt file (if any). +@end table + +@node Non-interactive +@section Non-interactive +@cindex Noninteractive +@cindex functions (noninteractive) + +In addition to the aforementioned interactive methods, Htmlfontify +provides the following non-interactive ones: + +@table @code +@comment AUTOGENERATED BLOCK + +@item hfy-face-to-style +@findex hfy-face-to-style +@anchor{hfy-face-to-style} + +@lisp + +(hfy-face-to-style @var{fn}) +@end lisp + +Take @var{fn}, a font or @code{defface} style font specification, +(as returned by @code{face-attr-construct} or @ref{hfy-face-attr-for-class}) +and return a @ref{hfy-style-assoc}. + +See also: @ref{hfy-face-to-style-i}, @ref{hfy-flatten-style}. + +@item hfy-fallback-color-values +@findex hfy-fallback-color-values +@anchor{hfy-fallback-color-values} + +@lisp + +(hfy-fallback-color-values @var{color-string}) +@end lisp + +Use a fallback method for obtaining the rgb values for a color. +If @ref{htmlfontify-load-rgb-file} has been called, it uses the +color map specified, otherwise it uses Htmlfontify's built in map. + +@item hfy-combined-face-spec +@findex hfy-combined-face-spec +@anchor{hfy-combined-face-spec} + +@lisp + +(hfy-combined-face-spec @var{face}) +@end lisp + +Return a @code{defface} style alist of possible specifications for +@var{face}, with any entries resulting from user customisation +(@code{custom-set-faces}) taking precedence. + +See also: @ref{hfy-default-face-def} + +@item hfy-word-regex +@findex hfy-word-regex +@anchor{hfy-word-regex} + +@lisp + +(hfy-word-regex @var{string}) +@end lisp + +Return a regex that matches @var{string} as the first @code{match-string}, +with non word characters on either side (vaguely emulating the perl @code{\b} +regex atom). + +@item hfy-force-fontification +@findex hfy-force-fontification +@anchor{hfy-force-fontification} + +@lisp + +(hfy-force-fontification) +@end lisp + +Emacs's fontification is designed for interactive use. As such, it sometimes +does things like deferring fontification until a section of the buffer is +exposed and rendered, or until Emacs is idle for a while. Sometimes, in +non-interactive circumstances, or if it can't see X, it doesn't bother +with some of the harder stuff. While this is all great from the perspective +of a user waiting for Emacs to load a 20000 line file and colorise it, +it's a pain from the point of view from non-interactive code. This function +lies, cheats, steals and generally bullies Emacs into fontifying a buffer +from start to finish, with all the extra frills, whether it thinks it nneds +to or not. Oh yes: it operates on the current buffer. + +@item hfy-link-style-string +@findex hfy-link-style-string +@anchor{hfy-link-style-string} + +@lisp + +(hfy-link-style-string @var{style-string}) +@end lisp + +Replace the end of a CSS style declaration @var{style-string} with the contents +of the variable @ref{hfy-src-doc-link-style}, removing text matching the +regex @ref{hfy-src-doc-link-unstyle} first, if necessary. + + +@item hfy-prepare-index-i +@findex hfy-prepare-index-i +@anchor{hfy-prepare-index-i} + +@lisp + +(hfy-prepare-index-i @var{srcdir} @var{dstdir} @var{filename} &optional @var{stub} @var{map}) +@end lisp + +Prepare a tags index buffer for @var{srcdir}. +@ref{hfy-tags-cache} must already have an entry for @var{srcdir} for +this to work. @ref{hfy-page-header}, @ref{hfy-page-footer}, +@ref{hfy-link-extn} and @ref{hfy-extn} all play a part here. + +If @var{stub} is set, prepare an (appropriately named) index buffer +specifically for entries beginning with @var{stub}. + +If @var{map} is set, use that instead of @ref{hfy-tags-cache}. + +@item hfy-compile-stylesheet +@findex hfy-compile-stylesheet +@anchor{hfy-compile-stylesheet} + +@lisp + +(hfy-compile-stylesheet) +@end lisp + +Trawl the current buffer, construct and return a @ref{hfy-sheet-assoc}. + +@item hfy-css-name +@findex hfy-css-name +@anchor{hfy-css-name} + +@lisp + +(hfy-css-name @var{fn}) +@end lisp + +Strip some of the boring bits from a font-name and return a CSS style +name. If @var{fn} is a @code{defface} attribute list, either construct +a name for it, store it in the cache, and return it, or just fetch it +from the cache if it's already there. + +@item hfy-make-directory +@findex hfy-make-directory +@anchor{hfy-make-directory} + +@lisp + +(hfy-make-directory @var{dir}) +@end lisp + +Approximate equivalent of @code{mkdir -p @var{dir}}. + +@item hfy-triplet +@findex hfy-triplet +@anchor{hfy-triplet} + +@lisp + +(hfy-triplet @var{color}) +@end lisp + +Takes a color name (string) and return a CSS rgb(R, G, B) triplet string. +Uses the definition of ``white'' to map the numbers to the 0-255 range, so +if you've redefined white, (especially if you've redefined it to have +a triplet member lower than that of the color you are processing, +strange things may happen). + +@item hfy-default-footer +@findex hfy-default-footer +@anchor{hfy-default-footer} + +@lisp + +(hfy-default-footer @var{file}) +@end lisp + +Default value for @ref{hfy-page-footer} + +@item hfy-list-files +@findex hfy-list-files +@anchor{hfy-list-files} + +@lisp + +(hfy-list-files @var{directory}) +@end lisp + +Return a list of files under @var{directory}. +Strips any leading @samp{./} from each filename. + +@item hfy-color-vals +@findex hfy-color-vals +@anchor{hfy-color-vals} + +@lisp + +(hfy-color-vals @var{color}) +@end lisp + +Where @var{color} is a color name or #XXXXXX style triplet, return a list of +3 (16 bit) rgb values for said color. If a window system is unavailable, +calls @ref{hfy-fallback-color-values}. + +@item hfy-href-stub +@findex hfy-href-stub +@anchor{hfy-href-stub} + +@lisp + +(hfy-href-stub @var{this-file} @var{def-files} @var{tag}) +@end lisp + +Return an href stub for a tag href: if @var{def-files} (list of files +containing definitions for the tag in question) contains only one entry, +the href should link straight to that file. Otherwise, the link should +be to the index file. + +We are not yet concerned with the file extensions/tag line number and +so on at this point. + +If @ref{hfy-split-index} is set, and the href will be to an index file +rather than a source file, append a @samp{.X} to @ref{hfy-index-file}, where +@samp{X} is the uppercased first character of @var{tag}. + +See also: @ref{hfy-relstub}, @ref{hfy-index-file}. + +@item hfy-line-number +@findex hfy-line-number +@anchor{hfy-line-number} + +@lisp + +(hfy-line-number) +@end lisp + +Returns the line number of the point in the current buffer. + +@item hfy-merge-adjacent-spans +@findex hfy-merge-adjacent-spans +@anchor{hfy-merge-adjacent-spans} + +@lisp + +(hfy-merge-adjacent-spans @var{face-map}) +@end lisp + +Where @var{face-map} is a @ref{hfy-facemap-assoc} for the current buffer, +this function merges adjacent style blocks which are of the same value +and are separated by nothing more interesting than whitespace. + +@code{<span class="foo">narf</span> <span class="foo">brain</span>} + +(as interpreted from @var{face-map}) would become: + +@code{<span class="foo">narf brain</span>} + +Returns a modified copy of @var{face-map} (also a @ref{hfy-facemap-assoc}). + +@item hfy-mark-tag-names +@findex hfy-mark-tag-names +@anchor{hfy-mark-tag-names} + +@lisp + +(hfy-mark-tag-names @var{srcdir} @var{file}) +@end lisp + +Mark tags in @var{file} (lookup @var{srcdir} in @ref{hfy-tags-cache}) with the +@code{hfy-anchor} property, with a value of @samp{tag.line-number}. + +@item hfy-weight +@findex hfy-weight +@anchor{hfy-weight} + +@lisp + +(hfy-weight @var{weight}) +@end lisp + +Derive a font-weight CSS specifier from an Emacs weight specification symbol. + +@item hfy-size +@findex hfy-size +@anchor{hfy-size} + +@lisp + +(hfy-size @var{height}) +@end lisp + +Derive a CSS font-size specifier from an Emacs font @code{:height} attribute. +Does not cope with the case where height is a function to be applied to +the height of the underlying font. + +@item hfy-default-header +@findex hfy-default-header +@anchor{hfy-default-header} + +@lisp + +(hfy-default-header @var{file} @var{style}) +@end lisp + +Default value for @ref{hfy-page-header} + +@item hfy-family +@findex hfy-family +@anchor{hfy-family} + +@lisp + +(hfy-family @var{family}) +@end lisp + +Derives a CSS font-family specifier from an Emacs @code{:family} attribute. + +@item hfy-mark-tag-hrefs +@findex hfy-mark-tag-hrefs +@anchor{hfy-mark-tag-hrefs} + +@lisp + +(hfy-mark-tag-hrefs @var{srcdir} @var{file}) +@end lisp + +Mark href start points with the @code{hfy-link} property (value: href string). + +Mark href end points with the @code{hfy-endl} property (value @code{t}). + +Avoid overlapping links, and mark links in descending length of +tag name in order to prevent subtags from usurping supertags; +e.g., ``term'' for ``terminal''). + +@item hfy-box +@findex hfy-box +@anchor{hfy-box} + +@lisp + +(hfy-box @var{box}) +@end lisp + +Derive CSS border-* attributes from the Emacs @code{:box} attribute. + +@item hfy-box-to-style +@findex hfy-box-to-style +@anchor{hfy-box-to-style} + +@lisp + +(hfy-box-to-style @var{spec}) +@end lisp + +Convert a complex @code{:box} Emacs font attribute set to a list of +CSS border-* attributes. Don't call this directly---it is called by +@ref{hfy-box} when necessary. + +@item hfy-html-enkludge-buffer +@findex hfy-html-enkludge-buffer +@anchor{hfy-html-enkludge-buffer} + +@lisp + +(hfy-html-enkludge-buffer) +@end lisp + +Mark dangerous @samp{["<>]} characters with the @code{hfy-quoteme} property. + +See also @ref{hfy-html-dekludge-buffer}. + +@item hfy-buffer +@findex hfy-buffer +@anchor{hfy-buffer} + +@lisp + +(hfy-buffer) +@end lisp + +Generate and return an Htmlfontify html output buffer for the current +buffer. May trample an existing buffer. + +@item hfy-fontified-p +@findex hfy-fontified-p +@anchor{hfy-fontified-p} + +@lisp + +(hfy-fontified-p) +@end lisp + +@code{font-lock} doesn't like to say a buffer's been fontified when in +batch mode, but we want to know if we should fontify or raw copy, so in +batch mode we check for non-default face properties. Otherwise we test +@code{font-lock-mode} and @code{font-lock-fontified} for truth. + +@item hfy-lookup +@findex hfy-lookup +@anchor{hfy-lookup} + +@lisp + +(hfy-lookup @var{face} @var{style}) +@end lisp + +Where @var{style} is a @ref{hfy-sheet-assoc} and @var{face} is an Emacs face, +return the relevant @var{css} style name. + +@item hfy-fontify-buffer +@findex hfy-fontify-buffer +@anchor{hfy-fontify-buffer} + +@lisp + +(hfy-fontify-buffer &optional @var{srcdir} @var{file}) +@end lisp + +Implement the guts of @ref{htmlfontify-buffer}. + +@item hfy-color +@findex hfy-color +@anchor{hfy-color} + +@lisp + +(hfy-color @var{color}) +@end lisp + +Convert an Emacs :foreground property to a CSS color property. + +@item hfy-flatten-style +@findex hfy-flatten-style +@anchor{hfy-flatten-style} + +@lisp + +(hfy-flatten-style @var{style}) +@end lisp + +Take @var{style} (see @ref{hfy-face-to-style-i}, @ref{hfy-face-to-style}) +and merge any multiple attributes appropriately. Currently only font-size is +merged down to a single occurrence---others may need special handling, but I +haven't encountered them yet. Returns a @ref{hfy-style-assoc}. + +@item hfy-size-to-int +@findex hfy-size-to-int +@anchor{hfy-size-to-int} + +@lisp + +(hfy-size-to-int @var{spec}) +@end lisp + +Convert @var{spec}, a CSS font-size specifier, back to an Emacs +@code{:height} attribute value. Used while merging multiple font-size +attributes. + +@item hfy-sprintf-stylesheet +@findex hfy-sprintf-stylesheet +@anchor{hfy-sprintf-stylesheet} + +@lisp + +(hfy-sprintf-stylesheet @var{css} @var{file}) +@end lisp + +Generates a header, via @ref{hfy-page-header}, for @var{file}, containing the +stylesheet derived from @var{css}, which is a @ref{hfy-sheet-assoc}. Returns a +string containing the same. + +@item hfy-relstub +@findex hfy-relstub +@anchor{hfy-relstub} + +@lisp + +(hfy-relstub @var{file} &optional @var{start}) +@end lisp + +Return a @samp{../} stub of the appropriate length for the current source +tree depth (as determined from @var{file}). @c iyswim. + +@item hfy-compile-face-map +@findex hfy-compile-face-map +@anchor{hfy-compile-face-map} + +@lisp + +(hfy-compile-face-map) +@end lisp + +Compile and return a @ref{hfy-facemap-assoc} for the current buffer. + +@item hfy-prepare-index +@findex hfy-prepare-index +@anchor{hfy-prepare-index} + +@lisp + +(hfy-prepare-index @var{srcdir} @var{dstdir}) +@end lisp + +Return as list of index buffer(s), as determined by @ref{hfy-split-index}. +Uses @ref{hfy-prepare-index-i} to do this. + +@item hfy-prepare-tag-map +@findex hfy-prepare-tag-map +@anchor{hfy-prepare-tag-map} + +@lisp + +(hfy-prepare-tag-map @var{srcdir} @var{dstdir}) +@end lisp + +Prepare the counterpart(s) to the index buffer(s)---a list of buffers with +the same structure, but listing (and linking to) instances of tags (as +opposed to their definitions). + +See also: @ref{hfy-prepare-index}, @ref{hfy-split-index} + +@item hfy-subtract-maps +@findex hfy-subtract-maps +@anchor{hfy-subtract-maps} + +@lisp + +(hfy-subtract-maps @var{srcdir}) +@end lisp + +Internal function---strips definitions of tags from the instance map. +See: @ref{hfy-tags-cache} and @ref{hfy-tags-rmap} + +@item hfy-face-to-style-i +@findex hfy-face-to-style-i +@anchor{hfy-face-to-style-i} + +@lisp + +(hfy-face-to-style-i @var{fn}) +@end lisp + +The guts of @ref{hfy-face-to-style}. @var{fn} should be a @code{defface} +font specification, as returned by @code{face-attr-construct} or +@ref{hfy-face-attr-for-class}. Note that this function does not get +font-sizes right if they are based on inherited modifiers (via the +:inherit) attribute, and any other modifiers that are cumulative if they +appear multiple times need to be merged by the user---@ref{hfy-flatten-style} +should do this. + +@item hfy-face-to-css +@findex hfy-face-to-css +@anchor{hfy-face-to-css} + +@lisp + +(hfy-face-to-css @var{fn}) +@end lisp + +Take @var{fn}, a font or @code{defface} specification (c.f. +@code{face-attr-construct}) and return a CSS style specification. + +See also: @ref{hfy-face-to-style} + +@item hfy-html-quote +@findex hfy-html-quote +@anchor{hfy-html-quote} + +@lisp + +(hfy-html-quote @var{char-string}) +@end lisp + +Map a string (usually 1 character long) to an html safe string +(entity) if need be. + +@item hfy-link-style +@findex hfy-link-style +@anchor{hfy-link-style} + +@lisp + +(hfy-link-style @var{style-string}) +@end lisp + +Convert the CSS style spec @var{style-string} to its equivalent +hyperlink style. + +See: @ref{hfy-link-style-fun}. + +@item hfy-p-to-face +@findex hfy-p-to-face +@anchor{hfy-p-to-face} + +@lisp + +(hfy-p-to-face @var{props}) +@end lisp + +Given @var{props}, a list of text-properties, return the value of the +face property, or nil. + +@item hfy-box-to-border-assoc +@findex hfy-box-to-border-assoc +@anchor{hfy-box-to-border-assoc} + +@lisp + +(hfy-box-to-border-assoc @var{spec}) +@end lisp + +Helper function for @ref{hfy-box-to-style}. + +@item hfy-face-attr-for-class +@findex hfy-face-attr-for-class +@anchor{hfy-face-attr-for-class} + +@lisp + +(hfy-face-attr-for-class @var{face} &optional @var{class}) +@end lisp + +Return the face attributes for @var{face}. If @var{class} is set, it +must be a @code{defface} alist key [see below]. Prior to version 0.18, +the first face specification returned by @ref{hfy-combined-face-spec} +which @emph{didn't} clash with @var{class} was returned. In versions +from 0.18 onwards, each font attribute list is scored, and the +non-conflicting list with the highest score is returned. (A specification +with a class of @code{t} is considered to match any class you specify. +This matches Emacs's behaviour when deciding on which face attributes to +use, to the best of my understanding ). + +If @var{class} is nil, then you just get get whatever +@code{face-attr-construct} returns; i.e., the current specification in +effect for @var{face}. + +See @ref{hfy-display-class} for details of valid values for @var{class}. + +@item hfy-face-at +@findex hfy-face-at +@anchor{hfy-face-at} + +@lisp + +(hfy-face-at P) +@end lisp + +Find face in effect at point P. If overlays are to be considered +(see @ref{hfy-optimisations}) then this may return a @code{defface} style +list of face properties instead of a face symbol. + +@item hfy-bgcol +@findex hfy-bgcol +@anchor{hfy-bgcol} + +@lisp + +(hfy-bgcol @var{color}) +@end lisp + +As per @ref{hfy-color} but for background colors. + +@item hfy-kludge-cperl-mode +@findex hfy-kludge-cperl-mode +@anchor{hfy-kludge-cperl-mode} + +@lisp + +(hfy-kludge-cperl-mode) +@end lisp + +cperl mode does its damndest not to do some of its fontification when not +in a windowing system---we try to trick it@dots{} + +@item hfy-href +@findex hfy-href +@anchor{hfy-href} + +@lisp + +(hfy-href @var{this-file} @var{def-files} @var{tag} @var{tag-map}) +@end lisp + +Return a relative href to the tag in question, based on + +@var{this-file} @ref{hfy-link-extn} @ref{hfy-extn} @var{def-files} @var{tag} and @var{tag-map} + +@var{this-file} is the current source file +@var{def-files} is a list of file containing possible link endpoints for @var{tag} +@var{tag} is the @var{tag} in question +@var{tag-map} is the entry in @ref{hfy-tags-cache}. + +@item hfy-shell +@findex hfy-shell +@anchor{hfy-shell} + +@lisp + +(hfy-shell) +@end lisp + +Returns a best guess at a Bourne compatible shell to use: If the current +shell doesn't look promising, fall back to @ref{hfy-shell-file-name}. + +@item hfy-load-tags-cache +@findex hfy-load-tags-cache +@anchor{hfy-load-tags-cache} + +@lisp + +(hfy-load-tags-cache @var{srcdir}) +@end lisp + +Run @ref{hfy-etags-cmd} on @var{srcdir}: load @ref{hfy-tags-cache} and @ref{hfy-tags-sortl}. + +@item hfy-parse-tags-buffer +@findex hfy-parse-tags-buffer +@anchor{hfy-parse-tags-buffer} + +@lisp + +(hfy-parse-tags-buffer @var{srcdir} @var{buffer}) +@end lisp + +Parse a @var{buffer} containing etags formatted output, loading the +@ref{hfy-tags-cache} and @ref{hfy-tags-sortl} entries for @var{srcdir}. + +@item hfy-interq +@findex hfy-interq +@anchor{hfy-interq} + +@lisp + +(hfy-interq @var{set-a} @var{set-b}) +@end lisp + +Return the intersection (using @code{eq}) of 2 lists. + +@item hfy-text-p +@findex hfy-text-p +@anchor{hfy-text-p} + +@lisp + +(hfy-text-p @var{srcdir} @var{file}) +@end lisp + +Is @var{srcdir}/@var{file} text? Uses @ref{hfy-istext-command} to determine this. + +@item hfy-opt +@findex hfy-opt +@anchor{hfy-opt} + +@lisp + +(hfy-opt @var{symbol}) +@end lisp + +Is @ref{hfy-optimisations} member @var{symbol} set or not? + +@item hfy-dirname +@findex hfy-dirname +@anchor{hfy-dirname} + +@lisp + +(hfy-dirname @var{file}) +@end lisp + +Return everything preceding the last @samp{/} from a relative filename, +on the assumption that this will produce a relative directory name. Hardly +bombproof, but good enough in the context in which it is being used. + +@item hfy-html-dekludge-buffer +@findex hfy-html-dekludge-buffer +@anchor{hfy-html-dekludge-buffer} + +@lisp + +(hfy-html-dekludge-buffer) +@end lisp + +Transform all dangerous characters marked with the @code{hfy-quoteme} property +using @ref{hfy-html-quote} + +See also @ref{hfy-html-enkludge-buffer}. + +@item hfy-copy-and-fontify-file +@findex hfy-copy-and-fontify-file +@anchor{hfy-copy-and-fontify-file} + +@lisp + +(hfy-copy-and-fontify-file @var{srcdir} @var{dstdir} @var{file}) +@end lisp + +Open @var{file} in @var{srcdir}---if fontified, write a fontified copy to @var{dstdir} +adding an extension of @ref{hfy-extn}. Fontification is actually done by +@ref{htmlfontify-buffer}. If the buffer is not fontified, just copy it. + +@item hfy-decor +@findex hfy-decor +@anchor{hfy-decor} + +@lisp + +(hfy-decor @var{tag} @var{val}) +@end lisp + +Derive CSS text-decoration specifiers from various Emacs font attributes. + +@item hfy-slant +@findex hfy-slant +@anchor{hfy-slant} + +@lisp + +(hfy-slant @var{slant}) +@end lisp + +Derive a font-style CSS specifier from the Emacs :slant +attribute---CSS does not define the reverse-* styles, so just maps +those to the regular specifiers. + +@item hfy-tags-for-file +@findex hfy-tags-for-file +@anchor{hfy-tags-for-file} + +@lisp + +(hfy-tags-for-file @var{srcdir} @var{file}) +@end lisp + +List of etags tags that have definitions in this @var{file}. Looks up +the tags cache in @ref{hfy-tags-cache} using @var{srcdir} as the key. + +@item hfy-width +@findex hfy-width +@anchor{hfy-width} + +@lisp + +(hfy-width @var{width}) +@end lisp + +Convert an Emacs @code{:width} attribute to a CSS font-stretch attribute. + +@comment /AUTOGENERATED BLOCK +@end table + +@node Variables +@section Variables +@cindex variables + +Important variables that are not customisation items: + +@table @code + +@item hfy-tags-cache +@vindex hfy-tags-cache +@anchor{hfy-tags-cache} + +This is an alist of the form: + +@example +(("/src/dir/0" . tag-hash0) ("/src/dir/1" tag-hash1) @dots{} ) +@end example + +Each tag hash entry then contains entries of the form: + +@example +"tag_string" => (("file/name.ext" line char) @dots{} ) +@end example + +i.e., an alist mapping (relative) file paths to line and character offsets. + +See @ref{hfy-load-tags-cache}. + +@item hfy-tags-rmap +@vindex hfy-tags-rmap +@anchor{hfy-tags-rmap} + +@code{hfy-tags-rmap} is an alist of the form: + +@lisp +(("/src/dir" . tag-rmap-hash)) +@end lisp + +Where tag-rmap-hash has entries of the form: + +@example +"tag_string" => ( "file/name.ext" line char ) +@end example + +Unlike @ref{hfy-tags-cache} these are the locations of occurrences of +tagged items, not the locations of their definitions. + +@item hfy-tags-sortl +@vindex hfy-tags-sortl +@anchor{hfy-tags-sortl} + +@code{hfy-tags-sortl} is an alist of the form: + +@example +(("/src/dir" . (tag0 tag1 tag2)) @dots{} ) +@end example + +Where the tags are stored in descending order of length. + +See: @ref{hfy-load-tags-cache}. + +@end table + +@node Data Structures +@section Data Structures +@cindex Data Structures + +Some of the (informal) data structures used in Htmlfontify are detailed here: + +@table @code + +@item hfy-style-assoc +@cindex hfy-style-assoc +@anchor{hfy-style-assoc} + +An assoc representing/describing an Emacs face. Properties may be repeated, +in which case later properties should be treated as if they were inherited +from a ``parent'' font. (For some properties, only the first encountered value +is of any importance, for others the values might be cumulative, and for +others they might be cumulative in a complex way.) + +Some examples: + +@lisp +(hfy-face-to-style 'default) => + + (("background" . "rgb(0, 0, 0)" ) + ("color" . "rgb(255, 255, 255)") + ("font-style" . "normal" ) + ("font-weight" . "500" ) + ("font-stretch" . "normal" ) + ("font-family" . "misc-fixed" ) + ("font-size" . "13pt" ) + ("text-decoration" . "none" )) + +(hfy-face-to-style 'Info-title-3-face) => + + (("font-weight" . "700" ) + ("font-family" . "helv" ) + ("font-size" . "120%" ) + ("text-decoration" . "none") ) +@end lisp + +@item hfy-sheet-assoc +@cindex hfy-sheet-assoc +@anchor{hfy-sheet-assoc} + +An assoc with elements of the form @samp{(face-name style-name . style-string)}. +The actual stylesheet for each page is derived from one of these. + +@lisp +'((default "default" . "@{ background: black; color: white@}") + (font-lock-string-face "string" . "@{ color: rgb(64,224,208) @}")) +@end lisp + +@item hfy-facemap-assoc +@cindex hfy-facemap-assoc +@anchor{hfy-facemap-assoc} + +An assoc of @code{(point . @var{face-symbol})} or +@code{(point . @code{defface} attribute list)} and @code{(point +. end)} elements, in descending order of point value (i.e., from the +file's end to its beginning). The map is in reverse order because +inserting a @samp{<style>} tag (or any other string) at @var{point} +invalidates the map for all entries with a greater value of point. By +traversing the map from greatest to least @var{point}, we still +invalidate the map as we go, but only those points we have already +dealt with (and therefore no longer care about) will be invalid at any +time. + +@lisp +'((64820 . end) + (64744 . font-lock-comment-face) + (64736 . end) + (64722 . font-lock-string-face) + (64630 . end) + (64623 . font-lock-string-face) + (64449 . end) + ;; Big similar section elided. You get the idea. + (5459 . end) + (5431 . (:inherit font-lock-keyword-face :background "7e7e7e")) + (5431 . end) + (4285 . font-lock-constant-face) + (4285 . end) + (4221 . font-lock-comment-face) + (4221 . end) + (4197 . font-lock-constant-face) + (4197 . end) + (1 . font-lock-comment-face)) +@end lisp + +@end table + +@node Examples +@section Examples +@cindex Examples + +The following is a lump of code I use to fontify source code on my +site, @url{http://rtfm.etla.org/} (which was the reason, incidentally, +that Htmlfontify was written in the first place). + +@lisp +(defvar rtfm-section nil) + +;; Constructs an appropriate header string to fit in with rtfm's +;; templating system, based on the file and the stylesheet string +(defun rtfm-build-page-header (file style) + (format "#define TEMPLATE red+black.html +#define DEBUG 1 +#include <build/menu-dirlist|>\n +html-css-url := /css/red+black.css +title := rtfm.etla.org ( %s / src/%s ) +bodytag := +head <=STYLESHEET;\n +%s +STYLESHEET +main-title := rtfm / %s / src/%s\n +main-content <=MAIN_CONTENT;\n" rtfm-section file style rtfm-section file)) + +;; the footer: +(defun rtfm-build-page-footer (file) "\nMAIN_CONTENT\n") + +(defun rtfm-fontify-buffer (section) + (interactive "s section[eg- emacs / p4-blame]: ") + (require 'htmlfontify) + (let ((hfy-page-header 'rtfm-build-page-header) + (hfy-page-footer 'rtfm-build-page-footer) + (rtfm-section section)) + (htmlfontify-buffer) + ) + ) + +;; Here's the function I actually call---it asks me for a section label, +;; and source and destination directories, and then binds a couple of +;; customisation variable in a let before calling htmlfontify: +(defun rtfm-build-source-docs (section srcdir destdir) + (interactive + "s section[eg- emacs / p4-blame]:\nD source-dir: \nD output-dir: ") + (require 'htmlfontify) + (hfy-load-tags-cache srcdir) + (let ((hfy-page-header 'rtfm-build-page-header) + (hfy-page-footer 'rtfm-build-page-footer) + (rtfm-section section) + (hfy-index-file "index") + (auto-mode-alist (append auto-mode-alist + '(("dbi\\(shell\\|gtk\\)$" . cperl-mode) + ("\\.xpm$" . c-mode )))) + ) + (htmlfontify-run-etags srcdir) + (htmlfontify-copy-and-link-dir srcdir destdir ".src" ".html"))) +@end lisp + +@node Customisation +@chapter Customisation +@cindex variables (customisation) + +Htmlfontify provides the following variable and customisation entries: + +@table @code +@comment AUTOGENERATED BLOCK + +@item hfy-link-style-fun +@vindex hfy-link-style-fun +@anchor{hfy-link-style-fun} + +Set this to a function, which will be called with one argument +(a @samp{@{ foo: bar; @dots{}@}} CSS style-string)---it should return a copy of +its argument, altered so as to make any changes you want made for text which +is a hyperlink, in addition to being in the class to which that style would +normally be applied. + +@item hfy-html-quote-regex +@vindex hfy-html-quote-regex +@anchor{hfy-html-quote-regex} + +Regex to match (with a single back-reference per match) strings in HTML +which should be quoted with @ref{hfy-html-quote} +(and @pxref{hfy-html-quote-map}) to make them safe. + +@item hfy-page-footer +@vindex hfy-page-footer +@anchor{hfy-page-footer} + +As @ref{hfy-page-header}, but generates the output footer +(and takes only 1 argument, the filename). + +@item hfy-display-class +@vindex hfy-display-class +@anchor{hfy-display-class} + +Display class to use to determine which display class to use when +calculating a face's attributes. This is useful when, for example, you +are running Emacs on a tty or in batch mode, and want Htmlfontify to have +access to the face spec you would use if you were connected to an X display. + +Some valid class specification elements are: + +@lisp + '(class color) + '(class grayscale) + '(background dark) + '(background light) + '(type x-toolkit) + '(type tty) + '(type motif) + '(type lucid) +@end lisp + +Multiple values for a tag may be combined, to indicate that any one or more +of these values in the specification key constitutes a match, eg: + +'((class color grayscale) (type tty)) would match any of: +@lisp + '((class color)) + '((class grayscale)) + '((class color grayscale))) + '((class color foo)) + '((type tty)) + '((type tty) (class color)) +@end lisp +and so on. + +@item hfy-page-header +@vindex hfy-page-header +@anchor{hfy-page-header} + +Function called with two arguments (the filename relative to the top +level source directory being etag'd and fontified), and a string containing +the @samp{<style>@dots{}</style>} text to embed in the document---the string +returned will be used as the header for the htmlfontified version of +the source file. + +See also: @ref{hfy-page-footer} + +@item hfy-src-doc-link-style +@vindex hfy-src-doc-link-style +@anchor{hfy-src-doc-link-style} + +String to add to the @samp{<style> a} variant of an Htmlfontify CSS class. + +@item hfy-fast-lock-save +@vindex hfy-fast-lock-save +@anchor{hfy-fast-lock-save} + +Minimum size of a buffer for cached fontification. +This value is temporarily assigned to @code{fast-lock-minimum-size} during +html-fontification. + +Only buffers more than this can have associated Font Lock cache files saved. + +If nil, means cache files are never created. + +If a list, each element should be a cons pair of the form +@code{(@var{major-mode} . @var{size})}, where @var{major-mode} +is a symbol or t (meaning the default). For example: + +@lisp + ((c-mode . 25600 ) + (c++-mode . 25600 ) + (rmail-mode . 1048576)) +@end lisp + +means that the minimum size is 25K for buffers in C or C++ modes, one megabyte +for buffers in Rmail mode, and size is irrelevant (i.e., no saves) otherwise. + +@item hfy-split-index +@vindex hfy-split-index +@anchor{hfy-split-index} + +Whether or not to split the index @ref{hfy-index-file} alphabetically +on the first letter of each tag. Useful when the index would otherwise +be large and take a long time to render or be difficult to navigate. + +@item hfy-find-cmd +@vindex hfy-find-cmd +@anchor{hfy-find-cmd} + +``find'' command used to harvest a list of files to attempt to fontify. + +@item hfy-extn +@vindex hfy-extn +@anchor{hfy-extn} + +File extension used for output files + +@item hfy-default-face-def +@vindex hfy-default-face-def +@anchor{hfy-default-face-def} + +Fallback @code{defface} specification for the face @code{default}, used +when @ref{hfy-display-class} has been set (the normal Htmlfontify way of +extracting potentially non-current face information doesn't necessarily +work for @code{default}). + +For example, I customise this to: + +@lisp +((t :background "black" :foreground "white" :family "misc-fixed")) +@end lisp + +@item hfy-init-kludge-hooks +@vindex hfy-init-kludge-hooks +@anchor{hfy-init-kludge-hooks} + +List of functions to call when starting htmlfontify-buffer to do any +kludging necessary to get highlighting modes to bahave as you want, even +when not running under a window system. + +@item hfy-shell-file-name +@vindex hfy-shell-file-name +@anchor{hfy-shell-file-name} + +Should be set to a Bourne compatible shell, which will be invoked +for the more complex shell interactions needed by Htmlfontify. +Currently this is only required/used when using GNU etags, see +@ref{hfy-etags-cmd-alist} for details. + +@item hfy-optimisations +@vindex hfy-optimisations +@anchor{hfy-optimisations} + +Optimisations to turn on. So far, the following have been implemented: + +@table @option +@item merge-adjacent-tags +If two (or more) span tags are adjacent, identical and separated by nothing +more than whitespace, they will be merged into one span. + +@item zap-comment-links +Suppress hyperlinking of tags found in comments. + +@item zap-string-links +Suppress hyperlinking of tags found in strings. + +@item div-wrapper +Add @samp{<div class="default"> </div>} tags around the fontified body. +(Some people like this because they cut and paste the html into +a page with different colors than the fontified code.) + +@item keep-overlays +Preserve overlay highlighting (c.f. @code{ediff} or @code{goo-font-lock}) +as well as basic faces. Can result in extremely verbose highlighting +if there are many overlays (as is the case with @code{goo-font-lock}). + +@end table + +And the following are planned but not yet available: + +@table @option +@item kill-context-leak +Suppress hyperlinking between files highlighted by different modes. + +@end table + +Note: like compiler optimisations, these optimise the _output_ of the code, +not the processing of the source itself, and are therefore likely to slow +Htmlfontify down, at least a little. Except for skip-refontification, +which can never slow you down, but may result in incomplete fontification. + +@item hfy-src-doc-link-unstyle +@vindex hfy-src-doc-link-unstyle +@anchor{hfy-src-doc-link-unstyle} + +Regex to remove from the <style> a variant of an Htmlfontify CSS class. + +@item hfy-link-extn +@vindex hfy-link-extn +@anchor{hfy-link-extn} + +File extension used for href links---useful where the Htmlfontify +output files are going to be processed again, with a rersulting change +in file extension. If @code{nil}, then any code using this should fall back +to @ref{hfy-extn}. + +@item hfy-istext-command +@vindex hfy-istext-command +@anchor{hfy-istext-command} + +Command to run with the name of a file, to see whether it is a text file +or not. The command should emit a string containing the word @samp{text} if +the file is a text file, and a string not containing @samp{text} otherwise. + +@item hfy-etags-cmd-alist +@vindex hfy-etags-cmd-alist +@anchor{hfy-etags-cmd-alist} + +An alist of possible shell commands that will generate etags output that +Htmlfontify can use. @samp{%s} will be replaced by @ref{hfy-etags-bin}. + +@item hfy-etags-bin +@vindex hfy-etags-bin +@anchor{hfy-etags-bin} + +The location of the etags binary (we begin by assuming it's in your path). + +Note that if etags is not in your path, you will need to alter the shell +commands in @ref{hfy-etags-cmd-alist}. + +[As of version 0.17, this requirement has been removed: it should + all just work(tm).] + +@item hfy-etags-cmd +@vindex hfy-etags-cmd +@anchor{hfy-etags-cmd} + +An etags shell command to run in the source directory to generate a tags +file for the whole source tree from there on down. The command should emit +the etags output on standard output. + +Two canned commands are provided---they drive Emacs's etags and +exuberant-ctags's etags respectively. + +@item hfy-etag-regex +@vindex hfy-etag-regex +@anchor{hfy-etag-regex} + +Regex used to parse an etags entry: must have 3 subexps, corresponding, +in order, to: + +@enumerate +@item +The tag +@item +The line +@item +The character (point) at which the tag occurs +@end enumerate + +@item hfy-index-file +@vindex hfy-index-file +@anchor{hfy-index-file} + +Name (sans extension) of the index file produced during +fontification-and-hyperlinking. + +@item hfy-instance-file +@vindex hfy-instance-file +@anchor{hfy-instance-file} + +Name (sans extension) of the tag usage index file produced during +fontification-and-hyperlinking. + +@item hfy-html-quote-map +@vindex hfy-html-quote-map +@anchor{hfy-html-quote-map} + +An alist of character -> entity mappings used to make the text html-safe. + +@comment /AUTOGENERATED BLOCK +@end table + +@node Requirements +@chapter Requirements +@cindex Requirements, Prerequisites + +Htmlfontify has a couple of external requirements: + +@itemize @bullet + +@item +GNU Emacs 20.7+ or 21.1+ + +Other versions may work---these have been used successfully by the +author. If you intend to use Htmlfontify in batch mode, 21.1+ is +pretty much required. The author does not know if XEmacs, NTemacs, +or J.Random Emacs will run Htmlfontify, but reports/patches/bags of +money are always welcome. + +@item +A copy of etags (exuberant-ctags or GNU etags). Htmlfontify attempts +to autodetect the version you have and customise itself accordingly, +but you should be able to override this. + +See: @ref{Customisation} + +@item +A copy of find (e.g., GNU find) that provides the @code{-path} predicate. + +You may be able to work around this with a suitable clever shell +command and the customisation entry: @ref{hfy-find-cmd} + +@item +A copy of sed (e.g., GNU sed). + +@item +A copy of the @code{file} command. + +@end itemize + +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + +@node Index +@unnumbered Index + +@table @var +@item Concepts +@printindex cp + +@item Functions +@printindex fn + +@item Variables & Customisation +@printindex vr + +@end table + +@setchapternewpage odd +@bye diff --git a/doc/misc/idlwave.texi b/doc/misc/idlwave.texi index 436fa28b1fb..a756cc6b6c6 100644 --- a/doc/misc/idlwave.texi +++ b/doc/misc/idlwave.texi @@ -22,7 +22,7 @@ Emacs, and interacting with an IDL shell run as a subprocess. This is edition @value{EDITION} of the IDLWAVE User Manual for IDLWAVE @value{VERSION}. -Copyright @copyright{} 1999-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1999--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -33,8 +33,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -56,7 +55,7 @@ developing GNU and promoting software freedom.'' @contents @ifnottex -@node Top, Introduction, (dir), (dir) +@node Top @top IDLWAVE IDLWAVE is a package which supports editing source code written in the @@ -85,9 +84,9 @@ Interactive Data Language (IDL), and running IDL as an inferior shell. Getting Started (Tutorial) -* Lesson I -- Development Cycle:: -* Lesson II -- Customization:: -* Lesson III -- User Catalog:: +* Lesson I---Development Cycle:: +* Lesson II---Customization:: +* Lesson III---User Catalog:: The IDLWAVE Major Mode @@ -166,7 +165,7 @@ Catalogs @end detailmenu @end menu -@node Introduction, IDLWAVE in a Nutshell, Top, Top +@node Introduction @chapter Introduction @cindex Introduction @cindex CORBA (Common Object Request Broker Architecture) @@ -264,7 +263,7 @@ had to be renamed because of a name space conflict with CORBA's @code{idl-mode}, defined in Emacs in the file @file{cc-mode.el}. In this manual, each section ends with a list of related user options. -Don't be confused by the sheer number of options available --- in most +Don't be confused by the sheer number of options available: in most cases the default settings are just fine. The variables are listed here to make sure you know where to look if you want to change anything. For a full description of what a particular variable does and how to @@ -272,7 +271,7 @@ configure it, see the documentation string of that variable (available with @kbd{C-h v}). Some configuration examples are also given in the appendix. -@node IDLWAVE in a Nutshell, Getting Started, Introduction, Top +@node IDLWAVE in a Nutshell @chapter IDLWAVE in a Nutshell @cindex Summary of important commands @cindex IDLWAVE in a Nutshell @@ -366,19 +365,19 @@ at point. <A NAME="TUTORIAL"></A> @end html -@node Getting Started, The IDLWAVE Major Mode, IDLWAVE in a Nutshell, Top +@node Getting Started @chapter Getting Started (Tutorial) @cindex Quick-Start @cindex Tutorial @cindex Getting Started @menu -* Lesson I -- Development Cycle:: -* Lesson II -- Customization:: -* Lesson III -- User Catalog:: +* Lesson I---Development Cycle:: +* Lesson II---Customization:: +* Lesson III---User Catalog:: @end menu -@node Lesson I -- Development Cycle, Lesson II -- Customization, Getting Started, Getting Started +@node Lesson I---Development Cycle @section Lesson I: Development Cycle The purpose of this tutorial is to guide you through a very basic @@ -449,7 +448,7 @@ cursor after the @code{end} statement of the @code{for} loop and press @key{SPC}. IDLWAVE blinks back to the beginning of the block and changes the generic @code{end} to the specific @code{endfor} automatically (as long as the variable @code{idlwave-expand-generic-end} -is turned on --- @pxref{Lesson II -- Customization}). Now place the +is turned on; @pxref{Lesson II---Customization}). Now place the cursor in any line you would like to split and press @kbd{M-@key{RET}}. The line is split at the cursor position, with the continuation @samp{$} and indentation all taken care of. Use @kbd{C-/} to undo the last @@ -505,7 +504,7 @@ Recompile with @kbd{C-c C-d C-c}. Jump back into the shell with @kbd{C-c C-s}, press the @key{UP} arrow to recall the previous command and execute again. -This time we get a plot, but it is pretty ugly --- the points are all +This time we get a plot, but it is pretty ugly: the points are all connected with a line. Hmm, isn't there a way for @code{plot} to use symbols instead? What was that keyword? Position the cursor on the plot line after a comma (where you'd normally type a keyword), and hit @@ -521,7 +520,7 @@ by now: @kbd{C-c C-d C-c}), go back to the shell (if it's vanished, you know what to do: @kbd{C-c C-s}) and execute again. Now things look pretty good. -Let's try a different day --- how about April fool's day? +Let's try a different day. How about April fool's day? @example plot_wday,1,4 @@ -552,14 +551,14 @@ command. Everything should now work fine. How about those leap years? Change the code to plot 100 years and see that every 28 years, the sequence of weekdays repeats. -@node Lesson II -- Customization, Lesson III -- User Catalog, Lesson I -- Development Cycle, Getting Started +@node Lesson II---Customization @section Lesson II: Customization Emacs is probably the most customizable piece of software ever written, and it would be a shame if you did not make use of this to adapt IDLWAVE to your own preferences. Customizing Emacs or IDLWAVE is accomplished by setting Lisp variables in the @file{.emacs} file in your home -directory --- but do not be dismayed; for the most part, you can just +directory---but do not be dismayed; for the most part, you can just copy and work from the examples given here. Let's first use a boolean variable. These are variables which you turn @@ -636,7 +635,7 @@ breakpoints (try it, it's easier). You can enable this with: @noindent to get compilation on @kbd{S-c}. Often, a modifier key like @key{SUPER} or @key{HYPER} is bound or can be bound to an otherwise -unused key on your keyboard --- consult your system documentation. +unused key on your keyboard; consult your system documentation. You can also assign specific commands to keys. This you must do in the @emph{mode-hook}, a special function which is run when a new IDLWAVE @@ -662,7 +661,7 @@ endless. Here we set function keys f4-f8 to common debugging commands. (local-set-key [f8] 'idlwave-shell-clear-all-bp))) @end lisp -@node Lesson III -- User Catalog, , Lesson II -- Customization, Getting Started +@node Lesson III---User Catalog @section Lesson III: User and Library Catalogs We have already used the routine info display in the first part of this @@ -685,7 +684,7 @@ Directories} from the IDLWAVE entry in the menu bar. If necessary, start the shell first with @kbd{C-c C-s} (@pxref{Starting the Shell}). IDLWAVE will find out about the IDL @code{!PATH} variable and offer a list of directories on the path. Simply select them all (or whichever -you want --- directories with existing library catalogs will not be +you want; directories with existing library catalogs will not be selected by default) and click on the @samp{Scan&Save} button. Then go for a cup of coffee while IDLWAVE collects information for each and every IDL routine on your search path. All this information is @@ -722,7 +721,7 @@ the manual, look at the documentation strings of interesting variables (with @kbd{C-h v idlwave<-variable-name> @key{RET}}) and ask the remaining questions on the newsgroup @code{comp.lang.idl-pvwave}. -@node The IDLWAVE Major Mode, The IDLWAVE Shell, Getting Started, Top +@node The IDLWAVE Major Mode @chapter The IDLWAVE Major Mode @cindex IDLWAVE major mode @cindex Major mode, @code{idlwave-mode} @@ -746,7 +745,7 @@ them. * Misc Options:: Things that fit nowhere else @end menu -@node Code Formatting, Routine Info, The IDLWAVE Major Mode, The IDLWAVE Major Mode +@node Code Formatting @section Code Formatting @cindex Code formatting @cindex Formatting, of code @@ -774,7 +773,7 @@ you. After configuring it to match your coding standards, you can rely on it to help keep your code neat and organized. -@node Code Indentation, Continued Statement Indentation, Code Formatting, Code Formatting +@node Code Indentation @subsection Code Indentation @cindex Code indentation @cindex Indentation @@ -814,7 +813,7 @@ Extra indentation applied to block END lines. A value equal to negative BEGIN lines. @end defopt -@node Continued Statement Indentation, Comment Indentation, Code Indentation, Code Formatting +@node Continued Statement Indentation @subsection Continued Statement Indentation @cindex Indentation, continued statement @cindex Continued statement indentation @@ -888,7 +887,7 @@ parenthesis, regardless of whether the @code{idlwave-max-extra-continuation-indent} limit is satisfied. @end defopt -@node Comment Indentation, Continuation Lines, Continued Statement Indentation, Code Formatting +@node Comment Indentation @subsection Comment Indentation @cindex Comment indentation @cindex Hanging paragraphs @@ -925,7 +924,7 @@ A comment that starts with this regexp is indented as if it is a part of IDL code. @end defopt -@node Continuation Lines, Syntax Highlighting, Comment Indentation, Code Formatting +@node Continuation Lines @subsection Continuation Lines and Filling @cindex Continuation lines @cindex Line splitting @@ -1001,7 +1000,7 @@ Non-@code{nil} means use last match on line for @code{idlwave-indent-regexp}. @end defopt -@node Syntax Highlighting, Octals and Highlighting, Continuation Lines, Code Formatting +@node Syntax Highlighting @subsection Syntax Highlighting @cindex Syntax highlighting @cindex Highlighting of syntax @@ -1029,7 +1028,7 @@ Items which should be fontified on the default fontification level 2. @end defopt -@node Octals and Highlighting, , Syntax Highlighting, Code Formatting +@node Octals and Highlighting @subsection Octals and Highlighting @cindex Syntax highlighting, Octals @cindex Highlighting of syntax, Octals @@ -1059,7 +1058,7 @@ altogether, and use the more sensible alternative IDL provides: @noindent This simultaneously solves the font-lock problem and is more consistent with the notation for hexadecimal numbers, e.g., @code{'C5'XB}. -@node Routine Info, Online Help, Code Formatting, The IDLWAVE Major Mode +@node Routine Info @section Routine Info @cindex Routine info @cindex Updating routine info @@ -1237,7 +1236,7 @@ Maximum number of source files displayed in the Routine Info window. @html <A NAME="ONLINE_HELP"></A> @end html -@node Online Help, Completion, Routine Info, The IDLWAVE Major Mode +@node Online Help @section Online Help @cindex Online Help @@ -1252,8 +1251,8 @@ For IDL system routines, extensive documentation is supplied with IDL@. IDLWAVE can access the HTML version of this documentation very quickly and accurately, based on the local context. This can be @emph{much} faster than using the IDL online help application, because IDLWAVE -usually gets you to the right place in the documentation directly --- -e.g., a specific keyword of a routine --- without any additional browsing +usually gets you to the right place in the documentation directly---e.g., +a specific keyword of a routine---without any additional browsing and scrolling. For this online help to work, an HTML version of the IDL documentation @@ -1344,7 +1343,7 @@ directly in the originating source file. * Help with Source:: @end menu -@node Help with HTML Documentation, Help with Source, Online Help, Online Help +@node Help with HTML Documentation @subsection Help with HTML Documentation @cindex HTML Help @cindex Help using HTML manuals @@ -1423,7 +1422,7 @@ contains "-w3". The face for links to IDLWAVE online help. @end defopt -@node Help with Source, , Help with HTML Documentation, Online Help +@node Help with Source @subsection Help with Source @cindex Help using routine source @@ -1510,7 +1509,7 @@ The case-insensitive heading word in doclib headers to locate the @end defopt -@node Completion, Routine Source, Online Help, The IDLWAVE Major Mode +@node Completion @section Completion @cindex Completion @cindex Keyword completion @@ -1526,7 +1525,7 @@ IDLWAVE offers completion for class names, routine names, keywords, system variables, system variable tags, class structure tags, regular structure tags and file names. As in many programming modes, completion is bound to @kbd{M-@key{TAB}} (or simply @kbd{@key{TAB}} in the IDLWAVE -Shell --- @pxref{Using the Shell}). Completion uses exactly the same +Shell; @pxref{Using the Shell}). Completion uses exactly the same internal information as routine info, so when necessary (rarely) it can be updated with @kbd{C-c C-i} (@code{idlwave-update-routine-info}). @@ -1582,7 +1581,7 @@ text. @cindex Completion, canceling @cindex Canceling completion -Completion is not a blocking operation --- you are free to continue +Completion is not a blocking operation; you are free to continue editing, enter commands, or simply ignore the @file{*Completions*} buffer during a completion operation. If, however, the most recent command was a completion, @kbd{C-g} will remove the buffer and restore @@ -1618,7 +1617,7 @@ available. * Structure Tag Completion:: Completing state.Tag @end menu -@node Case of Completed Words, Object Method Completion and Class Ambiguity, Completion, Completion +@node Case of Completed Words @subsection Case of Completed Words @cindex Case of completed words @cindex Mixed case completion @@ -1655,7 +1654,7 @@ Non-@code{nil} means the empty string is considered lower case for completion. @end defopt -@node Object Method Completion and Class Ambiguity, Object Method Completion in the Shell, Case of Completed Words, Completion +@node Object Method Completion and Class Ambiguity @subsection Object Method Completion and Class Ambiguity @cindex Object methods @cindex Class ambiguity @@ -1718,7 +1717,7 @@ Face to highlight object operator arrows @samp{->} which carry a saved class text property. @end defopt -@node Object Method Completion in the Shell, Class and Keyword Inheritance, Object Method Completion and Class Ambiguity, Completion +@node Object Method Completion in the Shell @subsection Object Method Completion in the Shell @cindex Method Completion in Shell In the IDLWAVE Shell (@pxref{The IDLWAVE Shell}), objects on which @@ -1731,7 +1730,7 @@ class found will be used to select appropriate completions, routine info, or help. If unsuccessful, information from all known classes will be used (as in the buffer). -@node Class and Keyword Inheritance, Structure Tag Completion, Object Method Completion in the Shell, Completion +@node Class and Keyword Inheritance @subsection Class and Keyword Inheritance @cindex Inheritance, class @cindex Keyword inheritance @@ -1777,7 +1776,7 @@ A list of regular expressions to match methods for which simple class-driven keyword inheritance will be used for Completion. @end defopt -@node Structure Tag Completion, , Class and Keyword Inheritance, Completion +@node Structure Tag Completion @subsection Structure Tag Completion @cindex Completion, structure tag @cindex Structure tag completion @@ -1819,7 +1818,7 @@ IDL> st.[Tab] @noindent will complete with all structure fields of the structure @code{st}. -@node Routine Source, Resolving Routines, Completion, The IDLWAVE Major Mode +@node Routine Source @section Routine Source @cindex Routine source file @cindex Module source file @@ -1845,7 +1844,7 @@ sometimes created. The special command @kbd{C-c C-k} (@code{idlwave-kill-autoloaded-buffers}) can be used to easily remove these buffers. -@node Resolving Routines, Code Templates, Routine Source, The IDLWAVE Major Mode +@node Resolving Routines @section Resolving Routines @cindex @code{RESOLVE_ROUTINE} @cindex Compiling library modules @@ -1866,7 +1865,7 @@ compile the modules first, and even without a running shell. @xref{Sources of Routine Info}, for more information on the ways IDLWAVE collects data about routines, and how to update this information. -@node Code Templates, Abbreviations, Resolving Routines, The IDLWAVE Major Mode +@node Code Templates @section Code Templates @cindex Code templates @cindex Templates @@ -1888,7 +1887,7 @@ templates, this is done with direct key bindings: All code templates are also available as abbreviations (@pxref{Abbreviations}). -@node Abbreviations, Actions, Code Templates, The IDLWAVE Major Mode +@node Abbreviations @section Abbreviations @cindex Abbreviations @@ -1899,7 +1898,7 @@ used to insert code templates all start with a @samp{\} (the backslash), or, optionally, any other character set in @code{idlwave-abbrev-start-char}. IDLWAVE ensures that abbreviations are only expanded where they should be (i.e., not in a string or comment), -and permits the point to be moved after an abbreviation expansion --- +and permits the point to be moved after an abbreviation expansion: very useful for positioning the mark inside of parentheses, etc. Special abbreviations are pre-defined for code templates and other @@ -2074,7 +2073,7 @@ Non-@code{nil} means the abbrev hook can move point, e.g., to end up between the parentheses of a function call. @end defopt -@node Actions, Doc Header, Abbreviations, The IDLWAVE Major Mode +@node Actions @section Actions @cindex Actions @cindex Coding standards, enforcing @@ -2122,7 +2121,7 @@ settings are described below and set separately. * Case Changes:: Enforcing upper case keywords @end menu -@node Block Boundary Check, Padding Operators, Actions, Actions +@node Block Boundary Check @subsection Block Boundary Check @cindex Block boundary check @cindex @code{END} type checking @@ -2155,7 +2154,7 @@ Non-@code{nil} means expand generic END to ENDIF/ENDELSE/ENDWHILE etc. Non-@code{nil} means re-indent line after END was typed. @end defopt -@node Padding Operators, Case Changes, Block Boundary Check, Actions +@node Padding Operators @subsection Padding Operators @cindex Padding operators with spaces @cindex Operators, padding with spaces @@ -2204,7 +2203,7 @@ surrounded with spaces by @code{idlwave-surround}. Non-@code{nil} means space-pad the @samp{=} in keyword assignments. @end defopt -@node Case Changes, , Padding Operators, Actions +@node Case Changes @subsection Case Changes @cindex Case changes @cindex Upcase, enforcing for reserved words @@ -2246,7 +2245,7 @@ expansion. @end defopt -@node Doc Header, Motion Commands, Actions, The IDLWAVE Major Mode +@node Doc Header @section Documentation Header @cindex Documentation header @cindex DocLib header @@ -2290,7 +2289,7 @@ Regexp matching the start of a document library header. Regexp matching the start of a document library header. @end defopt -@node Motion Commands, Misc Options, Doc Header, The IDLWAVE Major Mode +@node Motion Commands @section Motion Commands @cindex Motion commands @cindex Program structure, moving through @@ -2340,7 +2339,7 @@ IDL program: @end multitable -@node Misc Options, , Motion Commands, The IDLWAVE Major Mode +@node Misc Options @section Miscellaneous Options @cindex Hooks @@ -2361,7 +2360,7 @@ Normal hook. Executed when a buffer is put into @code{idlwave-mode}. Normal hook. Executed when @file{idlwave.el} is loaded. @end defopt -@node The IDLWAVE Shell, Acknowledgments, The IDLWAVE Major Mode, Top +@node The IDLWAVE Shell @chapter The IDLWAVE Shell @cindex IDLWAVE shell @cindex Major mode, @code{idlwave-shell-mode} @@ -2378,7 +2377,7 @@ interactively, to compile and run IDL programs in Emacs buffers and to debug these programs. The IDLWAVE shell is built on @file{comint}, an Emacs packages which handles the communication with the IDL program. Unfortunately, IDL for Windows does not have command-prompt versions and -thus do not allow the interaction with Emacs --- so the IDLWAVE shell +thus do not allow the interaction with Emacs, so the IDLWAVE shell currently only works under Unix and MacOSX. @menu @@ -2390,7 +2389,7 @@ currently only works under Unix and MacOSX. * Custom Expression Examination:: @end menu -@node Starting the Shell, Using the Shell, The IDLWAVE Shell, The IDLWAVE Shell +@node Starting the Shell @section Starting the Shell @cindex Starting the shell @cindex Shell, starting @@ -2500,7 +2499,7 @@ The prefix for temporary IDL files used when compiling regions. Hook for customizing @code{idlwave-shell-mode}. @end defopt -@node Using the Shell, Commands Sent to the Shell, Starting the Shell, The IDLWAVE Shell +@node Using the Shell @section Using the Shell @cindex Comint @cindex Shell, basic commands @@ -2627,7 +2626,7 @@ The three regular expressions which match the magic spells for input modes. @end defopt -@node Commands Sent to the Shell, Debugging IDL Programs, Using the Shell, The IDLWAVE Shell +@node Commands Sent to the Shell @section Commands Sent to the Shell @cindex Commands in shell, showing @cindex Showing commands in shell @@ -2668,7 +2667,7 @@ As a special case, any error message in the output will be displayed (e.g., stepping to an error). @end defopt -@node Debugging IDL Programs, Examining Variables, Commands Sent to the Shell, The IDLWAVE Shell +@node Debugging IDL Programs @section Debugging IDL Programs @cindex Debugging @cindex Keybindings for debugging @@ -2706,7 +2705,7 @@ buffers. @end menu -@node A Tale of Two Modes, Debug Key Bindings, Debugging IDL Programs, Debugging IDL Programs +@node A Tale of Two Modes @subsection A Tale of Two Modes @cindex Electric Debug Mode @cindex Debugging Interface @@ -2726,7 +2725,7 @@ Mode}, for more on that mode. Note that electric debug mode can be prevented from activating automatically by customizing the variable @code{idlwave-shell-automatic-electric-debug}. -@node Debug Key Bindings, Breakpoints and Stepping, A Tale of Two Modes, Debugging IDL Programs +@node Debug Key Bindings @subsection Debug Key Bindings @kindex C-c C-d @cindex Key bindings @@ -2736,8 +2735,8 @@ the prefix key @kbd{C-c C-d}, so, for example, setting a breakpoint is done with @kbd{C-c C-d C-b}, and compiling a source file with @kbd{C-c C-d C-c}. You can also easily configure IDLWAVE to use one or more modifier keys not in use by other commands, in lieu of the prefix -@kbd{C-c C-d} (though these bindings will typically also be available ---- see @code{idlwave-shell-activate-prefix-keybindings}). For +@kbd{C-c C-d} (though these bindings will typically also be available; +see @code{idlwave-shell-activate-prefix-keybindings}). For example, if you include in @file{.emacs}: @lisp @@ -2750,9 +2749,9 @@ source file will be on @kbd{C-S-c}, deleting a breakpoint @kbd{C-S-d}, etc. In the remainder of this chapter we will assume that the @kbd{C-c C-d} bindings are active, but each of these bindings will have an equivalent shortcut if modifiers are given in the -@code{idlwave-shell-debug-modifiers} variable (@pxref{Lesson II -- -Customization}). A much simpler and faster form of debugging for -running code is also available by default --- see @ref{Electric Debug +@code{idlwave-shell-debug-modifiers} variable (@pxref{Lesson +II---Customization}). A much simpler and faster form of debugging for +running code is also available by default; see @ref{Electric Debug Mode}. @defopt idlwave-shell-prefix-key (@kbd{C-c C-d}) @@ -2772,7 +2771,7 @@ more of @code{control}, @code{meta}, @code{super}, @code{hyper}, @code{alt}, and @code{shift}. @end defopt -@node Breakpoints and Stepping, Compiling Programs, Debug Key Bindings, Debugging IDL Programs +@node Breakpoints and Stepping @subsection Breakpoints and Stepping @cindex Breakpoints @cindex Stepping @@ -2788,7 +2787,7 @@ prefix arg of 1 (i.e., @kbd{C-1 C-c C-d C-b}), the breakpoint gets a With a numeric prefix greater than one (e.g., @kbd{C-4 C-c C-d C-b}), the breakpoint will only be active the @code{nth} time it is hit. With a single non-numeric prefix (i.e., @kbd{C-u C-c C-d C-b}), prompt -for a condition --- an IDL expression to be evaluated and trigger the +for a condition: an IDL expression to be evaluated and trigger the breakpoint only if true. To clear the breakpoint in the current line, use @kbd{C-c C-d C-d} (@code{idlwave-clear-current-bp}). When executed from the shell window, the breakpoint where IDL is currently @@ -2904,7 +2903,7 @@ configured in @code{idlwave-shell-mark-stop-line}. @end defopt -@node Compiling Programs, Walking the Calling Stack, Breakpoints and Stepping, Debugging IDL Programs +@node Compiling Programs @subsection Compiling Programs @cindex Compiling programs @cindex Programs, compiling @@ -2937,7 +2936,7 @@ level program @kbd{C-c C-d C-e} (@code{idlwave-shell-run-region}) is very useful. A temporary file is created holding the contents of the current region (with @code{END} appended), and run from the shell. -@node Walking the Calling Stack, Electric Debug Mode, Compiling Programs, Debugging IDL Programs +@node Walking the Calling Stack @subsection Walking the Calling Stack @cindex Calling stack, walking @@ -2959,7 +2958,7 @@ higher calling stack levels. @html <A NAME="EDEBUG"></A> @end html -@node Electric Debug Mode, , Walking the Calling Stack, Debugging IDL Programs +@node Electric Debug Mode @subsection Electric Debug Mode @cindex Electric Debug Mode @cindex @samp{*Debugging*} @@ -3096,7 +3095,7 @@ window, but is useful for immediate stepping, etc. @html <A NAME="EXAMINE"></A> @end html -@node Examining Variables, Custom Expression Examination, Debugging IDL Programs, The IDLWAVE Shell +@node Examining Variables @section Examining Variables @cindex @code{PRINT} expressions @cindex @code{HELP}, on expressions @@ -3119,10 +3118,10 @@ time (as long as the shell is running), and are very useful when execution is stopped in a buffer due to a triggered breakpoint or error, or while composing a long command in the IDLWAVE shell. In the latter case, the command is sent to the shell and its output is visible, but -point remains unmoved in the command being composed --- you can inspect +point remains unmoved in the command being composed: you can inspect the constituents of a command you're building without interrupting the process of building it! You can even print arbitrary expressions from -older input or output further up in the shell window --- any expression, +older input or output further up in the shell window; any expression, variable, number, or function you see can be examined. If the variable @code{idlwave-shell-separate-examine-output} is @@ -3203,7 +3202,7 @@ The maximum number of leading array entries to print, when examining array expressions. @end defopt -@node Custom Expression Examination, , Examining Variables, The IDLWAVE Shell +@node Custom Expression Examination @section Custom Expression Examination @cindex Expressions, custom examination @cindex Custom expression examination @@ -3273,7 +3272,7 @@ examine command strings to send, after all instances of @code{___} (three underscores) are replaced by the indicated expression. @end defopt -@node Acknowledgments, Sources of Routine Info, The IDLWAVE Shell, Top +@node Acknowledgments @chapter Acknowledgments @cindex Acknowledgments @cindex Maintainer, of IDLWAVE @@ -3352,7 +3351,7 @@ scripts and documentation to interface with the IDL Assistant. @noindent Thanks to everyone! -@node Sources of Routine Info, HTML Help Browser Tips, Acknowledgments, Top +@node Sources of Routine Info @appendix Sources of Routine Info @cindex Sources of routine information @@ -3369,7 +3368,7 @@ know about the accessible routines. * Documentation Scan:: Scanning the IDL Manuals @end menu -@node Routine Definitions, Routine Information Sources, Sources of Routine Info, Sources of Routine Info +@node Routine Definitions @appendixsec Routine Definitions @cindex Routine definitions @cindex IDL variable @code{!PATH} @@ -3405,7 +3404,7 @@ cannot provide routine info and completion for such external routines, except by querying the Shell for calling information (DLMs only). @end enumerate -@node Routine Information Sources, Catalogs, Routine Definitions, Sources of Routine Info +@node Routine Information Sources @appendixsec Routine Information Sources @cindex Routine info sources @cindex Builtin list of routines @@ -3492,7 +3491,7 @@ Controls under what circumstances routine info is updated automatically. @html <A NAME="CATALOGS"></A> @end html -@node Catalogs, Load-Path Shadows, Routine Information Sources, Sources of Routine Info +@node Catalogs @appendixsec Catalogs @cindex Catalogs @@ -3506,7 +3505,7 @@ Starting with version 5.0, there are two types of catalogs available with IDLWAVE@. The traditional @emph{user catalog} and the newer @emph{library catalogs}. Although they can be used interchangeably, the library catalogs are more flexible, and preferred. There are few -occasions when a user catalog might be preferred --- read below. Both +occasions when a user catalog might be preferred---read below. Both types of catalogs can coexist without causing problems. To facilitate the catalog systems, IDLWAVE stores information it gathers @@ -3554,7 +3553,7 @@ later). @html <A NAME="LIBRARY_CATALOGS"></A> @end html -@node Library Catalogs, User Catalog, Catalogs, Catalogs +@node Library Catalogs @appendixsubsec Library Catalogs @cindex @file{.idlwave_catalog} @cindex Library catalogs @@ -3564,7 +3563,7 @@ Library catalogs consist of files named @file{.idlwave_catalog} stored in directories containing @code{.pro} routine files. They are discovered on the IDL search path and loaded automatically when routine information is read. Each catalog file documents the routines found in -that directory --- one catalog per directory. Every catalog has a +that directory---one catalog per directory. Every catalog has a library name associated with it (e.g., @emph{AstroLib}). This name will be shown briefly when the catalog is found, and in the routine info of routines it documents. @@ -3618,7 +3617,7 @@ Whether to search for and load library catalogs. Disable if load performance is a problem and/or the catalogs are not needed. @end defopt -@node User Catalog, , Library Catalogs, Catalogs +@node User Catalog @appendixsubsec User Catalog @cindex User catalog @cindex IDL library routine info @@ -3691,7 +3690,7 @@ Alist of regular expressions matching special library directories for labeling in routine-info display. @end defopt -@node Load-Path Shadows, Documentation Scan, Catalogs, Sources of Routine Info +@node Load-Path Shadows @appendixsec Load-Path Shadows @cindex Load-path shadows @cindex Shadows, load-path @@ -3751,7 +3750,7 @@ routines. Another way to find out if a specific routine has multiple definitions on the load path is routine info display (@pxref{Routine Info}). -@node Documentation Scan, , Load-Path Shadows, Sources of Routine Info +@node Documentation Scan @appendixsec Documentation Scan @cindex @file{get_html_rinfo} @cindex @file{idlw-rinfo.el} @@ -3784,7 +3783,7 @@ scanning the HTML documents produced from the IDL documentation. Instructions on how to use @file{get_html_rinfo} are in the program itself. -@node HTML Help Browser Tips, Configuration Examples, Sources of Routine Info, Top +@node HTML Help Browser Tips @appendix HTML Help Browser Tips @cindex Browser Tips @@ -3859,7 +3858,7 @@ Note that you can open the file in an external browser from within @code{w3m} using @kbd{M}. @end itemize -@node Configuration Examples, Windows and MacOS, HTML Help Browser Tips, Top +@node Configuration Examples @appendix Configuration Examples @cindex Configuration examples @cindex Example configuration @@ -4022,7 +4021,7 @@ user is King! @html <A NAME="WINDOWS_MAC"></A> @end html -@node Windows and MacOS, Troubleshooting, Configuration Examples, Top +@node Windows and MacOS @appendix Windows and MacOS @cindex Windows @cindex MacOS @@ -4062,13 +4061,13 @@ system. I am assuming that IDLWAVE has been installed in @end lisp -@noindent Furthermore, Windows sometimes tries to outsmart you --- make +@noindent Furthermore, Windows sometimes tries to outsmart you; make sure you check the following things: @itemize @bullet @item When you download the IDLWAVE distribution, make sure you save the file under the names @file{idlwave.tar.gz}. -@item M-TAB switches among running programs --- use Esc-TAB +@item M-TAB switches among running programs---use Esc-TAB instead. @item Other issues as yet unnamed... @end itemize @@ -4080,7 +4079,7 @@ help can skip the browser and use the HTMLHelp functionality directly. @html <A NAME="TROUBLE"></A> @end html -@node Troubleshooting, GNU Free Documentation License, Windows and MacOS, Top +@node Troubleshooting @appendix Troubleshooting @cindex Troubleshooting @@ -4286,11 +4285,11 @@ IDLWAVE is @samp{fsf-compat, xemacs-base, mail-lib}. @end enumerate -@node GNU Free Documentation License, Index, Troubleshooting, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Index, , GNU Free Documentation License, Top +@node Index @unnumbered Index @printindex cp diff --git a/doc/misc/info.texi b/doc/misc/info.texi index 141b8da5728..70dfffde393 100644 --- a/doc/misc/info.texi +++ b/doc/misc/info.texi @@ -14,25 +14,18 @@ This file describes how to use Info, the on-line, menu-driven GNU documentation system. -Copyright @copyright{} 1989, 1992, 1996-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1989, 1992, 1996--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no -Invariant Sections, with the Front-Cover texts being ``A GNU -Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the -license is included in the section entitled ``GNU Free Documentation -License'' in the Emacs manual. +Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' +and with the Back-Cover Texts as in (a) below. A copy of the license +is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' - -This document is part of a collection distributed under the GNU Free -Documentation License. If you want to distribute this document -separately from the collection, you can do so by adding a copy of the -license to the document, as described in section 6 of the license. +modify this GNU manual.'' @end quotation @end copying @@ -84,6 +77,7 @@ Started' chapter. * Getting Started:: Getting started using an Info reader. * Advanced:: Advanced Info commands. * Expert Info:: Info commands for experts. +* GNU Free Documentation License:: The license for this documentation. * Index:: An index of topics, commands, and variables. @end menu @@ -1504,6 +1498,10 @@ usually few. To check an Info file, do @kbd{M-x Info-validate} while looking at any node of the file with Emacs Info mode. +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + @node Index @unnumbered Index diff --git a/doc/misc/mairix-el.texi b/doc/misc/mairix-el.texi index 1e835d44838..ff5b2ca6748 100644 --- a/doc/misc/mairix-el.texi +++ b/doc/misc/mairix-el.texi @@ -6,7 +6,7 @@ @documentencoding ISO-8859-1 @copying -Copyright @copyright{} 2008-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2008--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -17,8 +17,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -28,7 +27,7 @@ developing GNU and promoting software freedom.'' @end direntry @titlepage -@title mairix.el - Mairix interface for Emacs +@title mairix.el---Mairix interface for Emacs @author David Engster @page @@ -39,7 +38,7 @@ developing GNU and promoting software freedom.'' @contents @node Top -@top mairix.el - Mairix interface for Emacs +@top mairix.el---Mairix interface for Emacs Mairix is a tool for indexing and searching words in locally stored mail. It was written by Richard Curnow and is licensed under the @@ -61,6 +60,7 @@ database. * Setting up mairix.el:: Set up mairix.el * Using mairix.el:: List of interactive functions * Extending mairix.el:: Support your favorite mail reader! +* GNU Free Documentation License:: The license for this documentation. @end menu @node About mairix and mairix.el @@ -346,6 +346,8 @@ Then add the functions to @code{mairix-display-functions} and And that's it! - +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi @bye diff --git a/doc/misc/makefile.w32-in b/doc/misc/makefile.w32-in index 84ad720052e..11c76dcfcf7 100644 --- a/doc/misc/makefile.w32-in +++ b/doc/misc/makefile.w32-in @@ -1,6 +1,6 @@ #### -*- Makefile -*- for documentation other than the Emacs manual. -# Copyright (C) 2003-2012 Free Software Foundation, Inc. +# Copyright (C) 2003-2013 Free Software Foundation, Inc. # This file is part of GNU Emacs. @@ -56,7 +56,7 @@ INFO_TARGETS = $(infodir)/ccmode$(INFO_EXT) \ $(infodir)/auth$(INFO_EXT) $(infodir)/eieio$(INFO_EXT) $(infodir)/ede$(INFO_EXT) \ $(infodir)/semantic$(INFO_EXT) $(infodir)/edt$(INFO_EXT) $(infodir)/emacs-gnutls$(INFO_EXT) \ $(infodir)/srecode$(INFO_EXT) $(infodir)/bovine$(INFO_EXT) \ - $(infodir)/wisent$(INFO_EXT) + $(infodir)/wisent$(INFO_EXT) $(infodir)/htmlfontify$(INFO_EXT) DVI_TARGETS = calc.dvi cc-mode.dvi cl.dvi dbus.dvi dired-x.dvi \ ediff.dvi forms.dvi gnus.dvi message.dvi emacs-mime.dvi \ sieve.dvi pgg.dvi mh-e.dvi \ @@ -68,7 +68,7 @@ DVI_TARGETS = calc.dvi cc-mode.dvi cl.dvi dbus.dvi dired-x.dvi \ remember.dvi nxml-mode.dvi \ epa.dvi mairix-el.dvi sasl.dvi auth.dvi eieio.dvi ede.dvi \ semantic.dvi edt.dvi emacs-gnutls.dvi srecode.dvi bovine.dvi \ - wisent.dvi + wisent.dvi htmlfontify.dvi INFOSOURCES = info.texi # The following rule does not work with all versions of `make'. @@ -106,102 +106,100 @@ info.dvi: $(INFOSOURCES) $(ENVADD) $(TEXI2DVI) $(srcdir)/info.texi -$(infodir)/ccmode$(INFO_EXT): cc-mode.texi doclicense.texi +$(infodir)/ccmode$(INFO_EXT): cc-mode.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ cc-mode.texi -cc-mode.dvi: cc-mode.texi doclicense.texi +cc-mode.dvi: cc-mode.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/cc-mode.texi -$(infodir)/ada-mode$(INFO_EXT): ada-mode.texi doclicense.texi +$(infodir)/ada-mode$(INFO_EXT): ada-mode.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ada-mode.texi -ada-mode.dvi: ada-mode.texi doclicense.texi +ada-mode.dvi: ada-mode.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/ada-mode.texi -$(infodir)/pcl-cvs$(INFO_EXT): pcl-cvs.texi doclicense.texi +$(infodir)/pcl-cvs$(INFO_EXT): pcl-cvs.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ pcl-cvs.texi -pcl-cvs.dvi: pcl-cvs.texi doclicense.texi +pcl-cvs.dvi: pcl-cvs.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/pcl-cvs.texi -$(infodir)/eshell$(INFO_EXT): eshell.texi doclicense.texi +$(infodir)/eshell$(INFO_EXT): eshell.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ eshell.texi -eshell.dvi: eshell.texi doclicense.texi +eshell.dvi: eshell.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/eshell.texi -$(infodir)/cl$(INFO_EXT): cl.texi doclicense.texi +$(infodir)/cl$(INFO_EXT): cl.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ cl.texi -cl.dvi: cl.texi doclicense.texi +cl.dvi: cl.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/cl.texi -$(infodir)/dbus$(INFO_EXT): dbus.texi doclicense.texi +$(infodir)/dbus$(INFO_EXT): dbus.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ dbus.texi -dbus.dvi: dbus.texi doclicense.texi +dbus.dvi: dbus.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/dbus.texi -$(infodir)/dired-x$(INFO_EXT): dired-x.texi $(emacsdir)/emacsver.texi doclicense.texi +$(infodir)/dired-x$(INFO_EXT): dired-x.texi $(emacsdir)/emacsver.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ dired-x.texi -dired-x.dvi: dired-x.texi $(emacsdir)/emacsver.texi doclicense.texi +dired-x.dvi: dired-x.texi $(emacsdir)/emacsver.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/dired-x.texi -$(infodir)/ediff$(INFO_EXT): ediff.texi doclicense.texi +$(infodir)/ediff$(INFO_EXT): ediff.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ediff.texi -ediff.dvi: ediff.texi doclicense.texi +ediff.dvi: ediff.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/ediff.texi -$(infodir)/flymake$(INFO_EXT): flymake.texi doclicense.texi +$(infodir)/flymake$(INFO_EXT): flymake.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ flymake.texi -flymake.dvi: flymake.texi doclicense.texi +flymake.dvi: flymake.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/flymake.texi -$(infodir)/forms$(INFO_EXT): forms.texi doclicense.texi +$(infodir)/forms$(INFO_EXT): forms.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ forms.texi -forms.dvi: forms.texi doclicense.texi +forms.dvi: forms.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/forms.texi # gnus/message/emacs-mime/sieve/pgg are part of Gnus: $(infodir)/gnus$(INFO_EXT): gnus.texi gnus-overrides.texi message.texi emacs-mime.texi \ - sieve.texi pgg.texi sasl.texi gnus-news.texi gnus-faq.texi \ - doclicense.texi + sieve.texi pgg.texi sasl.texi gnus-news.texi gnus-faq.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ gnus.texi gnus.dvi: gnus.texi gnus-overrides.texi message.texi emacs-mime.texi \ - sieve.texi pgg.texi sasl.texi gnus-news.texi gnus-faq.texi \ - doclicense.texi + sieve.texi pgg.texi sasl.texi gnus-news.texi gnus-faq.texi sed -e "/@iflatex/,/@end iflatex/d" $(srcdir)/gnus.texi > gnustmp.texi $(ENVADD) $(TEXI2DVI) gnustmp.texi cp gnustmp.dvi $*.dvi rm gnustmp.* # -$(infodir)/message$(INFO_EXT): message.texi gnus-overrides.texi doclicense.texi +$(infodir)/message$(INFO_EXT): message.texi gnus-overrides.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ message.texi -message.dvi: message.texi gnus-overrides.texi doclicense.texi +message.dvi: message.texi gnus-overrides.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/message.texi # -$(infodir)/emacs-mime$(INFO_EXT): emacs-mime.texi gnus-overrides.texi doclicense.texi +$(infodir)/emacs-mime$(INFO_EXT): emacs-mime.texi gnus-overrides.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ --enable-encoding emacs-mime.texi -emacs-mime.dvi: emacs-mime.texi gnus-overrides.texi doclicense.texi +emacs-mime.dvi: emacs-mime.texi gnus-overrides.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/emacs-mime.texi # -$(infodir)/sieve$(INFO_EXT): sieve.texi gnus-overrides.texi doclicense.texi +$(infodir)/sieve$(INFO_EXT): sieve.texi gnus-overrides.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ sieve.texi -sieve.dvi: sieve.texi gnus-overrides.texi doclicense.texi +sieve.dvi: sieve.texi gnus-overrides.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/sieve.texi # -$(infodir)/pgg$(INFO_EXT): pgg.texi gnus-overrides.texi doclicense.texi +$(infodir)/pgg$(INFO_EXT): pgg.texi gnus-overrides.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ pgg.texi -pgg.dvi: pgg.texi gnus-overrides.texi doclicense.texi +pgg.dvi: pgg.texi gnus-overrides.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/pgg.texi -$(infodir)/mh-e$(INFO_EXT): mh-e.texi doclicense.texi gpl.texi +$(infodir)/mh-e$(INFO_EXT): mh-e.texi gpl.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ mh-e.texi -mh-e.dvi: mh-e.texi doclicense.texi gpl.texi +mh-e.dvi: mh-e.texi gpl.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/mh-e.texi -$(infodir)/reftex$(INFO_EXT): reftex.texi doclicense.texi +$(infodir)/reftex$(INFO_EXT): reftex.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ reftex.texi -reftex.dvi: reftex.texi doclicense.texi +reftex.dvi: reftex.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/reftex.texi -$(infodir)/remember$(INFO_EXT): remember.texi doclicense.texi +$(infodir)/remember$(INFO_EXT): remember.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ remember.texi -remember.dvi: remember.texi doclicense.texix +remember.dvi: remember.texix $(ENVADD) $(TEXI2DVI) $(srcdir)/remember.texi $(infodir)/sasl$(INFO_EXT): sasl.texi gnus-overrides.texi @@ -209,24 +207,24 @@ $(infodir)/sasl$(INFO_EXT): sasl.texi gnus-overrides.texi sasl.dvi: sasl.texi gnus-overrides.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/sasl.texi -$(infodir)/sc$(INFO_EXT): sc.texi doclicense.texi +$(infodir)/sc$(INFO_EXT): sc.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ sc.texi -sc.dvi: sc.texi doclicense.texi +sc.dvi: sc.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/sc.texi -$(infodir)/vip$(INFO_EXT): vip.texi doclicense.texi +$(infodir)/vip$(INFO_EXT): vip.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ vip.texi -vip.dvi: vip.texi doclicense.texi +vip.dvi: vip.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/vip.texi -$(infodir)/viper$(INFO_EXT): viper.texi doclicense.texi +$(infodir)/viper$(INFO_EXT): viper.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ viper.texi -viper.dvi: viper.texi doclicense.texi +viper.dvi: viper.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/viper.texi -$(infodir)/widget$(INFO_EXT): widget.texi doclicense.texi +$(infodir)/widget$(INFO_EXT): widget.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ widget.texi -widget.dvi: widget.texi doclicense.texi +widget.dvi: widget.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/widget.texi $(infodir)/efaq$(INFO_EXT): faq.texi $(emacsdir)/emacsver.texi @@ -234,56 +232,56 @@ $(infodir)/efaq$(INFO_EXT): faq.texi $(emacsdir)/emacsver.texi faq.dvi: faq.texi $(emacsdir)/emacsver.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/faq.texi -$(infodir)/autotype$(INFO_EXT): autotype.texi doclicense.texi +$(infodir)/autotype$(INFO_EXT): autotype.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ autotype.texi -autotype.dvi: autotype.texi doclicense.texi +autotype.dvi: autotype.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/autotype.texi -$(infodir)/calc$(INFO_EXT): calc.texi $(emacsdir)/emacsver.texi gpl.texi doclicense.texi +$(infodir)/calc$(INFO_EXT): calc.texi $(emacsdir)/emacsver.texi gpl.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ calc.texi -calc.dvi: calc.texi $(emacsdir)/emacsver.texi gpl.texi doclicense.texi +calc.dvi: calc.texi $(emacsdir)/emacsver.texi gpl.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/calc.texi # This is produced with --no-split to avoid making files whose # names clash on DOS 8+3 filesystems -$(infodir)/idlwave$(INFO_EXT): idlwave.texi doclicense.texi +$(infodir)/idlwave$(INFO_EXT): idlwave.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ idlwave.texi -idlwave.dvi: idlwave.texi doclicense.texi +idlwave.dvi: idlwave.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/idlwave.texi -$(infodir)/eudc$(INFO_EXT): eudc.texi doclicense.texi +$(infodir)/eudc$(INFO_EXT): eudc.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ eudc.texi -eudc.dvi: eudc.texi doclicense.texi +eudc.dvi: eudc.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/eudc.texi -$(infodir)/ebrowse$(INFO_EXT): ebrowse.texi doclicense.texi +$(infodir)/ebrowse$(INFO_EXT): ebrowse.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ebrowse.texi -ebrowse.dvi: ebrowse.texi doclicense.texi +ebrowse.dvi: ebrowse.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/ebrowse.texi -$(infodir)/woman$(INFO_EXT): woman.texi doclicense.texi +$(infodir)/woman$(INFO_EXT): woman.texi $(emacsdir)/emacsver.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ woman.texi -woman.dvi: woman.texi doclicense.texi +woman.dvi: woman.texi $(emacsdir)/emacsver.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/woman.texi -$(infodir)/speedbar$(INFO_EXT): speedbar.texi doclicense.texi +$(infodir)/speedbar$(INFO_EXT): speedbar.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ speedbar.texi -speedbar.dvi: speedbar.texi doclicense.texi +speedbar.dvi: speedbar.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/speedbar.texi -$(infodir)/tramp$(INFO_EXT): tramp.texi trampver.texi doclicense.texi +$(infodir)/tramp$(INFO_EXT): tramp.texi trampver.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ tramp.texi -tramp.dvi: tramp.texi trampver.texi doclicense.texi +tramp.dvi: tramp.texi trampver.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/tramp.texi -$(infodir)/ses$(INFO_EXT): ses.texi doclicense.texi +$(infodir)/ses$(INFO_EXT): ses.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ses.texi -ses.dvi: ses.texi doclicense.texi +ses.dvi: ses.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/ses.texi -$(infodir)/smtpmail$(INFO_EXT): smtpmail.texi doclicense.texi +$(infodir)/smtpmail$(INFO_EXT): smtpmail.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ smtpmail.texi -smtpmail.dvi: smtpmail.texi doclicense.texi +smtpmail.dvi: smtpmail.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/smtpmail.texi $(infodir)/org$(INFO_EXT): org.texi @@ -291,14 +289,14 @@ $(infodir)/org$(INFO_EXT): org.texi org.dvi: org.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/org.texi -$(infodir)/url$(INFO_EXT): url.texi doclicense.texi +$(infodir)/url$(INFO_EXT): url.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ url.texi -url.dvi: url.texi doclicense.texi +url.dvi: url.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/url.texi -$(infodir)/newsticker$(INFO_EXT): newsticker.texi doclicense.texi +$(infodir)/newsticker$(INFO_EXT): newsticker.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ newsticker.texi -newsticker.dvi: newsticker.texi doclicense.texi +newsticker.dvi: newsticker.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/newsticker.texi $(infodir)/nxml-mode$(INFO_EXT): nxml-mode.texi @@ -306,14 +304,14 @@ $(infodir)/nxml-mode$(INFO_EXT): nxml-mode.texi nxml-mod.dvi: nxml-mode.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/nxml-mode.texi -$(infodir)/rcirc$(INFO_EXT): rcirc.texi doclicense.texi +$(infodir)/rcirc$(INFO_EXT): rcirc.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ rcirc.texi -rcirc.dvi: rcirc.texi doclicense.texi +rcirc.dvi: rcirc.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/rcirc.texi -$(infodir)/erc$(INFO_EXT): erc.texi gpl.texi doclicense.texi +$(infodir)/erc$(INFO_EXT): erc.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ erc.texi -erc.dvi: erc.texi gpl.texi doclicense.texi +erc.dvi: erc.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/erc.texi $(infodir)/ert$(INFO_EXT): ert.texi @@ -346,36 +344,45 @@ $(infodir)/ede$(INFO_EXT): ede.texi ede.dvi: ede.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/ede.texi -$(infodir)/semantic$(INFO_EXT): semantic.texi sem-user.texi doclicense.texi +$(infodir)/semantic$(INFO_EXT): semantic.texi sem-user.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ semantic.texi -semantic.dvi: semantic.texi sem-user.texi doclicense.texi +semantic.dvi: semantic.texi sem-user.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/semantic.texi -$(infodir)/edt$(INFO_EXT): edt.texi doclicense.texi +$(infodir)/edt$(INFO_EXT): edt.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ edt.texi -edt.dvi: edt.texi doclicense.texi +edt.dvi: edt.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/edt.texi -$(infodir)/emacs-gnutls$(INFO_EXT): emacs-gnutls.texi doclicense.texi +$(infodir)/emacs-gnutls$(INFO_EXT): emacs-gnutls.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ emacs-gnutls.texi -emacs-gnutls.dvi: emacs-gnutls.texi doclicense.texi +emacs-gnutls.dvi: emacs-gnutls.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/emacs-gnutls.texi -$(infodir)/srecode$(INFO_EXT): srecode.texi doclicense.texi +$(infodir)/srecode$(INFO_EXT): srecode.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ srecode.texi -srecode.dvi: srecode.texi doclicense.texi +srecode.dvi: srecode.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/srecode.texi -$(infodir)/bovine$(INFO_EXT): bovine.texi doclicense.texi +$(infodir)/bovine$(INFO_EXT): bovine.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ bovine.texi -bovine.dvi: bovine.texi doclicense.texi +bovine.dvi: bovine.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/bovine.texi -$(infodir)/wisent$(INFO_EXT): wisent.texi doclicense.texi +$(infodir)/wisent$(INFO_EXT): wisent.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ wisent.texi -wisent.dvi: wisent.texi doclicense.texi +wisent.dvi: wisent.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/wisent.texi +$(infodir)/htmlfontify$(INFO_EXT): htmlfontify.texi + $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ htmlfontify.texi +htmlfontify.dvi: htmlfontify.texi + $(ENVADD) $(TEXI2DVI) $(srcdir)/htmlfontify.texi + + +$(INFO_TARGETS): doclicense.texi +$(DVI_TARGETS): doclicense.texi + mostlyclean: - $(DEL) *.log *.cp *.fn *.ky *.pg *.vr core *.tp *.core gnustmp.* @@ -405,7 +412,8 @@ clean: mostlyclean $(infodir)/eieio* $(infodir)/ede* \ $(infodir)/semantic* $(infodir)edt* \ $(infodir)/emacs-gnutls* $(infodir)/srecode* \ - $(infodir)/bovine* $(infodir)/wisent* + $(infodir)/bovine* $(infodir)/wisent* \ + $(infodir)/htmlfontify* distclean: clean - $(DEL) makefile diff --git a/doc/misc/message.texi b/doc/misc/message.texi index 68e14c9b253..0e0bd115bb2 100644 --- a/doc/misc/message.texi +++ b/doc/misc/message.texi @@ -10,7 +10,7 @@ @copying This file documents Message, the Emacs message composition mode. -Copyright @copyright{} 1996-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1996--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -21,8 +21,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -477,7 +476,7 @@ You can use one or more of the above variables. All their values are Now you are all set. Just start composing a message as you normally do. And just send it; as always. Just before the message is sent out, Gnus' MFT generation thingy kicks in and checks if the message already has a -MFT field. If there is one, it is left alone. (Except if it's empty - +MFT field. If there is one, it is left alone. (Except if it's empty; in that case, the field is removed and is not replaced with an automatically generated one. This lets you disable MFT generation on a per-message basis.) If there is none, then the list of recipient @@ -2207,12 +2206,12 @@ This function won't add the header if the header is already present. @item message-send-mail-hook @vindex message-send-mail-hook -Hook run before sending mail messages. This hook is run very late -- +Hook run before sending mail messages. This hook is run very late: just before the message is actually sent as mail. @item message-send-news-hook @vindex message-send-news-hook -Hook run before sending news messages. This hook is run very late -- +Hook run before sending news messages. This hook is run very late: just before the message is actually sent as news. @item message-sent-hook diff --git a/doc/misc/mh-e.texi b/doc/misc/mh-e.texi index 06ab93f91c7..756d5d52996 100644 --- a/doc/misc/mh-e.texi +++ b/doc/misc/mh-e.texi @@ -24,7 +24,8 @@ This is version @value{VERSION}@value{EDITION} of @cite{The MH-E Manual}, last updated @value{UPDATED}. -Copyright @copyright{} 1995, 2001-2003, 2005-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1995, 2001--2003, 2005--2013 Free Software +Foundation, Inc. @c This dual license has been agreed upon by the FSF. @@ -41,8 +42,7 @@ Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License.'' (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @item the GNU General Public License as published by the Free Software @@ -215,7 +215,7 @@ The MH-E package is distributed with Emacs@footnote{Version @value{VERSION} of MH-E appeared in Emacs 24.4. It is supported in GNU Emacs 23 and higher, as well as XEmacs 21.4.22 and 21.5.31. MH-E is known not to work with GNU Emacs versions 20 and below, and XEmacs -version 21.5.9 - 21.5.16. It is compatible with MH versions 6.8.4 and +version 21.5.9--21.5.16. It is compatible with MH versions 6.8.4 and higher, all versions of nmh, and GNU mailutils 1.0 and higher}, so you shouldn't have to do anything special to use it. Gnus is also required; version 5.10 or higher is recommended. This manual covers @@ -5645,7 +5645,7 @@ The command @kbd{C-c C-w} (@code{mh-check-whom}) expands aliases so you can check the actual address(es) in the alias. A new buffer named @samp{*MH-E Recipients*} is created with the output of @command{whom} (@pxref{Miscellaneous})@footnote{See the section -@uref{@value{MH-BOOK-HOME}/senove.html#WhaPro, What now? -- and the +@uref{@value{MH-BOOK-HOME}/senove.html#WhaPro, What now?---and the whatnow Program} in the MH book.}. @node Sending Message, Killing Draft, Checking Recipients, Editing Drafts @@ -7763,7 +7763,7 @@ all of your interesting messages and add a couple of points to be conservative. Add that many dots to the @samp{X-Spam-Level:} header field above to send messages with that score down the drain. -In the example above, messages with a score of 5-9 are set aside in +In the example above, messages with a score of 5--9 are set aside in the @samp{+spam} folder for later review. The major weakness of rules-based filters is a plethora of false positives so it is worthwhile to check. @@ -8665,7 +8665,7 @@ In order to send mail within Gnus using MH-E, set this option to Since Gnus keeps track of which messages you have read, it would be bad if Gnus expired the last message, for example, message 100, and @command{rcvstore} gave the next new message number 1. Gnus would then -ignore it since it thinks that you've read messages 1-100. Turning on +ignore it since it thinks that you've read messages 1--100. Turning on this option ensures that the last message is never removed thereby eliminating this problem. @end vtable @@ -8882,7 +8882,7 @@ same structure as MH-E (i.e., invoked MH programs), though it was simpler and the commands were slightly different. Unfortunately, I no longer have a copy so the differences are lost in the mists of time. -In '82-83, I was working at BBN and wrote a lot of mlisp code in +In '82--83, I was working at BBN and wrote a lot of mlisp code in Gosling Emacs to make it look more like Tennex Emacs. One of the packages that I picked up and improved was Reid's mail system. In '83, I went back to Berkeley. About that time, Stallman's first version of diff --git a/doc/misc/newsticker.texi b/doc/misc/newsticker.texi index 60510f41e71..8f37453524c 100644 --- a/doc/misc/newsticker.texi +++ b/doc/misc/newsticker.texi @@ -13,7 +13,7 @@ This manual is for Newsticker (version @value{VERSION}, @value{UPDATED}). @noindent -Copyright @copyright{} 2004-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2004--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -24,8 +24,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -35,7 +34,7 @@ developing GNU and promoting software freedom.'' @end direntry @titlepage -@title Newsticker -- a Newsticker for Emacs +@title Newsticker---a Newsticker for Emacs @subtitle for version @value{VERSION}, @value{UPDATED} @author Ulf Jasper @author @email{ulf.jasper@@web.de} @@ -132,8 +131,8 @@ which contains @file{xml.el} for XEmacs. Newsticker retrieves headlines either via Emacs's built-in retrieval functions, by an arbitrary external program that retrieves files via http and prints them to stdout (like -@uref{http://www.gnu.org/software/wget/wget.html, wget}, or -- on a -per feed basis -- via an arbitrary Lisp command. +@uref{http://www.gnu.org/software/wget/wget.html, wget}, or---on a +per feed basis---via an arbitrary Lisp command. @node Installation diff --git a/doc/misc/nxml-mode.texi b/doc/misc/nxml-mode.texi index a0e34b2cf5a..13e91d12819 100644 --- a/doc/misc/nxml-mode.texi +++ b/doc/misc/nxml-mode.texi @@ -8,25 +8,18 @@ This manual documents nXML mode, an Emacs major mode for editing XML with RELAX NG support. -Copyright @copyright{} 2007-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2007--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no -Invariant Sections, with the Front-Cover texts being ``A GNU -Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the -license is included in the section entitled ``GNU Free Documentation -License'' in the Emacs manual. +Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' +and with the Back-Cover Texts as in (a) below. A copy of the license +is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' - -This document is part of a collection distributed under the GNU Free -Documentation License. If you want to distribute this document -separately from the collection, you can do so by adding a copy of the -license to the document, as described in section 6 of the license. +modify this GNU manual.'' @end quotation @end copying @@ -51,6 +44,7 @@ This manual is not yet complete. * Locating a schema:: * DTDs:: * Limitations:: +* GNU Free Documentation License:: The license for this documentation. @end menu @node Introduction @@ -899,4 +893,8 @@ The restrictions on RELAX NG schemas in section 7 of the RELAX NG specification are not enforced. @end itemize +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + @bye diff --git a/doc/misc/org.texi b/doc/misc/org.texi index 4ff91976c37..bea130ccb43 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi @@ -262,7 +262,7 @@ @copying This manual is for Org version @value{VERSION}. -Copyright @copyright{} 2004-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2004--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -273,13 +273,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License.'' (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' - -This document is part of a collection distributed under the GNU Free -Documentation License. If you want to distribute this document -separately from the collection, you can do so by adding a copy of the -license to the document, as described in section 6 of the license. +modify this GNU manual.'' @end quotation @end copying @@ -305,6 +299,9 @@ with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, @contents @ifnottex +@c FIXME These hand-written next,prev,up node pointers make editing a lot +@c harder. There should be no need for them, makeinfo can do it +@c automatically for any document with a normal structure. @node Top, Introduction, (dir), (dir) @top Org Mode Manual @@ -330,6 +327,7 @@ with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, * Hacking:: How to hack your way around * MobileOrg:: Viewing and capture on a mobile device * History and Acknowledgments:: How Org came into being +* GNU Free Documentation License:: The license for this documentation. * Main Index:: An index of Org's concepts and features * Key Index:: Key bindings and where they are described * Command and Function Index:: Command names and some internal functions @@ -986,7 +984,7 @@ default. If you are using an earlier version of Emacs, add this line to your (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode)) @end lisp -Org mode buffers need font-lock to be turned on - this is the default in +Org mode buffers need font-lock to be turned on: this is the default in Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}. @@ -2687,7 +2685,7 @@ computations in Lisp: '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2)) @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}} '(+ $1 $2);N -@r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}} +@r{Compute the sum of columns 1--4, like Calc's @code{vsum($1..$4)}} '(apply '+ '($1..$4));N @end example @@ -3029,7 +3027,7 @@ lines will be left alone by this command. Selects this line for global recalculation with @kbd{C-u C-c *}, but not for automatic recalculation. Use this when automatic recalculation slows down editing too much. -@item +@item @ Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}. All lines that should be recalculated should be marked with @samp{#} or @samp{*}. @@ -3376,7 +3374,7 @@ buffer: For Org files, if there is a @samp{<<target>>} at the cursor, the link points to the target. Otherwise it points to the current headline, which will also be the description@footnote{If the headline contains a timestamp, it will be -removed from the link and result in a wrong link -- you should avoid putting +removed from the link and result in a wrong link---you should avoid putting timestamp in the headline.}. @vindex org-link-to-org-use-id @@ -5052,7 +5050,7 @@ FILE @r{The filename the entry is located in.} To create sparse trees and special lists with selection based on properties, the same commands are used as for tag searches (@pxref{Tag searches}). @table @kbd -@orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree} +@orgcmdkkc{C-c / m,C-c @backslashchar{},org-match-sparse-tree} Create a sparse tree with all matching entries. With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. @orgcmd{C-c a m,org-tags-view} @@ -5238,8 +5236,8 @@ same summary information. The @code{est+} summary type requires further explanation. It is used for combining estimates, expressed as low-high ranges. For example, instead of estimating a particular task will take 5 days, you might estimate it as -5-6 days if you're fairly confident you know how much work is required, or -1-10 days if you don't really know what needs to be done. Both ranges +5--6 days if you're fairly confident you know how much work is required, or +1--10 days if you don't really know what needs to be done. Both ranges average at 5.5 days, but the first represents a more predictable delivery. When combining a set of such estimates, simply adding the lows and highs @@ -5249,7 +5247,7 @@ from the sum. For example, suppose you had ten tasks, each of which was estimated at 0.5 to 2 days of work. Straight addition produces an estimate of 5 to 20 days, representing what to expect if everything goes either extremely well or extremely poorly. In contrast, @code{est+} estimates the -full job more realistically, at 10-15 days. +full job more realistically, at 10--15 days. Here is an example for a complete columns definition, along with allowed values. @@ -6541,7 +6539,7 @@ suggestion.} for capturing new material. @table @kbd @orgcmd{C-c c,org-capture} Call the command @code{org-capture}. Note that this keybinding is global and -not active by default - you need to install it. If you have templates +not active by default; you need to install it. If you have templates @cindex date tree defined @pxref{Capture templates}, it will offer these templates for selection or use a new Org outline node as the default template. It will @@ -8119,7 +8117,7 @@ February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or month view, a year may be encoded in the prefix argument as well. For example, @kbd{200712 w} will jump to week 12 in 2007. If such a year specification has only one or two digits, it will be mapped to the interval -1938-2037. @kbd{v @key{SPC}} will reset to what is set in +1938--2037. @kbd{v @key{SPC}} will reset to what is set in @code{org-agenda-span}. @c @orgcmd{f,org-agenda-later} @@ -8278,7 +8276,7 @@ You can then filter for an effort by first typing an operator, one of @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort estimate in your array of allowed values, where @kbd{0} means the 10th value. The filter will then restrict to entries with effort smaller-or-equal, equal, -or larger-or-equal than the selected value. If the digits 0-9 are not used +or larger-or-equal than the selected value. If the digits 0--9 are not used as fast access keys to tags, you can also simply press the index digit directly without an operator. In this case, @kbd{<} will be assumed. For application of the operator, entries without a defined effort will be treated @@ -8336,7 +8334,7 @@ selected. @tsubheading{Remote editing} @cindex remote editing, from agenda -@item 0-9 +@item 0--9 Digit argument. @c @cindex undoing remote-editing events @@ -11150,7 +11148,7 @@ files directly, or generate the required styles using an application like LibreOffice. The latter method is suitable for expert and non-expert users alike, and is described here. -@subsubsection Applying custom styles - the easy way +@subsubsection Applying custom styles: the easy way @enumerate @item @@ -11163,8 +11161,8 @@ to ODT format. @item Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist} -to locate the target styles - these typically have the @samp{Org} prefix - -and modify those to your taste. Save the modified file either as an +to locate the target styles---these typically have the @samp{Org} prefix---and +modify those to your taste. Save the modified file either as an OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file. @item @@ -11217,8 +11215,8 @@ with a cross-reference and sequence number of the labeled entity. @cindex tables, in DocBook export Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el} -tables is supported. However, export of complex @file{table.el} tables - -tables that have column or row spans - is not supported. Such tables are +tables is supported. However, export of complex @file{table.el} tables---tables +that have column or row spans---is not supported. Such tables are stripped from the exported document. By default, a table is exported with top and bottom frames and with rules @@ -11350,7 +11348,7 @@ height:width ratio, do the following @cindex #+ATTR_ODT You can control the manner in which an image is anchored by setting the @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one -of the the following three values for the @code{:anchor} property - +of the the following three values for the @code{:anchor} property: @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}. To create an image that is anchored to a page, do the following: @@ -11456,8 +11454,8 @@ or @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export @subsection Labels and captions in ODT export -You can label and caption various category of objects - an inline image, a -table, a @LaTeX{} fragment or a Math formula - using @code{#+LABEL} and +You can label and caption various category of objects---an inline image, a +table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates each labeled or captioned object of a given category separately. As a result, each such object is assigned a sequence number based on order of it's @@ -11621,8 +11619,8 @@ the exporter. @item It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>} -elements that control how various entities - tables, images, equations etc - -are numbered. +elements that control how various entities---tables, images, equations, +etc.---are numbered. @end enumerate @end itemize @@ -11756,7 +11754,7 @@ OpenDocument-v1.2 Specification}} -@subsubheading Custom table styles - an illustration +@subsubheading Custom table styles: an illustration To have a quick preview of this feature, install the below setting and export the table that follows. @@ -11788,7 +11786,7 @@ Template} in @file{OrgOdtContentTemplate.xml} (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need additional templates you have to define these styles yourselves. -@subsubheading Custom table styles - the nitty-gritty +@subsubheading Custom table styles: the nitty-gritty To use this feature proceed as follows: @enumerate @@ -14802,7 +14800,7 @@ These lines (several are allowed) specify link abbreviations. @vindex org-lowest-priority @vindex org-default-priority This line sets the limits and the default for the priorities. All three -must be either letters A-Z or numbers 0-9. The highest priority must +must be either letters A--Z or numbers 0--9. The highest priority must have a lower ASCII number than the lowest priority. @item #+PROPERTY: Property_Name Value This line sets a default inheritance value for entries in the current @@ -14811,7 +14809,7 @@ buffer, most useful for specifying the allowed values of a property. @item #+SETUPFILE: file This line defines a file that holds more in-buffer setup. Normally this is entirely ignored. Only when the buffer is parsed for option-setting lines -(i.e.@: when starting Org mode for a file, when pressing @kbd{C-c C-c} in a +(i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a settings line, or when exporting), then the contents of this file are parsed as if they had been included in the buffer. In particular, the file can be any other Org mode file with internal setup. You can visit the file the @@ -15106,7 +15104,7 @@ indentation shifts by two@footnote{See the variable stars but the last one are made invisible using the @code{org-hide} face@footnote{Turning on @code{org-indent-mode} sets @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to -@code{nil}.} - see below under @samp{2.} for more information on how this +@code{nil}.}; see below under @samp{2.} for more information on how this works. You can turn on @code{org-indent-mode} for all files by customizing the variable @code{org-startup-indented}, or you can turn it on for individual files using @@ -15173,7 +15171,7 @@ example using the color @code{grey90} on a white background. Things become cleaner still if you skip all the even levels and use only odd levels 1, 3, 5..., effectively adding two stars to go from one outline level to the next@footnote{When you need to specify a level for a property search -or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this +or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this way we get the outline view shown at the beginning of this section. In order to make the structure editing and export commands handle this convention correctly, configure the variable @code{org-odd-levels-only}, or set this on @@ -15264,7 +15262,7 @@ names for natural constants or units. Instead of defining your own constants in the variable @code{org-table-formula-constants}, install the @file{constants} package which defines a large number of constants and units, and lets you use unit prefixes like @samp{M} for -@samp{Mega}, etc@. You will need version 2.0 of this package, available +@samp{Mega}, etc. You will need version 2.0 of this package, available at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for the function @code{constants-get}, which has to be autoloaded in your setup. See the installation instructions in the file @@ -16606,7 +16604,7 @@ last pull. This might include a file that is not currently in your list of agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only the current agenda files will be searched.} using @kbd{C-c a ?}. -@node History and Acknowledgments, Main Index, MobileOrg, Top +@node History and Acknowledgments, GNU Free Documentation License, MobileOrg, Top @appendix History and acknowledgments @cindex acknowledgments @cindex history @@ -16715,7 +16713,7 @@ a great help, and the list would not be so active without him. @end table I received support from so many users that it is clearly impossible to be -fair when shortlisting a few of them -- but Org's history would not be +fair when shortlisting a few of them, but Org's history would not be complete if the ones above were not mentioned in this manual. @section List of contributions @@ -16949,7 +16947,12 @@ and contributed various ideas and code snippets. @end itemize -@node Main Index, Key Index, History and Acknowledgments, Top +@node GNU Free Documentation License, Main Index, History and Acknowledgments, Top +@appendix GNU Free Documentation License +@include doclicense.texi + + +@node Main Index, Key Index, GNU Free Documentation License, Top @unnumbered Concept index @printindex cp diff --git a/doc/misc/pcl-cvs.texi b/doc/misc/pcl-cvs.texi index 993ddc22d43..7c294591d0e 100644 --- a/doc/misc/pcl-cvs.texi +++ b/doc/misc/pcl-cvs.texi @@ -1,12 +1,12 @@ \input texinfo @c -*-texinfo-*- @c %**start of header @setfilename ../../info/pcl-cvs -@settitle PCL-CVS --- Emacs Front-End to CVS +@settitle PCL-CVS---Emacs Front-End to CVS @syncodeindex vr fn @c %**end of header @copying -Copyright @copyright{} 1991-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1991--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -17,8 +17,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -32,10 +31,10 @@ developing GNU and promoting software freedom.'' @sp 4 @c The title is printed in a large font. @center @titlefont{User's Guide} -@sp +@sp 1 @center @titlefont{to} -@sp -@center @titlefont{PCL-CVS --- The Emacs Front-End to CVS} +@sp 1 +@center @titlefont{PCL-CVS---The Emacs Front-End to CVS} @ignore @sp 2 @center release 2.9 @@ -59,8 +58,8 @@ developing GNU and promoting software freedom.'' @c The real text starts here @c ================================================================ -@node Top, About PCL-CVS, (dir), (dir) @ifnottex +@node Top @top PCL-CVS This manual describes PCL-CVS, the GNU Emacs front-end to CVS@. It @@ -128,7 +127,7 @@ Customization @end detailmenu @end menu -@node About PCL-CVS, Getting started, Top, Top +@node About PCL-CVS @chapter About PCL-CVS @cindex About PCL-CVS @@ -152,7 +151,7 @@ functionality and taking over the maintenance. * Contributors:: Contributors to PCL-CVS. @end menu -@node Contributors,, About PCL-CVS, About PCL-CVS +@node Contributors @section Contributors to PCL-CVS @cindex Contributors @cindex Authors @@ -229,7 +228,7 @@ requests, bug reports and encouragement. Thanks a lot! Without you there would be no new releases of PCL-CVS. -@node Getting started, Buffer contents, About PCL-CVS, Top +@node Getting started @chapter Getting started @cindex Introduction @cindex Example run @@ -297,7 +296,7 @@ press @kbd{l} to get the output from @samp{cvs log}. Many more such commands are available simply by pressing a key (@pxref{Getting info about files}). -@node Buffer contents, Selected files, Getting started, Top +@node Buffer contents @chapter Buffer contents @cindex Buffer contents @cindex @code{*cvs*} buffer contents @@ -426,7 +425,7 @@ The file has been unexpectedly removed from your working directory although it has not been @samp{cvs remove}d. @end table -@node Selected files, Commands, Buffer contents, Top +@node Selected files @chapter Selected files @cindex Selected files @cindex Marked files @@ -468,7 +467,7 @@ it, it is quite powerful. For commands to mark and unmark files, see @ref{Marking files}. -@node Commands, Log Edit Mode, Selected files, Top +@node Commands @chapter Commands @iftex @@ -502,7 +501,7 @@ you can use in PCL-CVS@. They are grouped together by type. @end menu -@node Entering PCL-CVS, Setting flags, Commands, Commands +@node Entering PCL-CVS @section Entering PCL-CVS @findex cvs-update @findex cvs-examine @@ -562,7 +561,7 @@ argument to the command (e.g., by typing @kbd{C-u M-x cvs-update @key{RET} -l @key{RET}}). -@node Setting flags, Updating the buffer, Entering PCL-CVS, Commands +@node Setting flags @section Setting flags for CVS commands @cindex Optional switches to CVS @cindex Command-line options to CVS @@ -618,7 +617,7 @@ Forces the next command to apply to every selected file rather than only to the ones PCL-CVS thinks are relevant. @end table -@node Updating the buffer, Movement commands, Setting flags, Commands +@node Updating the buffer @section Updating the @samp{*cvs*} buffer @findex cvs-update @findex cvs-examine @@ -663,7 +662,7 @@ put in @samp{cvs-status-mode}.@refill @end table -@node Movement commands, Marking files, Updating the buffer, Commands +@node Movement commands @section Movement Commands @cindex Movement Commands @findex cvs-mode-next-line @@ -683,13 +682,13 @@ the fact that the buffer is a PCL-CVS buffer: These keys move the cursor one file forward, towards the end of the buffer (@code{cvs-mode-next-line}).@refill -@itemx p +@item p This key moves one file backward, towards the beginning of the buffer (@code{cvs-mode-previous-line}). @end table -@node Marking files, Committing changes, Movement commands, Commands +@node Marking files @section Marking files @cindex Selecting files (commands to mark files) @cindex Marking files @@ -747,7 +746,7 @@ Toggle use of marks for the next command (@code{cvs-mode-toggle-marks}). @end table -@node Committing changes, Editing files, Marking files, Commands +@node Committing changes @section Committing changes @cindex Committing changes @findex cvs-mode-commit @@ -806,7 +805,7 @@ your buffer, or if @samp{cvs-auto-revert} is set to @samp{nil}. -@node Editing files, Getting info about files, Committing changes, Commands +@node Editing files @section Editing files @cindex Editing files @cindex Finding files @@ -843,7 +842,7 @@ directory (@code{cvs-mode-add-change-log-entry-other-window}).@refill @end table -@node Getting info about files, Adding and removing files, Editing files, Commands +@node Getting info about files @section Getting info about files @cindex Status (cvs command) @cindex Log (RCS/cvs command) @@ -868,7 +867,7 @@ all selected files, and show the result in a temporary buffer @end table -@node Adding and removing files, Undoing changes, Getting info about files, Commands +@node Adding and removing files @section Adding and removing files @cindex Adding files @cindex Removing files @@ -909,7 +908,7 @@ The command that is run is @code{cvs-mode-remove-file}. @end table -@node Undoing changes, Removing handled entries, Adding and removing files, Commands +@node Undoing changes @section Undoing changes @cindex Undo changes @cindex Flush changes @@ -925,7 +924,7 @@ version from the repository (@code{cvs-mode-undo-local-changes}). @end table -@node Removing handled entries, Ignoring files, Undoing changes, Commands +@node Removing handled entries @section Removing handled entries @cindex Expunging uninteresting entries @cindex Uninteresting entries, getting rid of them @@ -957,7 +956,7 @@ not delete, but that you want to delete (@code{cvs-mode-acknowledge}). @end table -@node Ignoring files, Viewing differences, Removing handled entries, Commands +@node Ignoring files @section Ignoring files @cindex Ignoring files @kindex i@r{--ignoring files} @@ -975,7 +974,7 @@ but you could ignore it as well, if you like it better that way. This runs @code{cvs-mode-ignore}. @end table -@node Viewing differences, Invoking Ediff, Ignoring files, Commands +@node Viewing differences @section Viewing differences @cindex Diff @cindex Invoking @code{diff} @@ -1038,7 +1037,7 @@ head revision in the repository By default, @samp{diff} commands ignore the marks. This can be changed with @code{cvs-invert-ignore-marks}. -@node Invoking Ediff, Updating files, Viewing differences, Commands +@node Invoking Ediff @section Running ediff @cindex Ediff @cindex Invoking ediff @@ -1070,7 +1069,7 @@ any way if you use this command. If you use the @kbd{q} command inside created will be overwritten.@refill @end table -@node Updating files, Tagging files, Invoking Ediff, Commands +@node Updating files @section Updating files @findex cvs-mode-update @cindex Updating files @@ -1083,7 +1082,7 @@ Update all selected files with status @samp{Need-update} by running @end table -@node Tagging files, Miscellaneous commands, Updating files, Commands +@node Tagging files @section Tagging files @findex cvs-mode-tag @findex cvs-mode-untag @@ -1110,7 +1109,7 @@ only be applied to directories, see @code{cvs-force-dir-tag} if you want to change this behavior. -@node Miscellaneous commands, , Tagging files, Commands +@node Miscellaneous commands @section Miscellaneous commands @findex cvs-mode-byte-compile-files @cindex Recompiling elisp files @@ -1155,7 +1154,7 @@ Bury the PCL-CVS buffer (@code{cvs-bury-buffer}). Quit PCL-CVS, killing the @samp{*cvs*} buffer. @end table -@node Log Edit Mode, Log View Mode, Commands, Top +@node Log Edit Mode @chapter Editing a Log Message @cindex Log Edit mode @@ -1170,13 +1169,13 @@ kill the contents of the buffer with @kbd{C-w}. @findex log-edit-insert-changelog If you work by writing entries in the @file{ChangeLog} -(@pxref{(emacs)Change Log}) and then commit the change under revision +(@pxref{Change Log,,, emacs, The GNU Emacs Manual}) and then commit the change under revision control, you can generate the Log Edit text from the ChangeLog using @kbd{C-c C-a} (@kbd{log-edit-insert-changelog}). This looks for entries for the file(s) concerned in the top entry in the ChangeLog and uses those paragraphs as the log text. This text is only inserted if the top entry was made under your user name on the current date. -@xref{(emacs)Change Logs and VC}, for the opposite way of +@xref{Change Logs and VC,,, emacs, The GNU Emacs Manual}, for the opposite way of working---generating ChangeLog entries from the revision control log. In the Log Edit buffer, @kbd{C-c C-f} (@kbd{M-x log-edit-show-files}) @@ -1188,7 +1187,7 @@ exit the buffer and commit the change. @c Fixme: customization variables -@node Log View Mode, Customization, Log Edit Mode, Top +@node Log View Mode @chapter Browsing a Log of Changes @cindex Log View mode @@ -1209,7 +1208,7 @@ argument, these commands move that many messages of files. @c @node CVS Status Mode @c @chapter Viewing CVS' Status output -@node Customization, Bugs, Log View Mode, Top +@node Customization @chapter Customization @vindex log-edit-changelog-full-paragraphs@r{ (variable)} @vindex cvs-auto-remove-handled@r{ (variable)} @@ -1320,7 +1319,7 @@ default. * Customizing Faces:: @end menu -@node Customizing Faces, , Customization, Customization +@node Customizing Faces @section Customizing Faces @vindex cvs-header (face) @vindex cvs-filename (face) @@ -1359,7 +1358,7 @@ Used to highlight CVS messages. @end table -@node Bugs, GNU Free Documentation License, Customization, Top +@node Bugs @chapter Bugs (known and unknown) @cindex Reporting bugs and ideas @cindex Bugs, how to report them @@ -1399,13 +1398,13 @@ output of the CVS process (which should be found in the @samp{ *cvs-tmp*} buffer), and the versions of Emacs, PCL-CVS and CVS you are using. @end table -@node GNU Free Documentation License, Function and Variable Index, Bugs, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Function and Variable Index, Concept Index, GNU Free Documentation License, Top +@node Function and Variable Index @unnumbered Function and Variable Index This is an index of all the functions and variables documented in this @@ -1413,14 +1412,14 @@ manual. @printindex fn -@node Concept Index, Key Index, Function and Variable Index, Top +@node Concept Index @unnumbered Concept Index This is an index of concepts discussed in this manual. @printindex cp -@node Key Index, , Concept Index, Top +@node Key Index @unnumbered Key Index This index includes an entry for each PCL-CVS key sequence documented in diff --git a/doc/misc/pgg.texi b/doc/misc/pgg.texi index 0ea0bbf84d1..bb40a9f541d 100644 --- a/doc/misc/pgg.texi +++ b/doc/misc/pgg.texi @@ -2,16 +2,16 @@ @include gnus-overrides.texi +@set VERSION 0.1 + @setfilename ../../info/pgg @settitle PGG @value{VERSION} -@set VERSION 0.1 - @copying This file describes PGG @value{VERSION}, an Emacs interface to various PGP implementations. -Copyright @copyright{} 2001, 2003-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2001, 2003--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -22,8 +22,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License.'' (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying diff --git a/doc/misc/rcirc.texi b/doc/misc/rcirc.texi index b72211111a7..3bce0c7c24b 100644 --- a/doc/misc/rcirc.texi +++ b/doc/misc/rcirc.texi @@ -5,8 +5,7 @@ @c %**end of header @copying -Copyright @copyright{} 2006-2012 -Free Software Foundation, Inc. +Copyright @copyright{} 2006--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -17,8 +16,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -37,7 +35,7 @@ developing GNU and promoting software freedom.'' @contents @ifnottex -@node Top, Basics, (dir), (dir) +@node Top @top rcirc Manual @code{rcirc} is an Emacs IRC client. @@ -94,7 +92,7 @@ Hacking and Tweaking @end detailmenu @end menu -@node Basics, Reference, Top, Top +@node Basics @chapter Basics This chapter contains a brief introduction to IRC (Internet Relay Chat), @@ -105,7 +103,7 @@ and a quick tutorial on @code{rcirc}. * Getting started with rcirc:: @end menu -@node Internet Relay Chat, Getting started with rcirc, Basics, Basics +@node Internet Relay Chat @section Internet Relay Chat @cindex internet relay chat @cindex irc @@ -158,7 +156,7 @@ deego: fsbot rules! @kindex TAB Since this is so common, you can use @key{TAB} to do nick completion. -@node Getting started with rcirc, , Internet Relay Chat, Basics +@node Getting started with rcirc @section Getting started with rcirc @cindex getting started @cindex connecting to a server @@ -247,7 +245,7 @@ To make this permanent, add the following to your init file: Use @kbd{C-c C-@key{SPC}} to switch to these buffers. -@node Reference, Fighting Information Overload, Basics, Top +@node Reference @chapter Reference @cindex reference @@ -261,7 +259,7 @@ documentation. * Configuration:: @end menu -@node rcirc commands, Useful IRC commands, Reference, Reference +@node rcirc commands @section rcirc commands @cindex rcirc commands @cindex commands @@ -404,7 +402,7 @@ buffer, you automatically quit the server and part all channels. (Also @code{/quit ZZZzzz...}.) @end table -@node Useful IRC commands, Configuration, rcirc commands, Reference +@node Useful IRC commands @section Useful IRC commands @cindex irc commands @cindex commands @@ -432,7 +430,7 @@ about the fantastic world of IRC online at @uref{http://www.irchelp.org/, the Internet Relay Chat (IRC) help archive}. -@node Configuration, , Useful IRC commands, Reference +@node Configuration @section Configuration @cindex configuring rcirc @@ -596,7 +594,7 @@ confuse the Bitlbee account with all the other accounts. @end table -@node Fighting Information Overload, Hacking and Tweaking, Reference, Top +@node Fighting Information Overload @chapter Fighting Information Overload @cindex information overload @@ -612,7 +610,7 @@ daunting task. This chapters tells you how @code{rcirc} can help. * Notices:: @end menu -@node Channels, People, Fighting Information Overload, Fighting Information Overload +@node Channels @section Channels @cindex channels @cindex modeline @@ -670,7 +668,7 @@ If you prefer a channel to never show up in the modeline, then you have to ignore it. Use @kbd{C-c @key{TAB}} to ignore the current channel. -@node People, Keywords, Channels, Fighting Information Overload +@node People @section People @cindex people, how to ignore @cindex nicks, how to ignore @@ -728,7 +726,7 @@ messages by dimmed nicks will not register as activity. Example: @end table -@node Keywords, Notices, People, Fighting Information Overload +@node Keywords @section Keywords @cindex keywords @@ -744,7 +742,7 @@ one. If you don't provide a keyword, the current keywords are listed. Example: @code{/keyword manual}. @end table -@node Notices, , Keywords, Fighting Information Overload +@node Notices @section Notices @cindex part notices, how to omit @cindex join notices, how to omit @@ -776,7 +774,7 @@ active and only omits a message if the nick has not been active. The window @code{rcirc} considers is controlled by the @code{rcirc-omit-threshold} variable. -@node Hacking and Tweaking, GNU Free Documentation License, Fighting Information Overload, Top +@node Hacking and Tweaking @chapter Hacking and Tweaking @cindex hacking and tweaking @@ -791,7 +789,7 @@ Here are some examples of stuff you can do to configure @code{rcirc}. * Reconnecting after you have lost the connection:: @end menu -@node Skipping /away messages using handlers, Using fly spell mode, Hacking and Tweaking, Hacking and Tweaking +@node Skipping /away messages using handlers @section Skipping @code{/away} messages using handlers @cindex /away messages @@ -811,7 +809,7 @@ require @code{rcirc} before defining the handler: "/away message handler.") @end example -@node Using fly spell mode, Scrolling conservatively, Skipping /away messages using handlers, Hacking and Tweaking +@node Using fly spell mode @section Using fly spell mode @cindex fly spell @cindex spelling @@ -830,7 +828,7 @@ for @code{rcirc} buffers: @xref{Spelling, , Flyspell mode, emacs, The GNU Emacs Manual}, for details. -@node Scrolling conservatively, Changing the time stamp format, Using fly spell mode, Hacking and Tweaking +@node Scrolling conservatively @section Scrolling conservatively @cindex input line @cindex scrolling @@ -852,7 +850,7 @@ window when possible. The following snippet uses a local value for @xref{Scrolling, , Scrolling conservatively, emacs, The GNU Emacs Manual}, for details. -@node Changing the time stamp format, Defining a new command, Scrolling conservatively, Hacking and Tweaking +@node Changing the time stamp format @section Changing the time stamp format @cindex time stamp @cindex date time @@ -866,7 +864,7 @@ how to include the date in the time stamp: (setq rcirc-time-format "%Y-%m-%d %H:%M ") @end example -@node Defining a new command, Reconnecting after you have lost the connection, Changing the time stamp format, Hacking and Tweaking +@node Defining a new command @section Defining a new command @cindex defining commands @cindex commands, defining @@ -889,7 +887,7 @@ because @code{defun-rcirc-command} is not yet available, and without (concat "I use " rcirc-id-string)))) @end smallexample -@node Reconnecting after you have lost the connection, , Defining a new command, Hacking and Tweaking +@node Reconnecting after you have lost the connection @section Reconnecting after you have lost the connection @cindex reconnecting @cindex disconnecting servers, reconnecting @@ -900,7 +898,7 @@ client doesn't realize that it has been disconnected. It takes several minutes until the client decides that the connection has in fact been lost. The simple solution is to use @kbd{M-x rcirc}. The problem is that this opens an @emph{additional} connection, so you'll have two -copies of every channel buffer --- one dead and one live. +copies of every channel buffer, one dead and one live. The real answer, therefore, is a @code{/reconnect} command: @@ -930,20 +928,20 @@ The real answer, therefore, is a @code{/reconnect} command: channels)))) @end smallexample -@node GNU Free Documentation License, Key Index, Hacking and Tweaking, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Key Index, Variable Index, GNU Free Documentation License, Top +@node Key Index @unnumbered Key Index @printindex ky -@node Variable Index, Index, Key Index, Top +@node Variable Index @unnumbered Variable Index @printindex vr -@node Index, , Variable Index, Top +@node Index @unnumbered Index @printindex cp diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi index a6339e72de6..0ee206b1a4d 100644 --- a/doc/misc/reftex.texi +++ b/doc/misc/reftex.texi @@ -45,7 +45,7 @@ This manual documents @RefTeX{} (version @value{VERSION}), a package to do labels, references, citations and indices for LaTeX documents with Emacs. -Copyright @copyright{} 1997-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1997--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -56,8 +56,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -96,7 +95,7 @@ developing GNU and promoting software freedom.'' @contents @ifnottex -@node Top,,,(dir) +@node Top @top @RefTeX{} @RefTeX{} is a package for managing Labels, References, Citations and @@ -124,14 +123,13 @@ other parts of this document when needed. * Multifile Documents:: Document spread over many files. * Language Support:: How to support other languages. * Finding Files:: Included @TeX{} files and @BibTeX{} .bib files. -* AUCTeX:: Cooperation with @AUCTeX{}. * Optimizations:: When RefTeX is too slow. +* AUCTeX:: Cooperation with @AUCTeX{}. * Problems and Work-Arounds:: First Aid. * Imprint:: Author, Web-site, Thanks * Commands:: Which are the available commands. * Options:: How to extend and configure RefTeX. -* Keymaps and Hooks:: For customization. * Changes:: A List of recent changes to RefTeX. * GNU Free Documentation License:: The license for this documentation. @@ -215,7 +213,7 @@ Options, Keymaps, Hooks @end ifnottex -@node Introduction, Table of Contents, , Top +@node Introduction @chapter Introduction @cindex Introduction @@ -243,7 +241,7 @@ reports or suggestions. * RefTeX in a Nutshell:: A brief summary and quick guide. @end menu -@node Installation, RefTeX in a Nutshell, , Introduction +@node Installation @section Installation @cindex Installation @@ -361,7 +359,7 @@ systems these variables do not contain the full search path. If @xref{Finding Files}. @page -@node RefTeX in a Nutshell, , Installation, Introduction +@node RefTeX in a Nutshell @section @RefTeX{} in a Nutshell @cindex Quick-Start @cindex Getting Started @@ -517,7 +515,7 @@ a tutorial way how to use and customize @RefTeX{}. The second part is a command and variable reference. @end enumerate -@node Table of Contents, Labels and References, Introduction, Top +@node Table of Contents @chapter Table of Contents @cindex @file{*toc*} buffer @cindex Structure editing @@ -610,7 +608,7 @@ Promote the current section. This will convert @code{\section} to @code{\chapter}, @code{\subsection} to @code{\section} etc. If there is an active region, all sections in the region will be promoted, including the one at point. To avoid mistakes, @RefTeX{} requires a fresh -document scan before executing this command -- if necessary, it will +document scan before executing this command; if necessary, it will automatically do this scan and ask the user to repeat the promotion command. @@ -626,7 +624,7 @@ useful when a package like @file{fancyref} is used where the label prefix determines the wording of a reference. After a promotion/demotion it may be necessary to change a few labels from @samp{sec:xyz} to @samp{cha:xyz} or vice versa. This command can be -used to do this - it launches a query replace to rename the definition +used to do this; it launches a query replace to rename the definition and all references of a label. @tablesubheading{Exiting} @@ -766,7 +764,7 @@ environments to the table of contents. This is probably only useful for theorem-like environments. @xref{Defining Label Environments}, for an example. -@node Labels and References, Citations, Table of Contents, Top +@node Labels and References @chapter Labels and References @cindex Labels in LaTeX @cindex References in LaTeX @@ -788,7 +786,7 @@ records the figure counter, not the section counter. Several different environments can share a common counter and therefore a common label category. For example labels in both @code{equation} and -@code{eqnarray} environments record the value of the same counter -- the +@code{eqnarray} environments record the value of the same counter: the equation counter. @menu @@ -801,7 +799,7 @@ equation counter. * xr (LaTeX package):: References to external documents. @end menu -@node Creating Labels, Referencing Labels, , Labels and References +@node Creating Labels @section Creating Labels @cindex Creating labels @cindex Labels, creating @@ -868,7 +866,7 @@ If you are using @AUCTeX{} to write your @LaTeX{} documents, you can set it up to delegate the creation of labels to @RefTeX{}. @xref{AUCTeX}, for more information. -@node Referencing Labels, Builtin Label Environments, Creating Labels, Labels and References +@node Referencing Labels @section Referencing Labels @cindex Referencing labels @cindex Labels, referencing @@ -1093,7 +1091,7 @@ package),,xr}). In order to define additional commands for the selection process, the keymap @code{reftex-select-label-map} may be used. -@node Builtin Label Environments, Defining Label Environments, Referencing Labels, Labels and References +@node Builtin Label Environments @section Builtin Label Environments @cindex Builtin label environments @cindex Label environments, builtin @@ -1198,7 +1196,7 @@ If you want to use other labeled environments, defined with @code{\newtheorem}, @RefTeX{} needs to be configured to recognize them (@pxref{Defining Label Environments}). -@node Defining Label Environments, Reference Info, Builtin Label Environments, Labels and References +@node Defining Label Environments @section Defining Label Environments @cindex Label environments, defining @@ -1231,7 +1229,7 @@ Environments}). * Putting it Together:: How to combine many entries. @end menu -@node Theorem and Axiom, Quick Equation, , Defining Label Environments +@node Theorem and Axiom @subsection Theorem and Axiom Environments @cindex @code{theorem}, newtheorem @cindex @code{axiom}, newtheorem @@ -1363,7 +1361,7 @@ and @code{reftex-label-menu-flags} (@pxref{Options (Referencing Labels)}). -@node Quick Equation, Figure Wrapper, Theorem and Axiom , Defining Label Environments +@node Quick Equation @subsection Quick Equation Macro @cindex Quick equation macro @cindex Macros as environment wrappers @@ -1411,7 +1409,7 @@ Reftex Label Alist: [Hide] [ ] Make TOC entry : [Value Menu] No entry @end example -@node Figure Wrapper, Adding Magic Words, Quick Equation, Defining Label Environments +@node Figure Wrapper @subsection Figure Wrapping Macro @cindex Macros as environment wrappers @cindex Figure wrapping macro @@ -1449,8 +1447,8 @@ The empty pairs of brackets indicate the different arguments of the indicates that this is a figure label which will be listed together with labels from normal figure environments. The @code{nil} entries for prefix and reference format mean to use the defaults for figure labels. -The @samp{3} for the context method means to grab the third macro argument --- the caption. +The @samp{3} for the context method means to grab the third macro argument: +the caption. As a side effect of this configuration, @code{reftex-label} will now insert the required naked label (without the @code{\label} macro) when @@ -1471,7 +1469,7 @@ Again, here the configuration in the customization buffer: [ ] Make TOC entry : [Value Menu] No entry @end example -@node Adding Magic Words, Using \eqref, Figure Wrapper, Defining Label Environments +@node Adding Magic Words @subsection Adding Magic Words @cindex Magic words @cindex German magic words @@ -1495,7 +1493,7 @@ predefined label categories. (nil ?i nil nil nil ("Punkt")))) @end lisp -@node Using \eqref, Non-Standard Environments, Adding Magic Words, Defining Label Environments +@node Using \eqref @subsection Using @code{\eqref} @cindex @code{\eqref}, AMS-LaTeX macro @cindex AMS-LaTeX @@ -1519,10 +1517,10 @@ following is equivalent to the line above. @end lisp Note that this is automatically done by the @file{amsmath.el} style file -of @AUCTeX{} (@pxref{Style Files}) -- so if you use @AUCTeX{}, +of @AUCTeX{} (@pxref{Style Files}); so if you use @AUCTeX{}, this configuration will not be necessary. -@node Non-Standard Environments, Putting it Together, Using \eqref, Defining Label Environments +@node Non-Standard Environments @subsection Non-standard Environments @cindex Non-standard environments @cindex Environments without @code{\begin} @@ -1623,7 +1621,7 @@ for @RefTeX{}. (incf cnt)))))))) @end lisp -@node Putting it Together, , Non-Standard Environments, Defining Label Environments +@node Putting it Together @subsection Putting it all together When you have to put several entries into @code{reftex-label-alist}, just @@ -1641,7 +1639,7 @@ the entries described above: (detect-linguex ?x "ex:" "~\\ref@{%s@}" nil ("Example" "Ex.")))) @end lisp -@node Reference Info, Reference Styles, Defining Label Environments, Labels and References +@node Reference Info @section Reference Info @findex reftex-view-crossref @findex reftex-mouse-view-crossref @@ -1663,7 +1661,7 @@ message. @code{\label} macro. @xref{Viewing Cross-References}, for more information. -@node Reference Styles, xr (LaTeX package), Reference Info, Labels and References +@node Reference Styles @section Reference Styles In case you defined your own macros for referencing or you are using @@ -1744,14 +1742,14 @@ package where a macro call like @code{\fref@{@var{fig:map-of-germany}@}} creates not only the number of the referenced counter but also the complete text around it, like @samp{Figure 3 on the preceding page}. In order to make it work you need to use label prefixes like @samp{fig:} -consistently -- something @RefTeX{} does automatically. For each of +consistently---something @RefTeX{} does automatically. For each of these packages a variable could be configured to make its macros to take precedence over @code{\ref}. Those were @code{reftex-vref-is-default} and @code{reftex-fref-is-default} respectively. While still working, these variables are deprecated now. Instead of setting them, the variable @code{reftex-ref-style-default-list} should be adapted now. -@node xr (LaTeX package), , Reference Styles, Labels and References +@node xr (LaTeX package) @section @code{xr}: Cross-Document References @cindex @code{xr}, LaTeX package @cindex LaTeX packages, @code{xr} @@ -1786,7 +1784,7 @@ For this kind of inter-document cross-references, saving of parsing information and the use of multiple selection buffers can mean a large speed-up (@pxref{Optimizations}). -@node Citations, Index Support, Labels and References, Top +@node Citations @chapter Citations @cindex Citations @cindex @code{\cite} @@ -1806,7 +1804,7 @@ support for citations helps to select the correct key quickly. * BibTeX Database Subsets:: Extract parts of a big database. @end menu -@node Creating Citations, Citation Styles, , Citations +@node Creating Citations @section Creating Citations @cindex Creating citations @cindex Citations, creating @@ -1956,7 +1954,7 @@ buffers by adding the following expression to your init file: @end lisp -@node Citation Styles, Citation Info, Creating Citations, Citations +@node Citation Styles @section Citation Styles @cindex Citation styles @cindex Citation styles, @code{natbib} @@ -2021,7 +2019,7 @@ citation style based on the @code{usepackage} commands in a given document. @xref{Style Files}, for information on how to set up the style files correctly. -@node Citation Info, Chapterbib and Bibunits, Citation Styles, Citations +@node Citation Info @section Citation Info @cindex Displaying citations @cindex Citations, displaying @@ -2042,7 +2040,7 @@ entry corresponding to a @code{\cite} macro, or all citation locations corresponding to a @code{\bibitem} or @BibTeX{} database entry. @xref{Viewing Cross-References}. -@node Chapterbib and Bibunits, Citations Outside LaTeX, Citation Info, Citations +@node Chapterbib and Bibunits @section Chapterbib and Bibunits @cindex @code{chapterbib}, LaTeX package @cindex @code{bibunits}, LaTeX package @@ -2057,7 +2055,7 @@ separate file (as it is required for @code{chapterbib} anyway). Then you have multiple bibliographies within a @emph{single file}, this may or may not be the case. -@node Citations Outside LaTeX, BibTeX Database Subsets, Chapterbib and Bibunits, Citations +@node Citations Outside LaTeX @section Citations outside @LaTeX{} @cindex Citations outside LaTeX @vindex reftex-default-bibliography @@ -2082,7 +2080,7 @@ binding for @code{reftex-cite-format}. (reftex-citation)))))) @end lisp -@node BibTeX Database Subsets, , Citations Outside LaTeX, Citations +@node BibTeX Database Subsets @section Database Subsets @cindex BibTeX database subsets @findex reftex-create-bibtex-file @@ -2110,7 +2108,7 @@ entries in the selection buffer with the @kbd{m} key and then export either the @i{marked} entries (with the @kbd{e} key) or the @i{unmarked} entries (with the @kbd{E} key). -@node Index Support, Viewing Cross-References, Citations, Top +@node Index Support @chapter Index Support @cindex Index Support @cindex @code{\index} @@ -2177,7 +2175,7 @@ Style}), or globally for all your documents with * Defining Index Macros:: ... and macros it doesn't. @end menu -@node Creating Index Entries, The Index Phrases File, , Index Support +@node Creating Index Entries @section Creating Index Entries @cindex Creating index entries @cindex Index entries, creating @@ -2208,7 +2206,7 @@ index tag is a string identifying one of multiple indices. With the @file{multind} and @file{index} packages, this tag is the first argument to the redefined @code{\index} macro. -@node The Index Phrases File, Displaying and Editing the Index, Creating Index Entries, Index Support +@node The Index Phrases File @section The Index Phrases File @cindex Index phrase file @cindex Phrase file @@ -2256,7 +2254,7 @@ repeat @var{word} outside the macro. * Global Indexing:: The interactive indexing process. @end menu -@node Collecting Phrases, Consistency Checks, , The Index Phrases File +@node Collecting Phrases @subsection Collecting Phrases @cindex Collecting index phrases @cindex Index phrases, collection @@ -2285,7 +2283,7 @@ format. A phrase line looks like this: @code{<TABs>} stands for white space containing at least one @key{TAB}. @var{key} must be at the start of the line and is the character identifying one of the macros defined in the file header. It is -optional - when omitted, the first macro definition line in the file +optional; when omitted, the first macro definition line in the file will be used for this phrase. The @var{phrase} is the phrase to be searched for when indexing. It may contain several words separated by spaces. By default the search phrase is also the text entered as @@ -2322,7 +2320,7 @@ Finally, every occurrence of @samp{Pluto} will be indexed as @samp{\index@{Planets!Pluto@}\index@{Kuiper Belt Objects!Pluto@}Pluto} and will therefore create two different index entries. -@node Consistency Checks, Global Indexing, Collecting Phrases, The Index Phrases File +@node Consistency Checks @subsection Consistency Checks @cindex Index phrases, consistency checks @cindex Phrases, consistency checks @@ -2331,7 +2329,7 @@ and will therefore create two different index entries. @kindex C-c C-s Before indexing the phrases in the phrases buffer, they should be checked carefully for consistency. A first step is to sort the phrases -alphabetically - this is done with the command @kbd{C-c C-s} +alphabetically; this is done with the command @kbd{C-c C-s} (@code{reftex-index-sort-phrases}). It will sort all phrases in the buffer alphabetically by search phrase. If you want to group certain phrases and only sort within the groups, insert empty lines between the @@ -2355,7 +2353,7 @@ the buffer which is either duplicate or a subphrase of another phrase. In order to check the whole buffer like this, start at the beginning and execute this command repeatedly. -@node Global Indexing, , Consistency Checks, The Index Phrases File +@node Global Indexing @subsection Global Indexing @cindex Global indexing @cindex Indexing, global @@ -2436,7 +2434,7 @@ to the changed regions. The command purpose. When called from a @LaTeX{} document with active region, it will apply @code{reftex-index-all-phrases} to the current region. -@node Displaying and Editing the Index, Builtin Index Macros, The Index Phrases File, Index Support +@node Displaying and Editing the Index @section Displaying and Editing the Index @cindex Displaying the Index @cindex Editing the Index @@ -2617,7 +2615,7 @@ indices). @end table -@node Builtin Index Macros, Defining Index Macros, Displaying and Editing the Index, Index Support +@node Builtin Index Macros @section Builtin Index Macros @cindex Builtin index macros @cindex Index macros, builtin @@ -2635,7 +2633,7 @@ the different definitions of the @code{\index} macro are incompatible, you will have to explicitly specify the index style used. @xref{Creating Index Entries}, for information on how to do that. -@node Defining Index Macros, , Builtin Index Macros, Index Support +@node Defining Index Macros @section Defining Index Macros @cindex Defining Index Macros @cindex Index macros, defining @@ -2679,7 +2677,7 @@ unique. @code{?i}, @code{?I}, and @code{?g} are reserved for the respectively. The following string is empty unless your macro adds a superordinate -entry to the index key - this is the case for the @code{\astobj} macro. +entry to the index key; this is the case for the @code{\astobj} macro. The next entry can be a hook function to exclude certain matches, it almost always can be @code{nil}. @@ -2732,7 +2730,7 @@ which specifies that the macro identified with the character @code{?x} (the in the buffer with @kbd{C-c /} (@code{reftex-index-selection-or-word}). The index tag is "idx". -@node Viewing Cross-References, RefTeXs Menu, Index Support, Top +@node Viewing Cross-References @chapter Viewing Cross-References @findex reftex-view-crossref @findex reftex-mouse-view-crossref @@ -2811,8 +2809,11 @@ in the variable @code{reftex-view-crossref-extra}. @iftex @chapter All the Rest @end iftex +@ifnottex +@raisesections +@end ifnottex -@node RefTeXs Menu, Key Bindings, Viewing Cross-References, Top +@node RefTeXs Menu @section @RefTeX{}'s Menu @cindex RefTeXs Menu @cindex Menu, in the menu bar @@ -2823,7 +2824,7 @@ which support this. From this menu you can access all of @code{Customize} submenu which can be used to access @RefTeX{}'s entire set of options. -@node Key Bindings, Faces, RefTeXs Menu, Top +@node Key Bindings @section Default Key Bindings @cindex Key Bindings, summary @@ -2897,7 +2898,7 @@ Changing and adding to @RefTeX{}'s key bindings is best done in the hook @code{reftex-load-hook}. For information on the keymaps which should be used to add keys, see @ref{Keymaps and Hooks}. -@node Faces, AUCTeX, Key Bindings, Top +@node Faces @section Faces @cindex Faces @@ -2909,7 +2910,7 @@ reasonable because people who like faces will very likely have it loaded. If you wish to turn off fontification or change the involved faces, see @ref{Options (Fontification)}. -@node Multifile Documents, Language Support, AUCTeX, Top +@node Multifile Documents @section Multifile Documents @cindex Multifile documents @cindex Documents, spread over files @@ -2962,7 +2963,7 @@ outside the current file can still use that section title as context. @end itemize -@node Language Support, Finding Files, Multifile Documents, Top +@node Language Support @section Language Support @cindex Language support @@ -3004,7 +3005,7 @@ dependent. See the variables @code{reftex-multiref-punctuation} and @code{reftex-cite-punctuation}. @end itemize -@node Finding Files, Optimizations, Language Support, Top +@node Finding Files @section Finding Files @cindex Finding files @@ -3090,7 +3091,7 @@ the new extension must also be known to @AUCTeX{} via the variable '( "nw" "tex" "sty" "cls" "ltx" "texi" "texinfo")) @end lisp -@node Optimizations, Problems and Work-Arounds, Finding Files, Top +@node Optimizations @section Optimizations @cindex Optimizations @@ -3243,7 +3244,7 @@ with the @kbd{g} key. To get this behavior, use instead @end group @end lisp -@node AUCTeX, Multifile Documents, Faces, Top +@node AUCTeX @section @AUCTeX{} @cindex @code{AUCTeX}, Emacs package @cindex Emacs packages, @code{AUCTeX} @@ -3260,7 +3261,7 @@ XEmacs package.} by FTP from the @value{AUCTEXSITE}. * Bib-Cite:: Hypertext reading of a document @end menu -@node AUCTeX-RefTeX Interface, Style Files, , AUCTeX +@node AUCTeX-RefTeX Interface @subsection The @AUCTeX{}-@RefTeX{} Interface @RefTeX{} contains code to interface with @AUCTeX{}. When this @@ -3344,7 +3345,7 @@ Labels}). @RefTeX{} will add all newly created labels to @AUCTeX{}'s completion list. @end itemize -@node Style Files, Bib-Cite, AUCTeX-RefTeX Interface, AUCTeX +@node Style Files @subsection Style Files @cindex Style files, AUCTeX @findex TeX-add-style-hook, @r{AUCTeX} @@ -3464,7 +3465,7 @@ is a style file @file{foils.el} that will inform @RefTeX{} about these: ("rotatefoilhead" . 3)))))) @end lisp -@node Bib-Cite, , Style Files, AUCTeX +@node Bib-Cite @subsection Bib-Cite @cindex @code{bib-cite}, Emacs package @cindex Emacs packages, @code{bib-cite} @@ -3492,7 +3493,7 @@ make use of this feature, try @end lisp @page -@node Problems and Work-Arounds, Imprint, Optimizations, Top +@node Problems and Work-Arounds @section Problems and Work-arounds @cindex Problems and work-arounds @@ -3628,7 +3629,7 @@ With @i{Viper} mode prior to Vipers version 3.01, you need to protect @end itemize @page -@node Imprint, Commands, Problems and Work-Arounds, Top +@node Imprint @section Imprint @cindex Imprint @cindex Maintainer @@ -3675,7 +3676,12 @@ Finally thanks to @i{Uwe Bolick} who first got me interested in supporting @LaTeX{} labels and references with an editor (which was MicroEmacs at the time). -@node Commands, Options, Imprint, Top +@c Turn off the raising that we turned on in ``All the rest''. +@ifnottex +@lowersections +@end ifnottex + +@node Commands @chapter Commands @cindex Commands, list of @@ -3741,8 +3747,8 @@ library which is part of @AUCTeX{}, the string is first processed with the @deffn Command reftex-index-phrase-selection-or-word Add current selection or the word at point to the phrases buffer. When you are in transient-mark-mode and the region is active, the -selection will be used - otherwise the word at point. -You get a chance to edit the entry in the phrases buffer - to save the +selection will be used; otherwise the word at point. +You get a chance to edit the entry in the phrases buffer; to save the buffer and return to the @LaTeX{} document, finish with @kbd{C-c C-c}. @end deffn @@ -3877,12 +3883,12 @@ Enforce rebuilding of several internal lists and variables. Also removes the parse file associated with the current document. @end deffn -@node Options, Keymaps and Hooks, Commands, Top +@node Options @chapter Options, Keymaps, Hooks @cindex Options, list of Here is a complete list of @RefTeX{}'s configuration variables. All -variables have customize support - so if you are not familiar with Emacs +variables have customize support, so if you are not familiar with Emacs Lisp (and even if you are) you might find it more comfortable to use @code{customize} to look at and change these variables. @kbd{M-x reftex-customize} will get you there. @@ -3899,9 +3905,10 @@ reftex-customize} will get you there. * Options (Optimizations):: * Options (Fontification):: * Options (Misc):: +* Keymaps and Hooks:: @end menu -@node Options (Table of Contents), Options (Defining Label Environments), , Options +@node Options (Table of Contents) @section Table of Contents @cindex Options, table of contents @cindex Table of contents, options @@ -4025,7 +4032,7 @@ The keymap which is active in the @file{*toc*} buffer. (@pxref{Table of Contents}). @end deffn -@node Options (Defining Label Environments), Options (Creating Labels), Options (Table of Contents), Options +@node Options (Defining Label Environments) @section Defining Label Environments @cindex Options, defining label environments @cindex Defining label environments, options @@ -4062,7 +4069,7 @@ Name of the environment (like @samp{table}) or macro (like @samp{\myfig}). For macros, indicate the arguments, as in @samp{\myfig[]@{@}@{@}@{*@}@{@}}. Use square brackets for optional arguments, a star to mark the label argument, if any. The macro does -not have to have a label argument - you could also use +not have to have a label argument; you could also use @samp{\label@{...@}} inside one of its arguments. Special names: @code{section} for section labels, @code{any} to define a @@ -4216,7 +4223,7 @@ names like @samp{chapter}, integer section levels (as given in @defopt reftex-default-context-regexps Alist with default regular expressions for finding context. The emacs lisp form @w{@code{(format regexp (regexp-quote environment))}} is used -to calculate the final regular expression - so @samp{%s} will be +to calculate the final regular expression, so @samp{%s} will be replaced with the environment or macro. @end defopt @@ -4252,7 +4259,7 @@ labels fn:xxx, you may want to set this variable to the value "^fn:$" or non-footnote labels. @end defopt -@node Options (Creating Labels), Options (Referencing Labels), Options (Defining Label Environments), Options +@node Options (Creating Labels) @section Creating Labels @cindex Options, creating labels @cindex Creating labels, options @@ -4368,7 +4375,7 @@ Character class after abbrev point in word. @end table @end defopt -@node Options (Referencing Labels), Options (Creating Citations), Options (Creating Labels), Options +@node Options (Referencing Labels) @section Referencing Labels @cindex Options, referencing labels @cindex Referencing labels, options @@ -4405,7 +4412,7 @@ The available label types are: @code{s} (section), @code{f} (figure), @code{t} (table), @code{i} (item), @code{e} (equation), @code{n} (footnote), plus any definitions in @code{reftex-label-alist}. -Most options can also be switched from the label menu itself - so if you +Most options can also be switched from the label menu itself, so if you decide here to not have a table of contents in the label menu, you can still get one interactively during selection from the label menu. @end defopt @@ -4463,7 +4470,7 @@ Non-@code{nil} means, @code{reftex-reference} will try to guess the label type. To do that, @RefTeX{} will look at the word before the cursor and compare it with the magic words given in @code{reftex-label-alist}. When it finds a match, @RefTeX{} will -immediately offer the correct label menu - otherwise it will prompt you +immediately offer the correct label menu; otherwise it will prompt you for a label type. If you set this variable to @code{nil}, @RefTeX{} will always prompt for a label type. @end defopt @@ -4490,7 +4497,7 @@ The keymap which is active in the labels selection process (@pxref{Referencing Labels}). @end deffn -@node Options (Creating Citations), Options (Index Support), Options (Referencing Labels), Options +@node Options (Creating Citations) @section Creating Citations @cindex Options, creating citations @cindex Creating citations, options @@ -4604,7 +4611,8 @@ prompt for values. Possible values are: @example nil @r{Never prompt for optional arguments} t @r{Always prompt} -maybe @r{Prompt only if @code{reftex-citation} was called with C-u prefix arg}@end example +maybe @r{Prompt only if @code{reftex-citation} was called with C-u prefix arg} +@end example Unnecessary empty optional arguments are removed before insertion into the buffer. See @code{reftex-cite-cleanup-optional-args}. @end defopt @@ -4668,7 +4676,7 @@ Footer to insert in BibTeX files generated by @end defopt -@node Options (Index Support), Options (Viewing Cross-References), Options (Creating Citations), Options +@node Options (Index Support) @section Index Support @cindex Options, Index support @cindex Index support, options @@ -4727,11 +4735,11 @@ The final entry may also be a symbol. It must have an association in the variable @code{reftex-index-macros-builtin} to specify the main indexing package you are using. Valid values are currently @example -default @r{The @LaTeX{} default - unnecessary to specify this one} +default @r{The @LaTeX{} default; unnecessary to specify this one} multind @r{The multind.sty package} index @r{The index.sty package} index-shortcut @r{The index.sty packages with the ^ and _ shortcuts.} - @r{Should not be used - only for old documents} + @r{Should not be used; only for old documents} @end example Note that @AUCTeX{} sets these things internally for @RefTeX{} as well, so with a sufficiently new version of @AUCTeX{}, you should not set the @@ -4742,7 +4750,7 @@ package here. The default index macro for @code{reftex-index-selection-or-word}. This is a list with @code{(@var{macro-key} @var{default-tag})}. -@var{macro-key} is a character identifying an index macro - see +@var{macro-key} is a character identifying an index macro; see @code{reftex-index-macros}. @var{default-tag} is the tag to be used if the macro requires a @@ -4830,7 +4838,7 @@ case, that match will be ignored. @defopt reftex-index-phrases-wrap-long-lines Non-@code{nil} means, when indexing from the phrases buffer, wrap lines. -Inserting indexing commands in a line makes the line longer - often +Inserting indexing commands in a line makes the line longer, often so long that it does not fit onto the screen. When this variable is non-@code{nil}, newlines will be added as necessary before and/or after the indexing command to keep lines short. However, the matched text @@ -4888,7 +4896,7 @@ The keymap which is active in the @file{*Index*} buffer (@pxref{Index Support}). @end deffn -@node Options (Viewing Cross-References), Options (Finding Files), Options (Index Support), Options +@node Options (Viewing Cross-References) @section Viewing Cross-References @cindex Options, viewing cross-references @cindex Viewing cross-references, options @@ -4947,7 +4955,7 @@ saved along with the parsing information. The cache survives document scans. In order to clear it, use @kbd{M-x reftex-reset-mode}. @end defopt -@node Options (Finding Files), Options (Optimizations), Options (Viewing Cross-References), Options +@node Options (Finding Files) @section Finding Files @cindex Options, Finding Files @cindex Finding files, options @@ -5008,7 +5016,7 @@ Non-@code{nil} means, search all specified directories before trying recursion. Thus, in a path @samp{.//:/tex/}, search first @samp{./}, then @samp{/tex/}, and then all subdirectories of @samp{./}. If this option is @code{nil}, the subdirectories of @samp{./} are searched -before @samp{/tex/}. This is mainly for speed - most of the time the +before @samp{/tex/}. This is mainly for speed; most of the time the recursive path is for the system files and not for the user files. Set this to @code{nil} if the default makes @RefTeX{} finding files with equal names in wrong sequence. @@ -5037,7 +5045,7 @@ non-@code{nil}. @end defopt @page -@node Options (Optimizations), Options (Fontification), Options (Finding Files), Options +@node Options (Optimizations) @section Optimizations @cindex Options, optimizations @cindex Optimizations, options @@ -5129,7 +5137,7 @@ cannot be placed with certainty into the internal label list. @defopt reftex-use-multiple-selection-buffers Non-@code{nil} means use a separate selection buffer for each label type. These buffers are kept from one selection to the next and need -not to be created for each use - so the menu generally comes up faster. +not be created for each use, so the menu generally comes up faster. The selection buffers will be erased (and therefore updated) automatically when new labels in its category are added. See the variable @code{reftex-auto-update-selection-buffers}. @@ -5146,7 +5154,7 @@ effect when @code{reftex-use-multiple-selection-buffers} is non-@code{nil}. @end defopt -@node Options (Fontification), Options (Misc), Options (Optimizations), Options +@node Options (Fontification) @section Fontification @cindex Options, fontification @cindex Fontification, options @@ -5244,7 +5252,7 @@ Face name for index names (for multiple indices). Face name for index entries. @end defopt -@node Options (Misc), , Options (Fontification), Options +@node Options (Misc) @section Miscellaneous @cindex Options, misc @@ -5289,7 +5297,7 @@ this will be the case even if @code{\bb} is defined with zero or one argument. @end defopt -@node Keymaps and Hooks, Changes, Options, Top +@node Keymaps and Hooks @section Keymaps and Hooks @cindex Keymaps @@ -5313,7 +5321,7 @@ their own keymaps and mode hooks. See the respective sections. There are many more hooks which are described in the relevant sections about options for a specific part of @RefTeX{}. -@node Changes, GNU Free Documentation License, Keymaps and Hooks, Top +@node Changes @chapter Changes @cindex Changes @@ -6078,11 +6086,11 @@ new labels. released on 7 Jan 1997. @end itemize -@node GNU Free Documentation License, Index, Changes, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Index, , GNU Free Documentation License, Top +@node Index @unnumbered Index @printindex cp diff --git a/doc/misc/remember.texi b/doc/misc/remember.texi index f97d835e50c..c70b6212268 100644 --- a/doc/misc/remember.texi +++ b/doc/misc/remember.texi @@ -8,7 +8,7 @@ @copying This manual is for Remember Mode, version 1.9 -Copyright @copyright{} 2001, 2004-2005, 2007-2012 +Copyright @copyright{} 2001, 2004--2005, 2007--2013 Free Software Foundation, Inc. @quotation @@ -20,8 +20,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -45,8 +44,7 @@ developing GNU and promoting software freedom.'' @contents @ifnottex -@node Top, Preface, (dir), (dir) -@comment node-name, next, previous, up +@node Top @top Remember @insertcopying @@ -77,8 +75,7 @@ Backends @end detailmenu @end menu -@node Preface, Introduction, Top, Top -@comment node-name, next, previous, up +@node Preface @chapter Preface This document describes remember-el, which was written by John Wiegley, @@ -88,8 +85,7 @@ developers. This document is a work in progress, and your contribution will be greatly appreciated. -@node Introduction, Installation, Preface, Top -@comment node-name, next, previous, up +@node Introduction @chapter Introduction Todo lists, schedules, phone databases... everything we use databases @@ -131,8 +127,7 @@ in order to record them---it would map much more closely to how the mind manual-ness which computers from the very beginning have been championed as being able to reduce. -@node Installation, Implementation, Introduction, Top -@comment node-name, next, previous, up +@node Installation @chapter Installation Installing Remember Mode is as simple as adding the following lines to @@ -144,8 +139,7 @@ your Emacs configuration file (usually @file{~/.emacs.d/init.el} or (require 'remember) @end lisp -@node Implementation, Quick Start, Installation, Top -@comment node-name, next, previous, up +@node Implementation @chapter Implementation Hyperbole, as a data presentation tool, always struck me as being very @@ -186,8 +180,7 @@ rather than requiring a billion keystrokes to reorganize your hierarchy. Well, as the future arrives, hopefully experience and user feedback will help to make this as intuitive a tool as possible. -@node Quick Start, Function Reference, Implementation, Top -@comment node-name, next, previous, up +@node Quick Start @chapter Quick Start @itemize @@ -258,8 +251,7 @@ remember-annotation-functions. For example: (call-interactively 'remember))) @end lisp -@node Function Reference, Keystrokes, Quick Start, Top -@comment node-name, next, previous, up +@node Function Reference @chapter Function Reference @file{remember.el} defines the following interactive functions: @@ -292,8 +284,7 @@ buffer is used to collect data that you want remember. Just hit the data for latter retrieval, and possible indexing. @end defun -@node Keystrokes, Backends, Function Reference, Top -@comment node-name, next, previous, up +@node Keystrokes @chapter Keystroke Reference @file{remember.el} defines the following keybindings by default: @@ -311,8 +302,7 @@ Remember the contents of the current buffer. @end table -@node Backends, GNU Free Documentation License, Keystrokes, Top -@comment node-name, next, previous, up +@node Backends @chapter Backends You can save remembered notes to a variety of backends. @@ -324,8 +314,7 @@ You can save remembered notes to a variety of backends. * Org:: Saving to an Org Mode file. @end menu -@node Text File, Diary, Backends, Backends -@comment node-name, next, previous, up +@node Text File @section Saving to a Text File @cindex text file, saving to @@ -345,8 +334,7 @@ The file in which to store unprocessed data. The text used to begin each remember item. @end defopt -@node Diary, Mailbox, Text File, Backends -@comment node-name, next, previous, up +@node Diary @section Saving to a Diary file @cindex diary, integration @@ -363,8 +351,7 @@ File for extracted diary entries. If this is nil, then @code{diary-file} will be used instead." @end defopt -@node Mailbox, Org, Diary, Backends -@comment node-name, next, previous, up +@node Mailbox @section Saving to a Mailbox @cindex mailbox, saving to @@ -384,8 +371,7 @@ The file in which to store remember data as mail. The default priority for remembered mail messages. @end defopt -@node Org, , Mailbox, Backends -@comment node-name, next, previous, up +@node Org @section Saving to an Org Mode file @cindex org mode, integration @@ -399,12 +385,11 @@ for org-remember at @url{http://orgmode.org/org-remember.pdf}. For instructions on how to integrate Remember with Org Mode, consult @ref{Capture, , , org}. -@node GNU Free Documentation License, Concept Index, Backends, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Concept Index, , GNU Free Documentation License, Top -@comment node-name, next, previous, up +@node Concept Index @unnumbered Index @printindex cp diff --git a/doc/misc/sasl.texi b/doc/misc/sasl.texi index a31d9ca5e38..dcb25ec805a 100644 --- a/doc/misc/sasl.texi +++ b/doc/misc/sasl.texi @@ -10,8 +10,7 @@ @copying This file describes the Emacs SASL library, version @value{VERSION}. -Copyright @copyright{} 2000, 2004-2012 -Free Software Foundation, Inc. +Copyright @copyright{} 2000, 2004--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -19,17 +18,10 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the license -is included in the section entitled ``GNU Free Documentation License'' -in the Emacs manual. +is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' - -This document is part of a collection distributed under the GNU Free -Documentation License. If you want to distribute this document -separately from the collection, you can do so by adding a copy of the -license to the document, as described in section 6 of the license. +modify this GNU manual.'' @end quotation @end copying @@ -62,17 +54,18 @@ SASL is a common interface to share several authentication mechanisms between applications using different protocols. @ifnottex -@insertcopying +@insertcopying @end ifnottex @menu * Overview:: What Emacs SASL library is. * How to use:: Adding authentication support to your applications. -* Data types:: +* Data types:: * Back end drivers:: Writing your own drivers. -* Index:: -* Function Index:: -* Variable Index:: +* GNU Free Documentation License:: The license for this documentation. +* Index:: +* Function Index:: +* Variable Index:: @end menu @node Overview @@ -113,9 +106,9 @@ security layer---a mechanism, a client parameter and an authentication step. @menu -* Mechanisms:: -* Clients:: -* Steps:: +* Mechanisms:: +* Clients:: +* Steps:: @end menu @node Mechanisms @@ -258,16 +251,20 @@ At the first time @var{step} should be set to @code{nil}. (Not yet written). +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + @node Index -@chapter Index +@unnumbered Index @printindex cp @node Function Index -@chapter Function Index +@unnumbered Function Index @printindex fn @node Variable Index -@chapter Variable Index +@unnumbered Variable Index @printindex vr @summarycontents diff --git a/doc/misc/sc.texi b/doc/misc/sc.texi index d6d57421ec2..cfd040f0e82 100644 --- a/doc/misc/sc.texi +++ b/doc/misc/sc.texi @@ -14,7 +14,7 @@ This document describes Supercite, an Emacs package for citing and attributing replies to mail and news messages. -Copyright @copyright{} 1993, 2001-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1993, 2001--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -25,8 +25,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -1480,7 +1479,7 @@ recognizing specific alternative forms. @vindex sc-cite-frame-alist @vindex sc-uncite-frame-alist @vindex sc-recite-frame-alist -For each of the actions -- citing, unciting, and reciting -- an alist is +For each of the actions---citing, unciting, and reciting---an alist is consulted to find the frame to use (@code{sc-cite-frame-alist}, @code{sc-uncite-frame-alist}, and @code{sc-recite-frame-alist} respectively). These frames can contain alists of the form: diff --git a/doc/misc/sem-user.texi b/doc/misc/sem-user.texi index f483c899bf2..82af6c8f494 100644 --- a/doc/misc/sem-user.texi +++ b/doc/misc/sem-user.texi @@ -1,13 +1,7 @@ -@c This file is included by semantic.texi - -@c Copyright (C) 1999-2005, 2007, 2009-2012 Free Software Foundation, Inc. - -@c Permission is granted to copy, distribute and/or modify this -@c document under the terms of the GNU Free Documentation License, -@c Version 1.3 or any later version published by the Free Software -@c Foundation; with no Invariant Sections, no Front-Cover Texts, and -@c no Back-Cover Texts. A copy of the license is included in the -@c section entitled ``GNU Free Documentation License''. +@c This is part of the Semantic manual. +@c Copyright (C) 1999-2005, 2007, 2009-2013 Free Software Foundation, +@c Inc. +@c See file semantic.texi for copying conditions. You can begin using @semantic{} by enabling Semantic mode, a global minor mode: type @kbd{M-x semantic-mode}, or open the @samp{Tools} diff --git a/doc/misc/semantic.texi b/doc/misc/semantic.texi index ad8392c208b..de5019ee897 100644 --- a/doc/misc/semantic.texi +++ b/doc/misc/semantic.texi @@ -24,7 +24,8 @@ @copying This manual documents the Semantic library and utilities. -Copyright @copyright{} 1999-2005, 2007, 2009-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1999--2005, 2007, 2009--2013 Free Software +Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -35,8 +36,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License.'' (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying diff --git a/doc/misc/ses.texi b/doc/misc/ses.texi index fecba99952f..ce75f2ef91e 100644 --- a/doc/misc/ses.texi +++ b/doc/misc/ses.texi @@ -11,7 +11,7 @@ @copying This file documents @acronym{SES}: the Simple Emacs Spreadsheet. -Copyright @copyright{} 2002-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2002--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -22,8 +22,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License.'' (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -50,7 +49,7 @@ developing GNU and promoting software freedom.'' @c =================================================================== @ifnottex -@node Top, Sales Pitch, (dir), (dir) +@node Top @comment node-name, next, previous, up @top @acronym{SES}: Simple Emacs Spreadsheet @@ -77,7 +76,7 @@ To report bugs, send email to @email{jyavner@@member.fsf.org}. @c =================================================================== -@node Sales Pitch, The Basics, Top, Top +@node Sales Pitch @comment node-name, next, previous, up @chapter Sales Pitch @cindex features @@ -99,7 +98,7 @@ To report bugs, send email to @email{jyavner@@member.fsf.org}. @c =================================================================== -@node The Basics, Advanced Features, Sales Pitch, Top +@node The Basics @comment node-name, next, previous, up @chapter The Basics @cindex basic commands @@ -158,7 +157,7 @@ Highlight all cells (@code{mark-whole-buffer}). * Customizing @acronym{SES}:: @end menu -@node Formulas, Resizing, The Basics, The Basics +@node Formulas @section Cell formulas @cindex formulas @cindex formulas, entering @@ -211,7 +210,7 @@ Force recalculation of the current cell or range (@code{ses-recalculate-cell}). Recalculate the entire spreadsheet (@code{ses-recalculate-all}). @end table -@node Resizing, Printer functions, Formulas, The Basics +@node Resizing @section Resizing the spreadsheet @cindex resizing spreadsheets @findex ses-insert-row @@ -267,7 +266,7 @@ Undo previous action (@code{(undo)}). @end table -@node Printer functions, Clearing cells, Resizing, The Basics +@node Printer functions @section Printer functions @cindex printer functions @findex ses-read-cell-printer @@ -332,7 +331,7 @@ Centering with tildes (~) and spill-over. @end table -@node Clearing cells, Copy/cut/paste, Printer functions, The Basics +@node Clearing cells @section Clearing cells @cindex clearing commands @findex ses-clear-cell-backward @@ -349,7 +348,7 @@ Clear cell and move right (@code{ses-clear-cell-forward}). @end table -@node Copy/cut/paste, Customizing @acronym{SES}, Clearing cells, The Basics +@node Copy/cut/paste @section Copy, cut, and paste @cindex copy @cindex cut @@ -424,7 +423,7 @@ Emacs yank-pop, the @acronym{SES} version uses @code{undo} to delete the old yank. This doesn't make any difference? @end table -@node Customizing @acronym{SES}, , Copy/cut/paste, The Basics +@node Customizing @acronym{SES} @section Customizing @acronym{SES} @cindex customizing @vindex enable-local-eval @@ -461,7 +460,7 @@ safety belts! @c =================================================================== -@node Advanced Features, For Gurus, The Basics, Top +@node Advanced Features @chapter Advanced Features @cindex advanced features @findex ses-read-header-row @@ -504,7 +503,7 @@ repair that use function @code{ses-repair-cell-reference-all} * Spreadsheets with details and summary:: @end menu -@node The print area, Ranges in formulas, Advanced Features, Advanced Features +@node The print area @section The print area @cindex print area @findex widen @@ -530,7 +529,7 @@ Recreate print area by reevaluating printer functions for all cells (@code{ses-reprint-all}). @end table -@node Ranges in formulas, Sorting by column, The print area, Advanced Features +@node Ranges in formulas @section Ranges in formulas @cindex ranges @findex ses-insert-range-click @@ -636,7 +635,7 @@ is only one row or column in the range, that is to say the corresponding matrix is flattened. @end table -@node Sorting by column, Standard formula functions, Ranges in formulas, Advanced Features +@node Sorting by column @section Sorting by column @cindex sorting @findex ses-sort-column @@ -665,7 +664,7 @@ formulas that refer to other rows in the range or to cells outside the range. -@node Standard formula functions, More on cell printing, Sorting by column, Advanced Features +@node Standard formula functions @section Standard formula functions @cindex standard formula functions @cindex *skip* @@ -690,7 +689,7 @@ Average of non-blank elements in @var{list}. Here the list is passed as a single argument, since you'll probably use it with @code{ses-range}. @end table -@node More on cell printing, Import and export, Standard formula functions, Advanced Features +@node More on cell printing @section More on cell printing @cindex cell printing, more @findex ses-truncate-cell @@ -738,7 +737,7 @@ that are empty of contain strings will use the fallback printer. argument type''. -@node Import and export, Virus protection, More on cell printing, Advanced Features +@node Import and export @section Import and export @cindex import and export @cindex export, and import @@ -752,13 +751,13 @@ Export a range of cells as tab-separated values (@code{ses-export-tsv}). Export a range of cells as tab-separated formulas (@code{ses-export-tsf}). @end table -The exported text goes to the kill ring --- you can paste it into +The exported text goes to the kill ring; you can paste it into another buffer. Columns are separated by tabs, rows by newlines. To import text, use any of the yank commands where the text to paste contains tabs and/or newlines. Imported formulas are not relocated. -@node Virus protection, Spreadsheets with details and summary, Import and export, Advanced Features +@node Virus protection @section Virus protection @cindex virus protection @@ -785,7 +784,7 @@ parts of the Emacs Lisp environment can be excluded without cramping your style as a formula-writer. See the documentation in @file{unsafep.el} for more info on how Lisp forms are classified as safe or unsafe. -@node Spreadsheets with details and summary, , Virus protection, Advanced Features +@node Spreadsheets with details and summary @section Spreadsheets with details and summary @cindex details and summary @cindex summary, and details @@ -821,7 +820,7 @@ details-and-summary spreadsheet. @c =================================================================== -@node For Gurus, Index, Advanced Features, Top +@node For Gurus @chapter For Gurus @cindex advanced features @@ -833,7 +832,7 @@ details-and-summary spreadsheet. * Uses of defadvice in @acronym{SES}:: @end menu -@node Deferred updates, Nonrelocatable references, For Gurus, For Gurus +@node Deferred updates @section Deferred updates @cindex deferred updates @cindex updates, deferred @@ -865,7 +864,7 @@ a momentary glitch after C-x C-v and certain scrolling commands. You can type ahead without worrying about the glitch. -@node Nonrelocatable references, The data area, Deferred updates, For Gurus +@node Nonrelocatable references @section Nonrelocatable references @cindex nonrelocatable references @cindex references, nonrelocatable @@ -893,7 +892,7 @@ to get the value from the leftmost column in the current row. This kind of dependency is also not recorded. -@node The data area, Buffer-local variables in spreadsheets, Nonrelocatable references, For Gurus +@node The data area @section The data area @cindex data area @findex ses-reconstruct-all @@ -925,7 +924,7 @@ data structures: @end table -@node Buffer-local variables in spreadsheets, Uses of defadvice in @acronym{SES}, The data area, For Gurus +@node Buffer-local variables in spreadsheets @section Buffer-local variables in spreadsheets @cindex buffer-local variables @cindex variables, buffer-local @@ -948,7 +947,7 @@ order to avoid a virus warning. You can define functions by making them values for the fake local variable @code{eval}. Such functions can then be used in your formulas and printers, but usually each @code{eval} is presented to -the user during file loading as a potential virus --- this can get +the user during file loading as a potential virus. This can get annoying. You can define functions in your @file{.emacs} file. Other people can @@ -959,7 +958,7 @@ avoid virus warnings, each function used in a formula needs (put 'your-function-name 'safe-function t) @end lisp -@node Uses of defadvice in @acronym{SES}, , Buffer-local variables in spreadsheets, For Gurus +@node Uses of defadvice in @acronym{SES} @section Uses of defadvice in @acronym{SES} @cindex defadvice @cindex undo-more @@ -986,15 +985,15 @@ cell. @end table @c =================================================================== -@node Index, Acknowledgments, For Gurus, Top +@node Index @unnumbered Index @printindex cp @c =================================================================== -@node Acknowledgments, GNU Free Documentation License, Index, Top -@chapter Acknowledgments +@node Acknowledgments +@unnumbered Acknowledgments Coding by: @quotation @@ -1035,7 +1034,7 @@ Jean-Philippe Theberge @email{jphil@@acs.pagesjaunes.fr} @c =================================================================== -@node GNU Free Documentation License, , Acknowledgments, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi diff --git a/doc/misc/sieve.texi b/doc/misc/sieve.texi index d13f25c2a55..cbcd6a61f39 100644 --- a/doc/misc/sieve.texi +++ b/doc/misc/sieve.texi @@ -11,7 +11,7 @@ @copying This file documents the Emacs Sieve package, for server-side mail filtering. -Copyright @copyright{} 2001-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2001--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -22,8 +22,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -213,7 +212,7 @@ Bury the Manage Sieve buffer without closing the connection. @kindex ? @kindex h @findex sieve-help -Displays help in the minibuffer. +Displays help in the minibuffer. @end table diff --git a/doc/misc/smtpmail.texi b/doc/misc/smtpmail.texi index 67824afb898..dce90d06012 100644 --- a/doc/misc/smtpmail.texi +++ b/doc/misc/smtpmail.texi @@ -3,8 +3,7 @@ @settitle Emacs SMTP Library @syncodeindex vr fn @copying -Copyright @copyright{} 2003-2012 -Free Software Foundation, Inc. +Copyright @copyright{} 2003--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -15,8 +14,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -26,9 +24,9 @@ developing GNU and promoting software freedom.'' @end direntry @titlepage -@title{Emacs SMTP Library} -@subtitle{An Emacs package for sending mail via SMTP} -@author{Simon Josefsson, Alex Schroeder} +@title Emacs SMTP Library +@subtitle An Emacs package for sending mail via SMTP +@author Simon Josefsson, Alex Schroeder @page @vskip 0pt plus 1filll @insertcopying @@ -72,8 +70,8 @@ not necessarily involve SMTP, however. Here is short overview of what is involved. @cindex MUA - The mail program --- also called a mail user agent (MUA) --- -usually sends outgoing mail to a mail host. When your computer is + The mail program---also called a mail user agent (MUA)---usually +sends outgoing mail to a mail host. When your computer is permanently connected to the internet, it might even be a mail host itself. In this case, the MUA will pipe mail to the @file{/usr/lib/sendmail} application. It will take care of your mail @@ -285,8 +283,8 @@ The variable @code{smtpmail-stream-type} controls what form of connection the SMTP library uses. The default value is @code{nil}, which means to use a plain connection, but try to switch to a STARTTLS encrypted connection if the server supports it. Other possible values -are: @code{starttls} - insist on STARTTLS; @code{ssl} - use TLS/SSL; -and @code{plain} - no encryption. +are: @code{starttls} to insist on STARTTLS; @code{ssl} to use TLS/SSL; +and @code{plain} for encryption. Use of any form of TLS/SSL requires support in Emacs. You can either use the built-in support (in Emacs 24.1 and later), or the diff --git a/doc/misc/speedbar.texi b/doc/misc/speedbar.texi index 6604dc5f0d0..c017490d4aa 100644 --- a/doc/misc/speedbar.texi +++ b/doc/misc/speedbar.texi @@ -4,7 +4,7 @@ @syncodeindex fn cp @copying -Copyright @copyright{} 1999-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1999--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -15,8 +15,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -38,8 +37,7 @@ developing GNU and promoting software freedom.'' @contents -@node Top, , , (dir)Top -@comment node-name, next, previous, up +@node Top @top Speedbar Speedbar is a program for Emacs which can be used to summarize @@ -69,7 +67,7 @@ an expanded summary of the entry the expansion button is on. @xref{Basic Navigation}. @ifnottex -@insertcopying +@insertcopying @end ifnottex @menu @@ -84,8 +82,7 @@ on. @xref{Basic Navigation}. * Index:: @end menu -@node Introduction, Basic Navigation, , Top -@comment node-name, next, previous, up +@node Introduction @chapter Introduction @cindex introduction @@ -116,8 +113,7 @@ The function to use when switching between frames using the keyboard is @code{speedbar-get-focus}. This function will toggle between frames, and it's useful to bind it to a key in terminal mode. @xref{Customizing}. -@node Basic Navigation, File Mode, Introduction, Top -@comment node-name, next, previous, up +@node Basic Navigation @chapter Basic Navigation Speedbar can display different types of data, and has several display @@ -132,8 +128,7 @@ to use. * Displays Submenu:: @end menu -@node Basic Key Bindings, Basic Visuals, Basic Navigation, Basic Navigation -@comment node-name, next, previous, up +@node Basic Key Bindings @section Basic Key Bindings @cindex key bindings @@ -206,8 +201,7 @@ flushed. This is similar to a power click. @xref{Mouse Bindings}. Contract the current group, hiding sub items. @end table -@node Basic Visuals, Mouse Bindings, Basic Key Bindings, Basic Navigation -@comment node-name, next, previous, up +@node Basic Visuals @section Basic Visuals @cindex visuals @@ -308,8 +302,7 @@ The face naming convention mirrors the File display mode. Modes which do not use files will attempt to use the same colors on analogous entries. -@node Mouse Bindings, Displays Submenu, Basic Visuals, Basic Navigation -@comment node-name, next, previous, up +@node Mouse Bindings @section Mouse Bindings @cindex mouse bindings @@ -353,8 +346,7 @@ should be displayed in the minibuffer of the attached frame. Sometimes this can contain extra information such as file permissions, or tag location. -@node Displays Submenu, , Mouse Bindings, Basic Navigation -@comment node-name, next, previous, up +@node Displays Submenu @section Displays Submenu @cindex displays submenu @@ -370,8 +362,7 @@ The contents are modes currently loaded into emacs. By default, this would include Files, Quick Buffers, and Buffers. Other major display modes such as Info are loaded separately. -@node File Mode, Buffer Mode, Basic Navigation, Top -@comment node-name, next, previous, up +@node File Mode @chapter File Mode @cindex file mode @@ -388,8 +379,7 @@ Advanced behavior, like copying and renaming files, is also provided. * File Key Bindings:: Performing file operations. @end menu -@node Directory Display, Hidden Files, File Mode, File Mode -@comment node-name, next, previous, up +@node Directory Display @section Directory Display @cindex directory display @@ -472,8 +462,7 @@ Some group names may say something like @samp{speedbar-t to speedbar-v}, indicating that all symbols which alphabetically fall between those categories are included in that sub-group. @xref{Tag Hierarchy Methods}. -@node Hidden Files, File Key Bindings, Directory Display, File Mode -@comment node-name, next, previous, up +@node Hidden Files @section Hidden Files @cindex hidden files @@ -499,8 +488,7 @@ Object files fall into the category of level 2 hidden files. You can determine their presence by the @samp{#} and @samp{!} file indicators. @xref{Directory Display}. -@node File Key Bindings, , Hidden Files, File Mode -@comment node-name, next, previous, up +@node File Key Bindings @section File Key Bindings @cindex file key bindings @@ -538,8 +526,7 @@ list, are shown. By showing all files, additional files such as text files are also displayed, but they are prefixed with the @samp{[?]} symbol. This means that it is a file, but Emacs doesn't know how to expand it. -@node Buffer Mode, Minor Modes, File Mode, Top -@comment node-name, next, previous, up +@node Buffer Mode @chapter Buffer Mode @cindex buffer mode @@ -570,8 +557,7 @@ Thus, if you are in File mode, and you need quick access to a buffer, press @kbd{b}, click on the buffer you want, and speedbar will revert back to File mode. -@node Minor Modes, Customizing, Buffer Mode, Top -@comment node-name, next, previous, up +@node Minor Modes @chapter Minor Display Modes @cindex minor display modes @@ -593,8 +579,7 @@ key bindings and visuals, but will have specialized behaviors. stack trace. @end menu -@node RMAIL, Info, Minor Modes, Minor Modes -@comment node-name, next, previous, up +@node RMAIL @section RMAIL @cindex RMAIL @@ -615,8 +600,7 @@ the current RMAIL folder into a different folder by clicking the In this way you can manage your existing RMAIL folders fairly easily using the mouse. -@node Info, GDB, RMAIL, Minor Modes -@comment node-name, next, previous, up +@node Info @section Info @cindex Info @@ -630,8 +614,7 @@ are available. Since these sub-topics are not examined until you click the @samp{[+]} button, sometimes a @samp{[?]} will appear when you click on a @samp{[+]}, indicating that there are no sub-topics. -@node GDB, , Info, Minor Modes -@comment node-name, next, previous, up +@node GDB @section GDB @cindex gdb @cindex gud @@ -653,8 +636,7 @@ You can click on any stack element and gdb will move to that stack level. You can then check variables local to that level at the GDB prompt. -@node Customizing, Extending, Minor Modes, Top -@comment node-name, next, previous, up +@node Customizing @chapter Customizing @cindex customizing @@ -681,8 +663,7 @@ Customize speedbar's many colors and fonts. * Hooks:: The many hooks you can use. @end menu -@node Frames and Faces, Tag Hierarchy Methods, Customizing, Customizing -@comment node-name, next, previous, up +@node Frames and Faces @section Frames and Faces @cindex faces @cindex frame parameters @@ -726,8 +707,7 @@ it. In XEmacs, change the plist @code{speedbar-frame-plist}. This is the XEmacs way of doing the same thing. -@node Tag Hierarchy Methods, Version Control, Frames and Faces, Customizing -@comment node-name, next, previous, up +@node Tag Hierarchy Methods @section Tag Hierarchy Methods @cindex tag hierarchy @cindex tag groups @@ -806,8 +786,7 @@ are next to each other, then they are combined until this number of items is reached. @end table -@node Version Control, Hooks, Tag Hierarchy Methods, Customizing -@comment node-name, next, previous, up +@node Version Control @section Version Control @cindex version control @cindex vc extensions @@ -841,8 +820,7 @@ placed near this file. Lastly, you can change the VC indicator using the variable @code{speedbar-vc-indicator}, and specify a single character string. -@node Hooks, , Version Control, Customizing -@comment node-name, next, previous, up +@node Hooks @section Hooks @cindex hooks @@ -884,8 +862,7 @@ Set this to implement your own scanning or rescan safe functions with state data. @end table -@node Extending, GNU Free Documentation License, Customizing, Top -@comment node-name, next, previous, up +@node Extending @chapter Extending @cindex extending @@ -909,7 +886,7 @@ create specialized tagging functions. * Creating a display:: How to insert buttons and hierarchies. @end menu -@node Minor Display Modes, Major Display Modes, Extending, Extending +@node Minor Display Modes @section Minor Display Modes @cindex create minor display mode @@ -967,7 +944,7 @@ want to do is execute a check to see if you need to re-create your display. If it needs to be cleared, you need to erase the speedbar buffer yourself, and start drawing buttons. @xref{Creating a display}. -@node Major Display Modes, Tagging Extensions, Minor Display Modes, Extending +@node Major Display Modes @section Major Display Modes @cindex create major display mode @@ -1098,7 +1075,7 @@ Your custom function might look like this: Once you have done all this, speedbar will show an entry in the @samp{Displays} menu declaring that your extension is available. -@node Tagging Extensions, Creating a display, Major Display Modes, Extending +@node Tagging Extensions @section Tagging Extensions It is possible to create new methods for tagging files in speedbar. @@ -1138,7 +1115,7 @@ If your parser is only good for a few types of files, make sure that it is either a buffer local modification, or that the tag generator returns @code{t} for non valid buffers. -@node Creating a display, , Tagging Extensions, Extending +@node Creating a display @section Creating a display @cindex creating a display @@ -1240,13 +1217,12 @@ Two good values are @code{nil} and @code{statictag}. @end defun -@node GNU Free Documentation License, Index, Extending, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Index, , GNU Free Documentation License, Top -@comment node-name, next, previous, up +@node Index @unnumbered Concept Index @printindex cp diff --git a/doc/misc/srecode.texi b/doc/misc/srecode.texi index a6e4d73cc69..d76f9e09184 100644 --- a/doc/misc/srecode.texi +++ b/doc/misc/srecode.texi @@ -15,7 +15,7 @@ @c %**end of header @copying -Copyright @copyright{} 2007-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2007--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -26,8 +26,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -464,7 +463,7 @@ show NAME This will enable that section. -NOTE: May 11, 2008 - I haven't used this yet, so I don't know if it works. +NOTE: May 11, 2008: I haven't used this yet, so I don't know if it works. @node Special Variables @@ -576,10 +575,10 @@ macros which will enable different @var{sections}. The automatic section variables are. @itemize @bullet -@item @var{first} - The first entry in the table. -@item @var{notfirst} - Not the first entry in the table. -@item @var{last} - The last entry in the table -@item @var{notlast} - Not the last entry in the table. +@item @var{first}---The first entry in the table. +@item @var{notfirst}---Not the first entry in the table. +@item @var{last}---The last entry in the table +@item @var{notlast}---Not the last entry in the table. @end itemize @node Compound Variable Values @@ -1656,7 +1655,7 @@ This would be a field of the class being inserted into. Inside a body of code, such as a function or method body. - - no conventions yet. + ---no conventions yet. @section Standard Dictionary Values @@ -1780,7 +1779,7 @@ all template files for that application will be loaded. @end defun - todo - Add examples. Most core stuff is already described above. + todo: Add examples. Most core stuff is already described above. @node GNU Free Documentation License diff --git a/doc/misc/texinfo.tex b/doc/misc/texinfo.tex index b5f31415771..d64f45bbee9 100644 --- a/doc/misc/texinfo.tex +++ b/doc/misc/texinfo.tex @@ -3,11 +3,11 @@ % Load plain if necessary, i.e., if running under initex. \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi % -\def\texinfoversion{2012-11-08.11} +\def\texinfoversion{2013-01-01.15} % % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, -% 2007, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc. +% 2007, 2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc. % % This texinfo.tex file is free software: you can redistribute it and/or % modify it under the terms of the GNU General Public License as @@ -24,7 +24,8 @@ % % As a special exception, when this file is read by TeX when processing % a Texinfo source document, you may use the result without -% restriction. (This has been our intent since Texinfo was invented.) +% restriction. This Exception is an additional permission under section 7 +% of the GNU General Public License, version 3 ("GPLv3"). % % Please try the latest version of texinfo.tex before submitting bug % reports; you can get the latest version from: diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index 317d440c0d1..a683425868a 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi @@ -37,7 +37,7 @@ @end macro @copying -Copyright @copyright{} 1999-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1999--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -48,8 +48,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to -copy and modify this GNU manual. Buying copies from the FSF -supports it in developing GNU and promoting software freedom.'' +copy and modify this GNU manual.'' @end quotation @end copying @@ -375,7 +374,7 @@ This release includes the full documentation and code for @value{tramp}, suitable for installation. But Emacs (22 or later) includes @value{tramp} already, and there is a @value{tramp} package for XEmacs, as well. So maybe it is easier to just use those. But if -you want the bleeding edge, read on@dots{...} +you want the bleeding edge, read on@dots{} For the especially brave, @value{tramp} is available from Git. The Git version is the latest version of the code and may contain incomplete @@ -516,8 +515,8 @@ Method}. * Connection caching:: Reusing connection related information. * Remote Programs:: How @value{tramp} finds and uses programs on the remote machine. * Remote shell setup:: Remote shell setup hints. -* Windows setup hints:: Issues with Cygwin ssh. * Auto-save and Backup:: Auto-save and Backup. +* Windows setup hints:: Issues with Cygwin ssh. @end menu @@ -763,7 +762,7 @@ transferred with the corresponding inline method. It should provide a fair trade-off between both approaches. @table @asis -@item @option{rcp} --- @command{rsh} and @command{rcp} +@item @option{rcp}---@command{rsh} and @command{rcp} @cindex method rcp @cindex rcp method @cindex rcp (with rcp method) @@ -778,7 +777,7 @@ The alternative method @option{remcp} uses the @command{remsh} and @command{remsh} is used instead of @command{rsh}. -@item @option{scp} --- @command{ssh} and @command{scp} +@item @option{scp}---@command{ssh} and @command{scp} @cindex method scp @cindex scp method @cindex scp (with scp method) @@ -808,7 +807,7 @@ specify @samp{-p 42} in the argument list for @command{ssh}, and to specify @samp{-P 42} in the argument list for @command{scp}. -@item @option{sftp} --- @command{ssh} and @command{sftp} +@item @option{sftp}---@command{ssh} and @command{sftp} @cindex method sftp @cindex sftp method @cindex sftp (with sftp method) @@ -824,7 +823,7 @@ within this session. Instead of, @command{ssh} is used for login. This method supports the @samp{-p} argument. -@item @option{rsync} --- @command{ssh} and @command{rsync} +@item @option{rsync}---@command{ssh} and @command{rsync} @cindex method rsync @cindex rsync method @cindex rsync (with rsync method) @@ -845,7 +844,7 @@ the corresponding buffer, visiting this file, is alive. This method supports the @samp{-p} argument. -@item @option{scpx} --- @command{ssh} and @command{scp} +@item @option{scpx}---@command{ssh} and @command{scp} @cindex method scpx @cindex scpx method @cindex scp (with scpx method) @@ -868,7 +867,7 @@ to not print any shell prompt, which confuses @value{tramp} mightily. This method supports the @samp{-p} argument. -@item @option{scpc} --- @command{ssh} and @command{scp} +@item @option{scpc}---@command{ssh} and @command{scp} @cindex method scpc @cindex scpc method @cindex scp (with scpc method) @@ -899,7 +898,7 @@ version, must be set to @option{no}. This method supports the @samp{-p} argument. -@item @option{rsyncc} --- @command{ssh} and @command{rsync} +@item @option{rsyncc}---@command{ssh} and @command{rsync} @cindex method rsyncc @cindex rsyncc method @cindex rsync (with rsyncc method) @@ -913,7 +912,7 @@ which increases performance. This method supports the @samp{-p} argument. -@item @option{pscp} --- @command{plink} and @command{pscp} +@item @option{pscp}---@command{plink} and @command{pscp} @cindex method pscp @cindex pscp method @cindex pscp (with pscp method) @@ -928,7 +927,7 @@ of PuTTY, an SSH implementation for Windows. This method supports the @samp{-P} argument. -@item @option{psftp} --- @command{plink} and @command{psftp} +@item @option{psftp}---@command{plink} and @command{psftp} @cindex method psftp @cindex psftp method @cindex psftp (with psftp method) @@ -943,7 +942,7 @@ part of PuTTY, an SSH implementation for Windows. This method supports the @samp{-P} argument. -@item @option{fcp} --- @command{fsh} and @command{fcp} +@item @option{fcp}---@command{fsh} and @command{fcp} @cindex method fcp @cindex fcp method @cindex fsh (with fcp method) @@ -982,7 +981,7 @@ This works only for unified filenames, see @ref{Issues}. @end ifset -@item @option{smb} --- @command{smbclient} +@item @option{smb}---@command{smbclient} @cindex method smb @cindex smb method @@ -1866,7 +1865,7 @@ but it is not at the end of the buffer. This regular expression is used by @value{tramp} in the same way as @code{shell-prompt-pattern}, to match prompts from the remote shell. This second variable exists because the prompt from the remote shell -might be different from the prompt from a local shell --- after all, +might be different from the prompt from a local shell---after all, the whole point of @value{tramp} is to log in to remote hosts as a different user. The default value of @code{tramp-shell-prompt-pattern} is the same as the default value of @@ -1900,7 +1899,7 @@ of your (local or remote) host, you might need to adapt this. Example: "passwort" "Passwort" ;; Fran@,{c}ais "mot de passe" "Mot de passe") t) - ".*: + ".*:\0? *")) @end lisp In parallel, it might also be necessary to adapt @@ -2292,7 +2291,7 @@ This edits the same file, using the fully qualified domain name of the machine. @item @trampfn{, , melancholia, ~/.emacs} -This also edits the same file --- the @file{~} is expanded to your +This also edits the same file; the @file{~} is expanded to your home directory on the remote machine, just like it is locally. @item @trampfn{, , melancholia, ~daniel/.emacs} @@ -2381,13 +2380,13 @@ For the time being, @code{tramp-syntax} can have the following values: @itemize @w{} @ifset emacs -@item @code{ftp} -- That is the default syntax -@item @code{url} -- URL-like syntax +@item @code{ftp}---That is the default syntax +@item @code{url}---URL-like syntax @end ifset @ifset xemacs -@item @code{sep} -- That is the default syntax -@item @code{url} -- URL-like syntax -@item @code{ftp} -- EFS-like syntax +@item @code{sep}---That is the default syntax +@item @code{url}---URL-like syntax +@item @code{ftp}---EFS-like syntax @end ifset @end itemize diff --git a/doc/misc/trampver.texi b/doc/misc/trampver.texi index 96043a07300..6d5a8cb1c44 100644 --- a/doc/misc/trampver.texi +++ b/doc/misc/trampver.texi @@ -2,7 +2,7 @@ @c texi/trampver.texi. Generated from trampver.texi.in by configure. @c This is part of the Emacs manual. -@c Copyright (C) 2003-2012 Free Software Foundation, Inc. +@c Copyright (C) 2003-2013 Free Software Foundation, Inc. @c See file doclicense.texi for copying conditions. @c In the Tramp CVS, the version number is auto-frobbed from diff --git a/doc/misc/url.texi b/doc/misc/url.texi index f42007348ee..9e9dbc0a77d 100644 --- a/doc/misc/url.texi +++ b/doc/misc/url.texi @@ -20,7 +20,8 @@ @copying This is the manual for the @code{url} Emacs Lisp library. -Copyright @copyright{} 1993-1999, 2002, 2004-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1993--1999, 2002, 2004--2013 Free Software +Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -31,8 +32,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying diff --git a/doc/misc/vip.texi b/doc/misc/vip.texi index 4e85da70ca2..01048d43dbf 100644 --- a/doc/misc/vip.texi +++ b/doc/misc/vip.texi @@ -3,7 +3,7 @@ @settitle VIP @copying -Copyright @copyright{} 1987, 2001-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1987, 2001--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -14,8 +14,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -41,7 +40,7 @@ developing GNU and promoting software freedom.'' @end direntry @ifnottex -@node Top, Survey,, (DIR) +@node Top @top VIP VIP is a Vi emulating package written in Emacs Lisp. VIP implements most @@ -91,7 +90,7 @@ Comments and bug reports are welcome. Please send messages to @code{masahiko@@unsun.riec.tohoku.junet} if you are in Japan. @end iftex -@node Survey, Basic Concepts, Top, Top +@node Survey @chapter A Survey of VIP In this chapter we describe basics of VIP with emphasis on the features not @@ -105,7 +104,7 @@ found in Vi and on how to use VIP under GNU Emacs. * Differences from Vi:: Differences of VIP from Vi is explained. @end menu -@node Basic Concepts, Loading VIP, Survey, Survey +@node Basic Concepts @section Basic Concepts We begin by explaining some basic concepts of Emacs. These concepts are @@ -152,7 +151,7 @@ be executed when you type the key. If no function is bound to a key in the local map, however, the function bound to the key in the global map becomes in effect.@refill -@node Loading VIP, Modes in VIP, Basic Concepts, Survey +@node Loading VIP @section Loading VIP The recommended way to load VIP automatically is to include the line: @@ -178,7 +177,7 @@ M-x vip-mode @end example @noindent -@node Modes in VIP, Emacs Mode, Loading VIP, Survey +@node Modes in VIP @section Modes in VIP @kindex 032 @kbd{C-z} (@code{vip-change-mode-to-vi}) @@ -258,7 +257,7 @@ emacs mode vi mode insert mode know enough Emacs commands. @end menu -@node Emacs Mode, Vi Mode, Modes in VIP, Modes in VIP +@node Emacs Mode @subsection Emacs Mode @kindex 032 @kbd{C-z} (@code{vip-change-mode-to-vi}) @@ -268,14 +267,14 @@ normal Emacs editing in this mode. Note that the key @kbd{C-z} is globally bound to @code{vip-change-mode-to-vi}. So, if you type @kbd{C-z} in this mode then you will be in vi mode.@refill -@node Vi Mode, Insert Mode, Emacs Mode, Modes in VIP +@node Vi Mode @subsection Vi Mode This mode corresponds to Vi's command mode. Most Vi commands work as they do in Vi. You can go back to emacs mode by typing @kbd{C-z}. You can enter insert mode, just as in Vi, by typing @kbd{i}, @kbd{a} etc. -@node Insert Mode, Differences from Vi, Vi Mode, Modes in VIP +@node Insert Mode @subsection Insert Mode The key bindings in this mode is the same as in the emacs mode except for @@ -299,7 +298,7 @@ Thus typing @kbd{C-z x} in insert mode will have the same effect as typing @kbd{ESC x} in emacs mode. @end table -@node Differences from Vi, Undoing, Insert Mode, Survey +@node Differences from Vi @section Differences from Vi The major differences from Vi are explained below. @@ -324,7 +323,7 @@ The major differences from Vi are explained below. * Misc Commands:: Other useful commands. @end menu -@node Undoing, Changing, Differences from Vi, Differences from Vi +@node Undoing @subsection Undoing @kindex 165 @kbd{u} (@code{vip-undo}) @@ -335,7 +334,7 @@ a single change, while @kbd{u .@: .@: .@:}, for instance, will undo 4 previous changes. Undo is undoable as in Vi. So the content of the buffer will be the same before and after @kbd{u u}.@refill -@node Changing, Searching, Undoing, Differences from Vi +@node Changing @subsection Changing Some commands which change a small number of characters are executed @@ -348,7 +347,7 @@ then VIP will prompt you for a new word in the minibuffer by the prompt @kindex 007 @kbd{C-g} (@code{vip-keyboard-quit}) you can abort a partially formed command by typing @kbd{C-g}.@refill -@node Searching, z Command, Changing, Differences from Vi +@node Searching @subsection Searching @kindex 057 @kbd{/} (@code{vip-search-forward}) @@ -364,7 +363,7 @@ search string. (It is a limitation.) By default, search will wrap around the buffer as in Vi. You can change this by rebinding the variable @code{vip-search-wrap-around}. @xref{Customization}, for how to do this.@refill -@node z Command, Counts, Searching, Differences from Vi +@node z Command @subsection z Command @kindex 1723 @kbd{z H} (@code{vip-line-to-top}) @@ -379,7 +378,7 @@ For those of you who cannot remember which of @kbd{z} followed by @key{RET}, @kbd{M} and @kbd{L} to place the current line in the Home (Middle, and Last) line of the window.@refill -@node Counts, Marking, z Command, Differences from Vi +@node Counts @subsection Counts Some Vi commands which do not accept a count now accept one @@ -405,7 +404,7 @@ line. Given a count @var{n}, @var{n}-th occurrence will be searched. @end table -@node Marking, Region Commands, Counts, Differences from Vi +@node Marking @subsection Marking Typing an @kbd{m} followed by a lower-case character @var{ch} marks the @@ -425,7 +424,7 @@ Set mark at point (and push old mark on mark ring). Jump to mark (and pop mark off the mark ring). @end table -@node Region Commands, New Commands, Marking, Differences from Vi +@node Region Commands @subsection Region Commands @cindex region @@ -439,7 +438,7 @@ of @kbd{r} the region will first be enlarged so that it will become the smallest region containing the original region and consisting of whole lines. Thus @kbd{m .@: d R} will have the same effect as @kbd{d d}.@refill -@node New Commands, New Bindings, Region Commands, Differences from Vi +@node New Commands @subsection Some New Commands Note that the keys below (except for @kbd{R}) are not used in Vi. @@ -531,7 +530,7 @@ Check spelling of words in the region (@code{spell-region}). Call last keyboard macro. @end table -@node New Bindings, Window Commands, New Commands, Differences from Vi +@node New Bindings @subsection New Key Bindings In VIP the meanings of some keys are entirely different from Vi. These key @@ -591,7 +590,7 @@ In addition to these, @code{ctl-x-map} is slightly modified: This is equivalent to @kbd{C-x 1 C-x 2} (1 + 2 = 3). @end table -@node Window Commands, Buffer Commands, New Bindings, Differences from Vi +@node Window Commands @subsection Window Commands In this and following subsections, we give a summary of key bindings for @@ -615,7 +614,7 @@ Split current window into two windows. Show current buffer in two windows. @end table -@node Buffer Commands, File Commands, Window Commands, Differences from Vi +@node Buffer Commands @subsection Buffer Commands @table @kbd @@ -636,7 +635,7 @@ Kill the current buffer if it is not modified. Save the current buffer in the file associated to the buffer. @end table -@node File Commands, Misc Commands, Buffer Commands, Differences from Vi +@node File Commands @subsection File Commands @table @kbd @@ -657,7 +656,7 @@ Write current buffer into the specified file. Insert specified file at point. @end table -@node Misc Commands, Vi Commands, File Commands, Differences from Vi +@node Misc Commands @subsection Miscellaneous Commands @table @kbd @@ -678,13 +677,13 @@ Call last remembered keyboard macro. Suspend Emacs. @item Z Z Exit Emacs. -@itemx Q +@item Q Query replace. -@itemx R +@item R Replace. @end table -@node Vi Commands, Numeric Arguments, Misc Commands, Top +@node Vi Commands @chapter Vi Commands This chapter describes Vi commands other than Ex commands implemented in @@ -705,7 +704,7 @@ commands described in this chapter are to be used in vi mode. * Commands in Insert Mode:: Commands for entering insert mode. @end menu -@node Numeric Arguments, Important Keys, Vi Commands, Vi Commands +@node Numeric Arguments @section Numeric Arguments @cindex numeric arguments @@ -726,7 +725,7 @@ In many cases, if a count is given, the command is executed that many times. For instance, @kbd{5 d d} deletes 5 lines while simple @kbd{d d} deletes a line. In this manual the metavariable @var{n} will denote a count.@refill -@node Important Keys, Buffers and Windows, Numeric Arguments, Vi Commands +@node Important Keys @section Important Keys The keys @kbd{C-g} and @kbd{C-l} are unique in that their associated @@ -776,7 +775,7 @@ typing @kbd{\}. Thus @kbd{5 \ +}, as well as @kbd{\ C-u 5 +}, will insert @samp{+++++} before point.@refill @end table -@node Buffers and Windows, Files, Important Keys, Vi Commands +@node Buffers and Windows @section Buffers and Windows @cindex buffer @@ -843,7 +842,7 @@ by @key{RET}. The default buffer name to switch to will also be prompted, and you can select it by giving a simple @key{RET}. See GNU Emacs Manual for details of completion. -@node Files, Viewing the Buffer, Buffers and Windows, Vi Commands +@node Files @section Files We have the following commands related to files. They are used to visit, @@ -924,7 +923,7 @@ case), you can just say @kbd{X S}. If you wish to save it in another file, you can type @kbd{X W}. You will then get a similar prompt as you get for @kbd{v}, to which you can enter the file name.@refill -@node Viewing the Buffer, Mark Commands, Files, Vi Commands +@node Viewing the Buffer @section Viewing the Buffer In this and next section we discuss commands for moving around in the @@ -945,11 +944,11 @@ Scroll text of current window upward almost full screen. You can go @kindex 002 @kbd{C-b} (@code{vip-scroll-back}) Scroll text of current window downward almost full screen. You can go @i{backward} in the buffer by this command (@code{vip-scroll-back}). -@itemx C-d +@item C-d @kindex 004 @kbd{C-d} (@code{vip-scroll-up}) Scroll text of current window upward half screen. You can go @i{down} in the buffer by this command (@code{vip-scroll-down}). -@itemx C-u +@item C-u @kindex 025 @kbd{C-u} (@code{vip-scroll-down}) Scroll text of current window downward half screen. You can go @i{up} in the buffer by this command (@code{vip-scroll-up}). @@ -992,7 +991,7 @@ point will be placed in the @var{n}-th line from bottom Center point in window and redisplay screen (@code{recenter}). @end table -@node Mark Commands, Motion Commands, Viewing the Buffer, Vi Commands +@node Mark Commands @section Mark Commands The following commands are used to mark positions in the buffer. @@ -1020,7 +1019,7 @@ latest element of the mark ring (replacing the oldest one). By repeating the command `@kbd{m ,}' you can visit older and older marked positions. You will eventually be in a loop as the mark ring is a ring. -@node Motion Commands, Searching and Replacing, Mark Commands, Vi Commands +@node Motion Commands @section Motion Commands Commands for moving around in the current buffer are collected here. These @@ -1214,7 +1213,7 @@ Repeat previous @kbd{f}, @kbd{t}, @kbd{F} or @kbd{T} command, in the opposite direction (@code{vip-repeat-find-opposite}). @end table -@node Searching and Replacing, Modifying Commands, Motion Commands, Vi Commands +@node Searching and Replacing @section Searching and Replacing Following commands are available for searching and replacing. @@ -1278,7 +1277,7 @@ count, replace that many characters by @var{ch} (@code{vip-replace-char}). The commands @kbd{/} and @kbd{?} mark point before move, so that you can return to the original point by @w{@kbd{` `}}. -@node Modifying Commands, Delete Commands, Searching and Replacing, Vi Commands +@node Modifying Commands @section Modifying Commands In this section, commands for modifying the content of a buffer are @@ -1316,7 +1315,7 @@ command. * Change Commands:: Commands for changing text. * Repeating and Undoing Modifications:: @end menu -@node Delete Commands, Yank Commands, Modifying Commands, Modifying Commands +@node Delete Commands @subsection Delete Commands @table @kbd @@ -1368,7 +1367,7 @@ Delete a character before point. Given @var{n}, delete @var{n} characters (@code{vip-delete-backward-char}). @end table -@node Yank Commands, Put Back Commands, Delete Commands, Modifying Commands +@node Yank Commands @subsection Yank Commands @cindex yank @@ -1404,7 +1403,7 @@ Yank current region. Expand current region and yank it. @end table -@node Put Back Commands, Change Commands, Yank Commands, Modifying Commands +@node Put Back Commands @subsection Put Back Commands Deleted or yanked texts can be put back into the buffer by the command below. @@ -1435,7 +1434,7 @@ numeral between @kbd{1} and @kbd{9}. If the number register @var{n} is specified, @var{n}-th previously deleted/yanked text will be put back. It is an error to specify a number register for the delete/yank commands. -@node Change Commands, Repeating and Undoing Modifications, Put Back Commands, Modifying Commands +@node Change Commands @subsection Change Commands Most commonly used change command takes the following form. @@ -1468,7 +1467,7 @@ Change current region. Expand current region and change it. @end table -@node Repeating and Undoing Modifications, Other Vi Commands, Change Commands, Modifying Commands +@node Repeating and Undoing Modifications @subsection Repeating and Undoing Modifications VIP records the previous modifying command, so that it is easy to repeat @@ -1488,7 +1487,7 @@ count for the repeated command. Otherwise, the count for the last modifying command is used again (@code{vip-repeat}). @end table -@node Other Vi Commands, Commands in Insert Mode, Repeating and Undoing Modifications, Vi Commands +@node Other Vi Commands @section Other Vi Commands Miscellaneous Vi commands are collected here. @@ -1609,7 +1608,7 @@ command @kbd{P} or @kbd{p} can retrieve it from kill ring (@code{kill-region}). @end table -@node Commands in Insert Mode, Ex Commands, Other Vi Commands, Vi Commands +@node Commands in Insert Mode @section Insert Mode You can enter insert mode by one of the following commands. In addition to @@ -1677,7 +1676,7 @@ start point is saved for later use by repeat command etc. Therefore, repeat command will not really repeat insertion if you move point by emacs commands while in insert mode. -@node Ex Commands, Ex Command Reference, Commands in Insert Mode, Top +@node Ex Commands @chapter Ex Commands @kindex 072 @kbd{:} (@code{vip-ex}) @@ -1714,7 +1713,7 @@ character @samp{|}. @menu * Ex Command Reference:: Explain all the Ex commands available in VIP. @end menu -@node Ex Command Reference, Customization, Ex Commands, Ex Commands +@node Ex Command Reference @section Ex Command Reference In this section we briefly explain all the Ex commands supported by VIP@. Most Ex commands expect @var{address} as their argument, and they use @@ -1860,7 +1859,7 @@ The following Ex commands are available in Vi, but not implemented in VIP. @kbd{unabbreviate}, @kbd{xit}, @kbd{z} @end example -@node Customization, Customizing Constants, Ex Command Reference, Top +@node Customization @chapter Customization If you have a file called @file{.vip} in your home directory, then it @@ -1872,7 +1871,7 @@ customizing VIP. * Customizing Key Bindings:: How to change key bindings. @end menu -@node Customizing Constants, Customizing Key Bindings, Customization, Customization +@node Customizing Constants @section Customizing Constants An easy way to customize VIP is to change the values of constants used in VIP@. Here is the list of the constants used in VIP and their default @@ -1908,7 +1907,7 @@ can include a line like this in your @file{.vip} file: (setq vip-case-fold-search t) @end example -@node Customizing Key Bindings,, Customizing Constants, Customization +@node Customizing Key Bindings @section Customizing Key Bindings @cindex local keymap @@ -1932,7 +1931,7 @@ file. (define-key vip-command-mode-map "X" 'vip-delete-backward-char) @end example -@node GNU Free Documentation License,,, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi diff --git a/doc/misc/viper.texi b/doc/misc/viper.texi index 5fb1f92363a..9bcecf8e3de 100644 --- a/doc/misc/viper.texi +++ b/doc/misc/viper.texi @@ -7,7 +7,7 @@ @setfilename ../../info/viper @copying -Copyright @copyright{} 1995-1997, 2001-2012 Free Software Foundation, Inc. +Copyright @copyright{} 1995--1997, 2001--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -18,8 +18,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -47,9 +46,8 @@ developing GNU and promoting software freedom.'' @contents @ifnottex -@node Top, Overview,, (DIR) - -@unnumbered Viper +@node Top +@top Viper We believe that one or more of the following statements are adequate descriptions of Viper: @@ -76,7 +74,7 @@ Viper, formerly known as VIP-19, was written by Michael Kifer. It is based on VIP version 3.5 by Masahiko Sato and VIP version 4.4 by Aamod Sane. About 15% of the code still comes from those older packages. -Viper is intended to be usable without reading this manual --- the defaults +Viper is intended to be usable without reading this manual; the defaults are set to make Viper as close to Vi as possible. At startup, Viper will try to set the most appropriate default environment for you, based on your familiarity with Emacs. It will also tell you the basic GNU Emacs window @@ -100,16 +98,13 @@ Please use the Ex command @kbd{:submitReport} for this purpose.@refill * Improvements over Vi:: New features, Improvements * Customization:: How to customize Viper * Commands:: Vi and Ex Commands - +* GNU Free Documentation License:: The license for this documentation. +* Acknowledgments:: * Key Index:: Index of Vi and Ex Commands * Function Index:: Index of Viper Functions * Variable Index:: Index of Viper Variables * Package Index:: Index of Packages Mentioned in this Document * Concept Index:: Vi, Ex and Emacs concepts - -* Acknowledgments:: -* GNU Free Documentation License:: The license for this documentation. - @end menu @iftex @unnumbered Introduction @@ -134,8 +129,8 @@ Viper was written by Michael Kifer. It is based on VIP version 3.5 by Masahiko Sato and VIP version 4.4 by Aamod Sane. About 15% of the code still comes from those older packages. -Viper is intended to be usable out of the box, without reading this manual ---- the defaults are set to make Viper as close to Vi as possible. At +Viper is intended to be usable out of the box, without reading this manual; +the defaults are set to make Viper as close to Vi as possible. At startup, Viper will attempt to set the most appropriate default environment for you, based on your familiarity with Emacs. It will also tell you the basic GNU Emacs window management commands to help you start immediately. @@ -156,7 +151,7 @@ Please use the Ex command @kbd{:submitReport} for this purpose.@refill @end iftex -@node Overview,Improvements over Vi,Top,Top +@node Overview @chapter Overview of Viper Viper is a Vi emulation on top of Emacs. At the same time, Viper provides a @@ -186,7 +181,7 @@ included in your @file{~/.viper} file and are found at the following URL: * Unimplemented Features:: That are unlikely to be implemented. @end menu -@node Emacs Preliminaries, Loading Viper, Overview, Overview +@node Emacs Preliminaries @section Emacs Preliminaries @cindex buffer @@ -314,7 +309,7 @@ Emacs is structured as a Lisp interpreter around a C core. Emacs keys cause Lisp functions to be called. It is possible to call these functions directly, by typing @kbd{M-x function-name}. -@node Loading Viper, States in Viper, Emacs Preliminaries, Overview +@node Loading Viper @section Loading Viper The most common way to load it automatically is to include the following @@ -369,7 +364,7 @@ copy of Emacs after Viper has been loaded, the command @kbd{M-x viper-go-away} will do it for you. The function @code{toggle-viper-mode} toggles Viperization of Emacs on and off. -@node States in Viper, The Minibuffer, Loading Viper,Overview +@node States in Viper @section States in Viper @kindex @kbd{C-z} @@ -447,7 +442,7 @@ doing soon!), you should learn about the meaning of the various keys in those special modes (typing @kbd{C-h m} in a buffer provides help with key bindings for the major mode of that buffer). -If you switch to Vi in Dired or similar modes---no harm is done. It is just +If you switch to Vi in Dired or similar modes, no harm is done. It is just that the special key bindings provided by those modes will be temporarily overshadowed by Viper's bindings. Switching back to Viper's Emacs state will revive the environment provided by the current major mode. @@ -475,7 +470,7 @@ to allow Emacs keys in Insert state. replacement commands, such as cw, C, R, etc. @end menu -@node Emacs State, Vi State, States in Viper, States in Viper +@node Emacs State @subsection Emacs State @kindex @kbd{C-z} @@ -507,7 +502,7 @@ from the Insert state: typing @kbd{C-z} will let you execute a single Vi command while staying in Viper's Insert state. -@node Vi State, Insert State, Emacs State, States in Viper +@node Vi State @subsection Vi State @cindex Vi state @@ -667,7 +662,7 @@ Having found the appropriate command, it can be then executed by typing `@kbd{.}'. @xref{Improvements over Vi}, for more information. -@node Insert State, Replace State, Vi State, States in Viper +@node Insert State @subsection Insert State @cindex Insert state @@ -727,7 +722,7 @@ the Insert state. When Viper is in Insert state, you will see <I> in the mode line. -@node Replace State,, Insert State, States in Viper +@node Replace State @subsection Replace State @cindex Replace state @@ -759,7 +754,7 @@ was still inside the replacement region. So, in the above situation, Viper would delete text between this position and the end of the replacement region. -@node The Minibuffer,Multiple Files in Viper, States in Viper, Overview +@node The Minibuffer @section The Minibuffer @cindex Minibuffer @@ -809,7 +804,7 @@ has no mode line to tell which Vi state it is in. The appearance of the text in the minibuffer can be changed. @xref{Viper Specials}, for more details. -@node Multiple Files in Viper,Unimplemented Features,The Minibuffer,Overview +@node Multiple Files in Viper @section Multiple Files in Viper @cindex multiple files @@ -884,7 +879,7 @@ Currently undisplayed files can be listed using the @kbd{:ar} command. The command @kbd{:n} can be given counts from the @kbd{:ar} list to switch to other files. For example, use `:n3' to move to the third file in that list. -@node Unimplemented Features,,Multiple Files in Viper,Overview +@node Unimplemented Features @section Unimplemented Features Unimplemented features include: @@ -905,8 +900,7 @@ be used directly inside Emacs, since Emacs will obdurately change @samp{^I} back to normal tabs.@refill @end itemize -@comment node-name, next, previous, up -@node Improvements over Vi, Customization, Overview, Top +@node Improvements over Vi @chapter Improvements over Vi Some common problems with Vi and Ex have been solved in Viper. This @@ -927,7 +921,7 @@ the facilities provided by Emacs. you should know about. @end menu -@node Basics, Undo and Backups, Improvements over Vi, Improvements over Vi +@node Basics @section Basics The Vi command set is based on the idea of combining motion commands @@ -998,7 +992,7 @@ buffers. These can be seen in the @kbd{:args} list and switched using specify @code{(setq ex-cycle-through-non-files t)} in your @file{.viper} file. @xref{Customization}, for details. -@node Undo and Backups, History, Basics, Improvements over Vi +@node Undo and Backups @section Undo and Backups @cindex undo @@ -1034,7 +1028,7 @@ will show the text around the textmarker. @samp{register} and @samp{textmarker} can be any letters from a through z. @comment ] balance parens -@node History, Macros and Registers, Undo and Backups,Improvements over Vi +@node History @section History @cindex history @@ -1073,7 +1067,7 @@ Similarly, commands that have to do with switching buffers have a buffer history, and commands that expect strings or regular expressions keep a history on those items. -@node Macros and Registers,Completion,History,Improvements over Vi +@node Macros and Registers @section Macros and Registers @cindex keyboard macros @@ -1120,7 +1114,7 @@ Keyboard Macro execution @kbd{@@@@} (the replace). Viper also provides Vi-style macros. @xref{Vi Macros}, for details. -@node Completion, Improved Search, Macros and Registers, Improvements over Vi +@node Completion @section Completion @cindex completion @@ -1131,7 +1125,7 @@ no longer work for that file name. Remember that Emacs interprets a file name of the form @kbd{/foo//bar} as @kbd{/bar} and @kbd{/foo/~/bar} as @kbd{~/bar}. -@node Improved Search, Abbreviation Facilities, Completion, Improvements over Vi +@node Improved Search @section Improved Search @cindex buffer search @@ -1199,7 +1193,7 @@ faces are grouped together under Viper's Try it: it is really simple! -@node Abbreviation Facilities,Movement and Markers,Improved Search,Improvements over Vi +@node Abbreviation Facilities @section Abbreviation Facilities @cindex abbrevs @@ -1223,7 +1217,7 @@ keystroke, which appears earlier in the text. Emacs binds this to @code{dabbrev-expand} to that key. Facilities like this make Vi's @kbd{:ab} command obsolete. -@node Movement and Markers, New Commands, Abbreviation Facilities, Improvements over Vi +@node Movement and Markers @section Movement and Markers @cindex Ex style motion @@ -1299,7 +1293,7 @@ switch files by simply doing @kbd{'a}. If you set up a regimen for using Textmarkers, this is very useful. Contents of textmarkers can be viewed by @kbd{[marker}. (Contents of registers can be viewed by @kbd{]register}). -@node New Commands, Useful Packages, Movement and Markers, Improvements over Vi +@node New Commands @section New Commands These commands have no Vi analogs. @@ -1488,7 +1482,7 @@ Apart from the new commands, many old commands have been enhanced. Most notably, Vi style macros are much more powerful in Viper than in Vi. @xref{Vi Macros}, for details. -@node Useful Packages, ,New Commands, Improvements over Vi +@node Useful Packages @section Useful Packages Some Emacs packages are mentioned here as an aid to the new Viper user, to @@ -1569,7 +1563,7 @@ Emacs Lisp archives exist on and @samp{wuarchive.wustl.edu}@refill -@node Customization,Commands,Improvements over Vi,Top +@node Customization @chapter Customization @cindex customization @@ -1615,7 +1609,7 @@ cases, examples are provided that you can use directly. * Vi Macros:: How to do Vi style macros. @end menu -@node Rudimentary Changes,Key Bindings,Customization,Customization +@node Rudimentary Changes @section Rudimentary Changes @cindex setting variables @@ -1715,7 +1709,7 @@ If not @code{nil}, search wraps around the end/beginning of buffer. @item viper-search-scroll-threshold 2 If search lands within this many lines of the window top or bottom, the window will be scrolled up or down by about 1/7-th of its size, to reveal -the context. If the value is negative---don't scroll. +the context. If the value is negative, don't scroll. @item viper-tags-file-name "TAGS" The name of the file used as the tag table. @item viper-re-query-replace nil @@ -1839,10 +1833,10 @@ replacement regions, you can change @code{viper-replace-overlay-face} by specifying a new face. (Emacs faces are described in the Emacs Lisp reference.) On a color display, the following customization method is usually most effective: -@example +@smallexample (set-face-foreground viper-replace-overlay-face "DarkSlateBlue") (set-face-background viper-replace-overlay-face "yellow") -@end example +@end smallexample For a complete list of colors available to you, evaluate the expression @code{(x-defined-colors)}. (Type it in the buffer @code{*scratch*} and then hit the @kbd{C-j} key. @@ -1956,7 +1950,7 @@ can include a line like this in your @file{.viper} file: @vindex @code{viper-replace-state-hook} @vindex @code{viper-emacs-state-hook} -@node Key Bindings, Packages that Change Keymaps, Rudimentary Changes,Customization +@node Key Bindings @section Key Bindings @cindex key bindings @@ -2045,7 +2039,8 @@ can write this: @noindent To customize the binding for @kbd{C-h} in Insert state: @example -(define-key viper-insert-global-user-map "\C-h" 'my-del-backwards-function) +(define-key viper-insert-global-user-map "\C-h" + 'my-del-backwards-function) @end example @noindent @@ -2094,7 +2089,8 @@ Dired functions, the trick can be accomplished via the following code: (setq my-dired-vi-purist-map (make-sparse-keymap)) (define-key my-dired-vi-purist-map "k" 'viper-previous-line) (define-key my-dired-vi-purist-map "l" 'viper-forward-char) -(viper-modify-major-mode 'dired-mode 'emacs-state my-dired-vi-purist-map) +(viper-modify-major-mode 'dired-mode + 'emacs-state my-dired-vi-purist-map) @end example Yet another way to customize key bindings in a major mode is to edit the @@ -2192,8 +2188,8 @@ bindings in Emacs. @findex @code{viper-add-local-keys} @findex @code{viper-zap-local-keys} -@node Packages that Change Keymaps,Viper Specials,Key Bindings,Customization -@subsection Packages that Change Keymaps +@node Packages that Change Keymaps +@section Packages that Change Keymaps @cindex C-c and Viper @cindex Viper and C-c @@ -2321,7 +2317,7 @@ compatible with Viper is to have the file @file{my-mode.el} include the followin @findex @code{remove-hook} @findex @code{add-hook} -@node Viper Specials,Vi Macros,Packages that Change Keymaps,Customization +@node Viper Specials @section Viper Specials Viper extends Vi with a number of useful features. This includes various @@ -2706,7 +2702,7 @@ you will then have to write such a function and make it known to your Emacs. The function @code{viper-surrounding-word} in @file{viper.el} can be used as a guiding example. -@node Vi Macros, ,Viper Specials,Customization +@node Vi Macros @section Vi Macros @cindex Vi macros @@ -2786,7 +2782,7 @@ type @kbd{C-x q} (for confirmation) or @kbd{C-u C-x q} (for prompt). For details, @pxref{Keyboard Macro Query,,Customization,emacs,The GNU Emacs Manual} @refill -When the user finishes defining a macro (which is done by typing @kbd{C-x)} --- +When the user finishes defining a macro (which is done by typing @kbd{C-x)}, a departure from Vi), you will be asked whether you want this macro to be global, mode-specific, or buffer-specific. You will also be given a chance to save the macro in your @file{~/.viper} file. @@ -2993,7 +2989,7 @@ Finally, Viper provides a function that conveniently displays all macros currently defined. To see all macros along with their definitions, type @kbd{M-x viper-describe-kbd-macros}. -@node Commands,,Customization,Top +@node Commands @chapter Commands This section is a semi-automatically bowdlerized version of the Vi @@ -3012,8 +3008,7 @@ found on the Vi archives. This reference has been adapted for Viper.@refill * Mouse-bound Commands:: Search and insertion of text @end menu -@node Groundwork, Text Handling, Commands, Commands -@comment node-name, next, previous, up +@node Groundwork @section Groundwork The VI command set is based on the idea of combining motion commands @@ -3223,7 +3218,7 @@ ends at line 135. There is no need to type the line numbers, since Viper inserts them automatically in front of the Ex command. @cindex Ex commands -@node Text Handling, Display, Groundwork, Commands +@node Text Handling @section Text Handling @menu @@ -3238,7 +3233,7 @@ inserts them automatically in front of the Ex command. * Undoing:: Multiple Undo, Backups @end menu -@node Move Commands,Marking,,Text Handling +@node Move Commands @subsection Move Commands @cindex movement commands @@ -3265,7 +3260,7 @@ inserts them automatically in front of the Ex command. @item <count> $ To the end of line <count> from the cursor. @item <count> ^ -To the first CHAR <count> - 1 lines lower. +To the first CHAR <count> @minus{} 1 lines lower. @item <count> - To the first CHAR <count> lines higher. @item <count> + <cr> @@ -3434,7 +3429,7 @@ in your @file{~/.viper} file. @kindex @kbd{l} @vindex @code{viper-parse-sexp-ignore-comments} -@node Marking,Appending Text,Move Commands,Text Handling +@node Marking @subsection Marking Emacs mark is referred to in the region specifiers @kbd{r} and @kbd{R}. @@ -3470,7 +3465,7 @@ Exchange point and mark. Exchange point and mark and go to the first CHAR on line. @item '<a-z> Go to specified Viper mark. -@item +@item `<a-z> Go to specified Viper mark and go to the first CHAR on line. @end table @kindex @kbd{m<a-z>} @@ -3486,7 +3481,7 @@ Go to specified Viper mark and go to the first CHAR on line. @kindex @kbd{`<a-z>} @kindex @kbd{'<a-z>} -@node Appending Text, Editing in Insert State, Marking,Text Handling +@node Appending Text @subsection Appending Text @xref{Options}, to see how to change tab and shiftwidth size. See the GNU @@ -3568,7 +3563,7 @@ functions doing the perusing can be bound to unused keyboard keys in the @kindex @kbd{A} @kindex @kbd{a} -@node Editing in Insert State, Deleting Text, Appending Text,Text Handling +@node Editing in Insert State @subsection Editing in Insert State Minibuffer can be edited similarly to Insert state, and you can switch @@ -3594,7 +3589,7 @@ current line. @kindex @kbd{C-w} @kindex @kbd{C-v} -@node Deleting Text, Changing Text, Editing in Insert State, Text Handling +@node Deleting Text @subsection Deleting Text @@ -3637,7 +3632,7 @@ Shift <count> lines one shiftwidth to the left. @kindex @kbd{X} @kindex @kbd{x} -@node Changing Text, Search and Replace, Deleting Text,Text Handling +@node Changing Text @subsection Changing Text @cindex joining lines @@ -3647,10 +3642,10 @@ Shift <count> lines one shiftwidth to the left. @table @kbd @item <count> r<char> -Replace <count> chars by <char> - no <esc>. +Replace <count> chars by <char>; no <esc>. @item <count> R Overwrite the rest of the line, -appending change @var{count - 1} times. +appending change @var{count} @minus{} 1 times. @item <count> s Substitute <count> chars. @item <count> S @@ -3660,7 +3655,7 @@ Change from begin to endpoint of <count><move>. @item <count> cc Change <count> lines. @item <count> C -The rest of the line and <count> - 1 next lines. +The rest of the line and <count> @minus{} 1 next lines. @item <count> =<move> Reindent the region described by move. @item <count> ~ @@ -3745,7 +3740,7 @@ destructive Vi commands. @kindex @kbd{R} @kindex @kbd{r<char>} -@node Search and Replace, Yanking, Changing Text,Text Handling +@node Search and Replace @subsection Search and Replace @xref{Groundwork}, for Ex address syntax. @xref{Options}, to see how to @@ -3828,7 +3823,7 @@ Execute <ex-command> on all lines that do not match <pattern>. @kindex @kbd{?<string>} @kindex @kbd{/<string>} -@node Yanking,Undoing,Search and Replace,Text Handling +@node Yanking @subsection Yanking @cindex cut and paste @@ -3875,7 +3870,7 @@ Put the contents of the (default undo) buffer @kindex @kbd{yank} @findex @kbd{:yank} -@node Undoing,, Yanking,Text Handling +@node Undoing @subsection Undoing @cindex undo @@ -3901,7 +3896,7 @@ that have a @samp{~} appended to them. @kindex @kbd{U} @kindex @kbd{u} -@node Display, File and Buffer Handling, Text Handling, Commands +@node Display @section Display @cindex scrolling @@ -3913,7 +3908,7 @@ give file name, status, current line number and relative position.@* At user levels 2 and higher, abort the current command. @item C-c g -Give file name, status, current line number and relative position -- all +Give file name, status, current line number and relative position---all user levels. @item C-l Refresh the screen. @@ -3960,7 +3955,7 @@ Put line <count> in the center of the window @kindex @kbd{C-g} -@node File and Buffer Handling, Mapping, Display,Commands +@node File and Buffer Handling @section File and Buffer Handling @cindex multiple files @@ -4022,7 +4017,7 @@ Save and kill buffer. @item :x!@: [<file>] @kbd{:w![<file>]} and @kbd{:q}. @item :pre -Preserve the file -- autosave buffers. +Preserve the file---autosave buffers. @item :rec Recover file from autosave. @item :f [<file>] @@ -4112,7 +4107,7 @@ is typed in minibuffer. File completion and history are supported. @findex @kbd{:cd [<dir>]} @findex @kbd{:pwd} -@node Mapping, Shell Commands, File and Buffer Handling, Commands +@node Mapping @section Mapping @cindex key bindings @@ -4179,7 +4174,7 @@ Show contents of register. @findex @kbd{:unmap!@: <char>} @findex @kbd{:map!@: <char> <seq>} -@node Shell Commands, Options, Mapping, Commands +@node Shell Commands @section Shell Commands @cindex % (Current file) @@ -4245,7 +4240,7 @@ Run the make command in the current directory. @findex @kbd{:sh} @findex @kbd{:make} -@node Options,Emacs Related Commands,Shell Commands,Commands +@node Options @section Options @cindex Vi options @@ -4254,7 +4249,7 @@ Run the make command in the current directory. @item autoindent @itemx ai @cindex autoindent -autoindent -- In append mode after a <cr> the +autoindent: In append mode after a <cr> the cursor will move directly below the first character on the previous line. This setting affects the current buffer only. @@ -4270,7 +4265,7 @@ Cancel autoindent-global. @item ignorecase @itemx ic @cindex case and searching -ignorecase -- No distinction between upper and lower cases when searching. +ignorecase: No distinction between upper and lower cases when searching. @item noignorecase @itemx noic Cancel ignorecase. @@ -4284,7 +4279,7 @@ Cancel magic. @item readonly @itemx ro @cindex readonly files -readonly -- The file is not to be changed. +readonly: The file is not to be changed. If the user attempts to write to this file, confirmation will be requested. @item noreadonly @itemx noro @@ -4292,18 +4287,18 @@ Cancel readonly. @item shell=<string> @itemx sh=<string> @cindex shell -shell -- The program to be used for shell escapes +shell: The program to be used for shell escapes (default @samp{$SHELL} (default @file{/bin/sh})). @item shiftwidth=<count> @itemx sw=<count> @cindex layout @cindex shifting text -shiftwidth -- Gives the shiftwidth (default 8 positions). +shiftwidth: Gives the shiftwidth (default 8 positions). @item showmatch @itemx sm @cindex paren matching @cindex matching parens -showmatch -- Whenever you append a @kbd{)}, Vi shows +showmatch: Whenever you append a @kbd{)}, Vi shows its match if it's on the same page; also with @kbd{@{} and @kbd{@}}. If there's no match, Vi will beep. @item noshowmatch @@ -4313,7 +4308,7 @@ Cancel showmatch. @itemx ts=<count> @cindex changing tab width @cindex tabbing -tabstop -- The length of a <ht>; warning: this is +tabstop: The length of a <ht>; warning: this is only IN the editor, outside of it <ht>s have their normal length (default 8 positions). This setting affects the current buffer only. @@ -4324,13 +4319,13 @@ Same as `tabstop', but affects all buffers. @itemx wm=<count> @cindex auto fill @cindex word wrap -wrapmargin -- In append mode Vi automatically +wrapmargin: In append mode Vi automatically puts a <lf> whenever there is a <sp> or <ht> within <wm> columns from the right margin. @item wrapscan @itemx ws @cindex searching -wrapscan -- When searching, the end is +wrapscan: When searching, the end is considered @samp{stuck} to the begin of the file. @item nowrapscan @itemx nows @@ -4366,7 +4361,7 @@ Set <option> to <value>. @findex @kbd{:set ai} @findex @kbd{:set autoindent} -@node Emacs Related Commands,,Options,Commands +@node Emacs Related Commands @section Emacs Related Commands @table @kbd @@ -4416,7 +4411,7 @@ you need. @kindex @kbd{C-\} @kindex @kbd{C-c\} -@node Mouse-bound Commands,,,Commands +@node Mouse-bound Commands @section Mouse-bound Commands The following two mouse actions are normally bound to special search and @@ -4445,8 +4440,11 @@ already bound to something else. @kindex @kbd{meta button1up} @kindex @kbd{meta button2up} -@node Acknowledgments,,,Top -@comment node-name, next, previous, up +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + +@node Acknowledgments @unnumbered Acknowledgments Viper, formerly known as VIP-19, was written by Michael Kifer. Viper is @@ -4520,36 +4518,27 @@ whicken@@dragon.parasoft.com (Wendell Hicken), zapman@@cc.gatech.edu (Jason Zapman II), @end example -@node GNU Free Documentation License,,, Top -@appendix GNU Free Documentation License -@include doclicense.texi - -@node Key Index,Function Index,,Top -@comment node-name, next, previous, up +@node Key Index @unnumbered Key Index @printindex ky -@node Function Index,Variable Index,Key Index,Top -@comment node-name, next, previous, up +@node Function Index @unnumbered Function Index @printindex fn -@node Variable Index,Package Index,Function Index,Top -@comment node-name, next, previous, up +@node Variable Index @unnumbered Variable Index @printindex vr -@node Package Index,Concept Index,Variable Index,Top -@comment node-name, next, previous, up +@node Package Index @unnumbered Package Index @printindex pg -@node Concept Index,,Package Index,Top -@comment node-name, next, previous, up +@node Concept Index @unnumbered Concept Index @printindex cp diff --git a/doc/misc/widget.texi b/doc/misc/widget.texi index 4152b52250c..f2c403a2c14 100644 --- a/doc/misc/widget.texi +++ b/doc/misc/widget.texi @@ -8,7 +8,7 @@ @c %**end of header @copying -Copyright @copyright{} 2000-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2000--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -19,8 +19,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -32,8 +31,7 @@ developing GNU and promoting software freedom.'' @contents -@node Top, Introduction, (dir), (dir) -@comment node-name, next, previous, up +@node Top @top The Emacs Widget Library @insertcopying @@ -55,9 +53,8 @@ developing GNU and promoting software freedom.'' * Index:: @end menu -@node Introduction, User Interface, Top, Top -@comment node-name, next, previous, up -@section Introduction +@node Introduction +@chapter Introduction Most graphical user interface toolkits provide a number of standard user interface controls (sometimes known as `widgets' or `gadgets'). @@ -136,9 +133,8 @@ extended to use the GUI features. This means that your code using the widget library will also use the new graphic features automatically. @end enumerate -@node User Interface, Programming Example, Introduction, Top -@comment node-name, next, previous, up -@section User Interface +@node User Interface +@chapter User Interface A form consists of read only text for documentation and some fields, where each field contains two parts, a tag and a value. The tags are @@ -184,7 +180,7 @@ The top level widgets in this example are tagged @samp{Name}, within a form, namely editing the editable text fields and activating the buttons. -@subsection Editable Text Fields +@section Editable Text Fields In the example, the value for the @samp{Name} is most likely displayed in an editable text field, and so are values for each of the members of @@ -221,7 +217,7 @@ The editing text fields are highlighted with the Face used for other editing fields. @end deffn -@subsection Buttons +@section Buttons @cindex widget buttons @cindex button widgets @@ -292,7 +288,7 @@ Face used for highlighting a button when the mouse pointer moves across it. @end defopt -@subsection Navigation +@section Navigation You can use all the normal Emacs commands to move around in a form buffer, plus you will have these additional commands: @@ -309,9 +305,8 @@ Move point @var{count} buttons or editing fields backward. @end deffn @end table -@node Programming Example, Setting Up the Buffer, User Interface, Top -@comment node-name, next, previous, up -@section Programming Example +@node Programming Example +@chapter Programming Example @cindex widgets, programming example @cindex example of using widgets @@ -365,13 +360,14 @@ Interface}). (setq widget-example-repeat (widget-create 'editable-list :entry-format "%i %d %v" - :notify (lambda (widget &rest ignore) - (let ((old (widget-get widget - ':example-length)) - (new (length (widget-value widget)))) - (unless (eq old new) - (widget-put widget ':example-length new) - (message "You can count to %d." new)))) + :notify + (lambda (widget &rest ignore) + (let ((old (widget-get widget + ':example-length)) + (new (length (widget-value widget)))) + (unless (eq old new) + (widget-put widget ':example-length new) + (message "You can count to %d." new)))) :value '("One" "Eh, two?" "Five!") '(editable-field :value "three"))) (widget-insert "\n\nSelect multiple:\n\n") @@ -388,11 +384,13 @@ Interface}). :notify (lambda (widget &rest ignore) (message "You selected %s" (widget-value widget))) - '(item "One") '(item "Another One.") '(item "A Final One.")) + '(item "One") '(item "Another One.") + '(item "A Final One.")) (widget-insert "\n") (widget-create 'push-button :notify (lambda (&rest ignore) - (if (= (length (widget-value widget-example-repeat)) + (if (= (length + (widget-value widget-example-repeat)) 3) (message "Congratulation!") (error "Three was the count!"))) @@ -407,9 +405,8 @@ Interface}). (widget-setup)) @end lisp -@node Setting Up the Buffer, Basic Types, Programming Example, Top -@comment node-name, next, previous, up -@section Setting Up the Buffer +@node Setting Up the Buffer +@chapter Setting Up the Buffer Widgets are created with @code{widget-create}, which returns a @dfn{widget} object. This object can be queried and manipulated by @@ -461,9 +458,8 @@ Keymap used by @code{widget-button-press} and @code{widget-button-click} when not on a button. By default this is @code{global-map}. @end defvar -@node Basic Types, Sexp Types, Setting Up the Buffer, Top -@comment node-name, next, previous, up -@section Basic Types +@node Basic Types +@chapter Basic Types This is the general syntax of a type specification: @@ -704,9 +700,8 @@ If non-@code{nil}, allow glyphs to appear on displays where they are supported. * group:: @end menu -@node link, url-link, Basic Types, Basic Types -@comment node-name, next, previous, up -@subsection The @code{link} Widget +@node link +@section The @code{link} Widget @findex link@r{ widget} Syntax: @@ -729,9 +724,8 @@ String to prefix links. String to suffix links. @end defopt -@node url-link, info-link, link, Basic Types -@comment node-name, next, previous, up -@subsection The @code{url-link} Widget +@node url-link +@section The @code{url-link} Widget @findex url-link@r{ widget} Syntax: @@ -744,9 +738,8 @@ Syntax: When this link is invoked, the @acronym{WWW} browser specified by @code{browse-url-browser-function} will be called with @var{url}. -@node info-link, push-button, url-link, Basic Types -@comment node-name, next, previous, up -@subsection The @code{info-link} Widget +@node info-link +@section The @code{info-link} Widget @findex info-link@r{ widget} Syntax: @@ -758,9 +751,8 @@ Syntax: When this link is invoked, the built-in Info reader is started on @var{address}. -@node push-button, editable-field, info-link, Basic Types -@comment node-name, next, previous, up -@subsection The @code{push-button} Widget +@node push-button +@section The @code{push-button} Widget @findex push-button@r{ widget} Syntax: @@ -783,9 +775,8 @@ String to prefix push buttons. String to suffix push buttons. @end defopt -@node editable-field, text, push-button, Basic Types -@comment node-name, next, previous, up -@subsection The @code{editable-field} Widget +@node editable-field +@section The @code{editable-field} Widget @findex editable-field@r{ widget} Syntax: @@ -833,9 +824,8 @@ them. Pressing @key{RET} invokes the function specified by @code{:action}. @end table -@node text, menu-choice, editable-field, Basic Types -@comment node-name, next, previous, up -@subsection The @code{text} Widget +@node text +@section The @code{text} Widget @findex text@r{ widget} @vindex widget-text-keymap @@ -843,9 +833,8 @@ This is just like @code{editable-field}, but intended for multiline text fields. The default @code{:keymap} is @code{widget-text-keymap}, which does not rebind the @key{RET} key. -@node menu-choice, radio-button-choice, text, Basic Types -@comment node-name, next, previous, up -@subsection The @code{menu-choice} Widget +@node menu-choice +@section The @code{menu-choice} Widget @findex menu-choice@r{ widget} Syntax: @@ -884,9 +873,8 @@ The current chosen type. The list of types. @end table -@node radio-button-choice, item, menu-choice, Basic Types -@comment node-name, next, previous, up -@subsection The @code{radio-button-choice} Widget +@node radio-button-choice +@section The @code{radio-button-choice} Widget @findex radio-button-choice@r{ widget} Syntax: @@ -951,9 +939,8 @@ Please note that such items added after the @code{radio-button-choice} widget has been created will @strong{not} be properly destructed when you call @code{widget-delete}. -@node item, choice-item, radio-button-choice, Basic Types -@comment node-name, next, previous, up -@subsection The @code{item} Widget +@node item +@section The @code{item} Widget @findex item@r{ widget} Syntax: @@ -966,9 +953,8 @@ The @var{value}, if present, is used to initialize the @code{:value} property. The value should be a string, which will be inserted in the buffer. This widget will only match the specified value. -@node choice-item, toggle, item, Basic Types -@comment node-name, next, previous, up -@subsection The @code{choice-item} Widget +@node choice-item +@section The @code{choice-item} Widget @findex choice-item@r{ widget} Syntax: @@ -983,9 +969,8 @@ buffer as a button. Activating the button of a @code{choice-item} is equivalent to activating the parent widget. This widget will only match the specified value. -@node toggle, checkbox, choice-item, Basic Types -@comment node-name, next, previous, up -@subsection The @code{toggle} Widget +@node toggle +@section The @code{toggle} Widget @findex toggle@r{ widget} Syntax: @@ -1016,9 +1001,8 @@ Name of a glyph to be used instead of the @samp{:off} text string, on emacsen that supports this. @end table -@node checkbox, checklist, toggle, Basic Types -@comment node-name, next, previous, up -@subsection The @code{checkbox} Widget +@node checkbox +@section The @code{checkbox} Widget @findex checkbox@r{ widget} This widget has two possible states, @samp{selected} and @@ -1030,9 +1014,8 @@ Syntax: @var{type} ::= (checkbox [@var{keyword} @var{argument}]...) @end example -@node checklist, editable-list, checkbox, Basic Types -@comment node-name, next, previous, up -@subsection The @code{checklist} Widget +@node checklist +@section The @code{checklist} Widget @findex checklist@r{ widget} Syntax: @@ -1088,9 +1071,8 @@ The widgets representing each type. The list of types. @end table -@node editable-list, group, checklist, Basic Types -@comment node-name, next, previous, up -@subsection The @code{editable-list} Widget +@node editable-list +@section The @code{editable-list} Widget @findex editable-list@r{ widget} Syntax: @@ -1146,9 +1128,8 @@ The widgets representing the elements of the list. List whose @sc{car} is the type of the list elements. @end table -@node group, , editable-list, Basic Types -@comment node-name, next, previous, up -@subsection The @code{group} Widget +@node group +@section The @code{group} Widget @findex group@r{ widget} This widget simply group other widgets together. @@ -1161,9 +1142,8 @@ Syntax: The value is a list, with one member for each @var{type}. -@node Sexp Types, Widget Properties, Basic Types, Top -@comment -@section Sexp Types +@node Sexp Types +@chapter Sexp Types @cindex sexp types A number of widgets for editing @dfn{s-expressions} (Lisp types), sexp @@ -1177,9 +1157,8 @@ categories described in this section. * composite:: @end menu -@node constants, generic, Sexp Types, Sexp Types -@comment node-name, next, previous, up -@subsection The Constant Widgets +@node constants +@section The Constant Widgets @cindex constant widgets The @code{const} widget can contain any Lisp expression, but the user is @@ -1214,9 +1193,8 @@ An immutable symbol that is bound as a variable. An immutable symbol that is bound as a function. @end deffn -@node generic, atoms, constants, Sexp Types -@comment node-name, next, previous, up -@subsection Generic Sexp Widget +@node generic +@section Generic Sexp Widget @cindex generic sexp widget The @code{sexp} widget can contain any Lisp expression, and allows the @@ -1236,9 +1214,8 @@ The @code{sexp} widget takes the same keyword arguments as the @code{editable-field} widget. @xref{editable-field}. @end deffn -@node atoms, composite, generic, Sexp Types -@comment node-name, next, previous, up -@subsection Atomic Sexp Widgets +@node atoms +@section Atomic Sexp Widgets @cindex atomic sexp widget The atoms are s-expressions that do not consist of other s-expressions. @@ -1314,9 +1291,8 @@ either @code{nil} meaning false, or non-@code{nil} meaning true. @end deffn -@node composite, , atoms, Sexp Types -@comment node-name, next, previous, up -@subsection Composite Sexp Widgets +@node composite +@section Composite Sexp Widgets @cindex composite sexp widgets The syntax for the composite widget construct is: @@ -1416,9 +1392,8 @@ Specifies a list of any number of elements that fit a certain type. @end example @end deffn -@node Widget Properties, Defining New Widgets, Sexp Types, Top -@comment node-name, next, previous, up -@section Properties +@node Widget Properties +@chapter Properties @cindex properties of widgets @cindex widget properties @@ -1511,9 +1486,8 @@ its ancestors have been deactivated. Do not attempt to set the @code{:deactivate} keywords instead. -@node Defining New Widgets, Widget Browser, Widget Properties, Top -@comment node-name, next, previous, up -@section Defining New Widgets +@node Defining New Widgets +@chapter Defining New Widgets @cindex new widgets @cindex defining new widgets @@ -1696,9 +1670,8 @@ It provides most of the functionality that is referred to as ``by default'' in this text. @end deffn -@node Widget Browser, Widget Minor Mode, Defining New Widgets, Top -@comment node-name, next, previous, up -@section Widget Browser +@node Widget Browser +@chapter Widget Browser @cindex widget browser There is a separate package to browse widgets. This is intended to help @@ -1721,9 +1694,8 @@ Create a widget browser for the widget at @var{pos}. When called interactively, use the position of point. @end deffn -@node Widget Minor Mode, Utilities, Widget Browser, Top -@comment node-name, next, previous, up -@section Widget Minor Mode +@node Widget Minor Mode +@chapter Widget Minor Mode @cindex widget minor mode There is a minor mode for manipulating widgets in major modes that @@ -1739,9 +1711,8 @@ With arg, turn widget mode on if and only if arg is positive. Keymap used in @code{widget-minor-mode}. @end defvar -@node Utilities, Widget Wishlist, Widget Minor Mode, Top -@comment node-name, next, previous, up -@section Utilities. +@node Utilities +@chapter Utilities @cindex utility functions for widgets @defun widget-prompt-value widget prompt [ value unbound ] @@ -1755,9 +1726,8 @@ Get the item which @var{widget} is assumed to toggle. This is only meaningful for radio buttons or checkboxes in a list. @end defun -@node Widget Wishlist, GNU Free Documentation License, Utilities, Top -@comment node-name, next, previous, up -@section Wishlist +@node Widget Wishlist +@chapter Wishlist @cindex todo @itemize @bullet @@ -1814,12 +1784,11 @@ See @code{TeX-printer-list} for an explanation. Add a @code{mailto} widget. @end itemize -@node GNU Free Documentation License, Index, Widget Wishlist, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Index, , GNU Free Documentation License, Top -@comment node-name, next, previous, up +@node Index @unnumbered Index This is an alphabetical listing of all concepts, functions, commands, diff --git a/doc/misc/wisent.texi b/doc/misc/wisent.texi index 5c04631e3c7..d8557b84a4f 100644 --- a/doc/misc/wisent.texi +++ b/doc/misc/wisent.texi @@ -23,7 +23,7 @@ @c %**end of header @copying -Copyright @copyright{} 1988-1993, 1995, 1998-2004, 2007, 2012 +Copyright @copyright{} 1988--1993, 1995, 1998--2004, 2007, 2012--2013 Free Software Foundation, Inc. @c Since we are both GNU manuals, we do not need to ack each other here. @@ -43,8 +43,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -113,7 +112,7 @@ of the GNU Compiler Compiler Bison. Its code is a port of the C code of GNU Bison 1.28 & 1.31. For more details on the basic concepts for understanding Wisent, it is -worthwhile to read the @ref{Top, Bison Manual, bison}. +worthwhile to read the @ref{Top, Bison Manual, , bison}. @ifhtml @uref{http://www.gnu.org/manual/bison/html_node/index.html}. @end ifhtml @@ -226,8 +225,7 @@ in between, can be combined into a larger grouping of type @samp{exp}. * Conflicts:: @end menu -@node Grammar format, Example, Wisent Grammar, Wisent Grammar -@comment node-name, next, previous, up +@node Grammar format @section Grammar format @cindex grammar format @@ -304,7 +302,7 @@ If @var{components} in a rule is @code{nil}, it means that the rule can match the empty string. For example, here is how to define a comma-separated sequence of zero or more @samp{exp} groupings: -@example +@smallexample @group (expseq (nil) ;; expseq: ;; empty ((expseq1)) ;; | expseq1 @@ -314,7 +312,7 @@ comma-separated sequence of zero or more @samp{exp} groupings: ((expseq1 ?, exp)) ;; | expseq1 ',' exp ) ;; ; @end group -@end example +@end smallexample @cindex precedence level @item precedence @@ -341,7 +339,7 @@ serves to stand for its precedence: Now the precedence of @code{UMINUS} can be used in specific rules: -@example +@smallexample @group (exp @dots{} ;; exp: @dots{} ((exp ?- exp)) ;; | exp '-' exp @@ -350,7 +348,7 @@ Now the precedence of @code{UMINUS} can be used in specific rules: @dots{} ;; @dots{} ) ;; ; @end group -@end example +@end smallexample If you forget to append @code{[UMINUS]} to the rule for unary minus, Wisent silently assumes that minus has its usual precedence. This @@ -445,8 +443,7 @@ matching the empty string, for which the default action is to return @end table @end table -@node Example, Compiling a grammar, Grammar format, Wisent Grammar -@comment node-name, next, previous, up +@node Example @section Example @cindex grammar example @@ -561,8 +558,7 @@ exp: @end group @end example -@node Compiling a grammar, Conflicts, Example, Wisent Grammar -@comment node-name, next, previous, up +@node Compiling a grammar @section Compiling a grammar @cindex automaton @@ -620,8 +616,7 @@ an Emacs Lisp function (lambda expression). @end table @end defun -@node Conflicts, , Compiling a grammar, Wisent Grammar -@comment node-name, next, previous, up +@node Conflicts @section Conflicts Normally, a grammar should produce an automaton where at each state @@ -1034,7 +1029,6 @@ state 8 $default reduce using rule 2 (exp) - state 9 exp -> exp . '+' exp (rule 1) @@ -1049,7 +1043,6 @@ state 9 $default reduce using rule 3 (exp) - state 10 exp -> exp . '+' exp (rule 1) @@ -1610,7 +1603,7 @@ it can be worth a mix of the two styles! * Useful functions:: @end menu -@node Iterative style, Bison style, Grammar styles, Grammar styles +@node Iterative style @subsection Iterative style @cindex grammar iterative style diff --git a/doc/misc/woman.texi b/doc/misc/woman.texi index 16fb83ad18f..3e4448ed1e0 100644 --- a/doc/misc/woman.texi +++ b/doc/misc/woman.texi @@ -2,11 +2,7 @@ @c %**start of header @setfilename ../../info/woman @settitle WoMan: Browse Unix Manual Pages ``W.O. (without) Man'' -@c FIXME -@c Manual last updated: -@set UPDATED Time-stamp: <Thu 24-Jun-2010 00:06:54 gm on grasmoor> -@c Software version: -@set VERSION 0.54 (beta) +@include emacsver.texi @afourpaper @c With different size paper the printed page breaks will need attention! @c Look for @page and @need commands. @@ -18,7 +14,7 @@ This file documents WoMan: A program to browse Unix manual pages `W.O. (without) man'. -Copyright @copyright{} 2001-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2001--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -29,8 +25,7 @@ and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License.'' (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying @@ -44,7 +39,7 @@ developing GNU and promoting software freedom.'' @titlepage @title WoMan @subtitle Browse Unix Manual Pages ``W.O. (without) Man'' -@subtitle Software Version @value{VERSION} +@subtitle as distributed with Emacs @value{EMACSVER} @author Francis J. Wright @sp 2 @author School of Mathematical Sciences @@ -54,8 +49,6 @@ developing GNU and promoting software freedom.'' @author @email{F.J.Wright@@qmul.ac.uk} @author @uref{http://centaur.maths.qmw.ac.uk/} @c He no longer maintains this manual. -@sp 2 -@author Manual Last Updated @value{UPDATED} @comment The following two commands start the copyright page. @page @@ -68,13 +61,11 @@ developing GNU and promoting software freedom.'' @c =================================================================== @ifnottex -@node Top, Introduction, (dir), (dir) -@comment node-name, next, previous, up +@node Top @top WoMan: Browse Unix Manual Pages ``W.O. (without) Man'' @display -Software Version @value{VERSION} -Manual Last Updated @value{UPDATED} +As distributed with Emacs @value{EMACSVER}. @email{F.J.Wright@@qmw.ac.uk, Francis J. Wright} @uref{http://centaur.maths.qmw.ac.uk/, School of Mathematical Sciences} @@ -104,8 +95,7 @@ Mile End Road, London E1 4NS, UK @c =================================================================== -@node Introduction, Background, Top, Top -@comment node-name, next, previous, up +@node Introduction @chapter Introduction @cindex introduction @@ -166,8 +156,7 @@ Reporting Bugs}. @c =================================================================== -@node Background, Finding, Introduction, Top -@comment node-name, next, previous, up +@node Background @chapter Background @cindex background @@ -296,8 +285,7 @@ be possible to move WoMan from an emulation of @code{nroff} to an emulation of @code{troff} as GNU Emacs moves to providing bit-mapped display facilities. -@node Finding, Browsing, Background, Top -@comment node-name, next, previous, up +@node Finding @chapter Finding and Formatting Man Pages @cindex using, finding man pages @cindex using, formatting man pages @@ -353,8 +341,7 @@ setting WoMan file paths. * Automatic:: Automatic Interface @end menu -@node Topic, Filename, Finding, Finding -@comment node-name, next, previous, up +@node Topic @section Topic Interface @cindex topic interface @@ -435,8 +422,7 @@ slow. @xref{Cache, , The WoMan Topic Cache}, for further details. * Word at point:: Using the "Word at Point" as a Topic Suggestion @end menu -@node Cache, Word at point, Topic, Topic -@comment node-name, next, previous, up +@node Cache @subsection The WoMan Topic Cache @cindex topic cache @cindex cache, topic @@ -470,8 +456,7 @@ automatically update its cache file on disc (if one is in use) the next time it is run in a new Emacs session. -@node Word at point, , Cache, Topic -@comment node-name, next, previous, up +@node Word at point @subsection Using the "Word at Point" as a Topic Suggestion @cindex word at point @cindex point, word at @@ -497,8 +482,7 @@ point without seeking confirmation: @end lisp -@node Filename, Automatic, Topic, Finding -@comment node-name, next, previous, up +@node Filename @section Filename Interface @cindex filename interface @@ -547,8 +531,7 @@ the current buffer if it is visiting a man file, although it is primarily used internally by WoMan. -@node Automatic, , Filename, Finding -@comment node-name, next, previous, up +@node Automatic @section Automatic Interface @cindex automatic interface @@ -585,8 +568,7 @@ by automatic major mode selection.] @c =================================================================== -@node Browsing, Customization, Finding, Top -@comment node-name, next, previous, up +@node Browsing @chapter Browsing Man Pages @cindex using, browsing man pages @cindex browsing man pages @@ -616,8 +598,7 @@ blank lines squeezed to a single blank line. * Imenu:: Imenu Support; Contents Menu @end menu -@node Fonts, Navigation, Browsing, Browsing -@comment node-name, next, previous, up +@node Fonts @section Fonts and Faces @cindex fonts @cindex faces @@ -632,8 +613,7 @@ currently means the characters ^ and _ used to indicate super- and sub-scripts, which are not displayed well by WoMan. -@node Navigation, References, Fonts, Browsing -@comment node-name, next, previous, up +@node Navigation @section Navigation @cindex navigation @@ -678,8 +658,7 @@ described by @code{Man-see-also-regexp}. @end table -@node References, Changing, Navigation, Browsing -@comment node-name, next, previous, up +@node References @section Following References @cindex following references @cindex references @@ -722,8 +701,7 @@ default is based on word at point. @end table -@node Changing, Convenience, References, Browsing -@comment node-name, next, previous, up +@node Changing @section Changing the Current Man Page @cindex changing current man page @cindex current man page, changing @@ -790,8 +768,7 @@ Call WoMan to reformat the last man page formatted by WoMan @end table -@node Convenience, Imenu, Changing, Browsing -@comment node-name, next, previous, up +@node Convenience @section Convenience Key Bindings @cindex convenience key bindings @cindex key bindings, convenience @@ -832,8 +809,7 @@ followed by the minor modes, each on a separate page. @end table -@node Imenu, , Convenience, Browsing -@comment node-name, next, previous, up +@node Imenu @section Imenu Support; Contents Menu @cindex imenu support @cindex contents menu @@ -853,8 +829,7 @@ is distributed with GNU Emacs. @c =================================================================== -@node Customization, Log, Browsing, Top -@comment node-name, next, previous, up +@node Customization @chapter Customization @cindex customization @@ -911,8 +886,7 @@ man page. * Special symbols:: @end menu -@node Interface Options, Formatting Options, Customization, Customization -@comment node-name, next, previous, up +@node Interface Options @section Interface Options @cindex interface options @@ -1138,8 +1112,7 @@ default value is non-@code{nil}. @end vtable -@node Formatting Options, Faces, Interface Options, Customization -@comment node-name, next, previous, up +@node Formatting Options @section Formatting Options @cindex formatting options @@ -1182,8 +1155,7 @@ untested. @end vtable -@node Faces, Special symbols, Formatting Options, Customization -@comment node-name, next, previous, up +@node Faces @section Faces @cindex faces @@ -1218,8 +1190,7 @@ Default: foreground orange. @end vtable -@node Special symbols, , Faces, Customization -@comment node-name, next, previous, up +@node Special symbols @section Special symbols @cindex special symbols @@ -1256,8 +1227,7 @@ Under MS-Windows, the default is @c =================================================================== -@node Log, Technical, Customization, Top -@comment node-name, next, previous, up +@node Log @chapter The *WoMan-Log* Buffer @cindex log buffer @cindex buffer, log @@ -1281,8 +1251,7 @@ left in the formatted buffer to indicate precisely where they occurred. @c =================================================================== -@node Technical, Bugs, Log, Top -@comment node-name, next, previous, up +@node Technical @chapter Technical Details @cindex technical details @cindex horizontal spacing @@ -1306,8 +1275,7 @@ is output. @c =================================================================== -@node Bugs, Acknowledgments, Technical, Top -@comment node-name, next, previous, up +@node Bugs @chapter Reporting Bugs @cindex reporting bugs @cindex bugs, reporting @@ -1331,8 +1299,7 @@ man source file from, but do not send it unless asked to send it. @c =================================================================== -@node Acknowledgments, GNU Free Documentation License, Bugs, Top -@comment node-name, next, previous, up +@node Acknowledgments @chapter Acknowledgments @cindex acknowledgments @@ -1388,18 +1355,16 @@ Eli Zaretskii, @email{eliz@@is.elta.co.il} @page -@node GNU Free Documentation License, Command Index, Acknowledgments, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Command Index, Variable Index, GNU Free Documentation License, Top -@comment node-name, next, previous, up +@node Command Index @unnumbered Command Index @printindex fn -@node Variable Index, Keystroke Index, Command Index, Top -@comment node-name, next, previous, up +@node Variable Index @unnumbered Variable Index @printindex vr @@ -1410,8 +1375,7 @@ Eli Zaretskii, @email{eliz@@is.elta.co.il} @page -@node Keystroke Index, Concept Index, Variable Index, Top -@comment node-name, next, previous, up +@node Keystroke Index @unnumbered Keystroke Index @printindex ky @@ -1422,8 +1386,7 @@ Eli Zaretskii, @email{eliz@@is.elta.co.il} @page -@node Concept Index, , Keystroke Index, Top -@comment node-name, next, previous, up +@node Concept Index @unnumbered Concept Index @printindex cp |