diff options
Diffstat (limited to 'doc')
83 files changed, 2912 insertions, 1972 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index e4c36533caf..90e31b9923e 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog @@ -1,34 +1,83 @@ -2013-03-12 Glenn Morris <rgm@gnu.org> +2013-03-17 Paul Eggert <eggert@cs.ucla.edu> + + doc: convert some TeX accents to UTF-8 + * ack.texi (Acknowledgments): + * emacs.texi (Acknowledgments): + Convert some TeX accents (e.g., '@l{}') to UTF-8 (e.g., 'Å‚'). + Apparently the TeX accents cause problems when generating gnu.org + web pages, e.g., @l{} is rendered as '/l' on + <http://www.gnu.org/software/emacs/manual/html_node/ + emacs/Acknowledgments.html>. + +2013-03-16 Glenn Morris <rgm@gnu.org> * emacs.texi (Top): Add some stuff specific to www.gnu.org. -2013-03-11 Glenn Morris <rgm@gnu.org> +2013-03-04 Paul Eggert <eggert@cs.ucla.edu> - * Version 24.3 released. + Prefer UTF-8 for documentation. + With GNU Texinfo 5.0, this generates nicer-looking info files, + since they can use curly quotes. With older Texinfo it doesn't matter. + * ack.texi, cal-xtra.texi, calendar.texi, emacs-xtra.texi, emacs.texi: + Switch from Latin-1 to UTF-8. -2013-02-27 Bastien Guerry <bzg@gnu.org> +2013-02-28 Bastien Guerry <bzg@gnu.org> * xresources.texi (GTK resources): Fix broken link. +2013-02-25 Eli Zaretskii <eliz@gnu.org> + + * files.texi (Interlocking): Don't refer to symlinks as the + exclusive means of locking files. + 2013-02-22 Glenn Morris <rgm@gnu.org> * ack.texi (Acknowledgments): * emacs.texi (Acknowledgments): Small updates. +2013-02-21 Glenn Morris <rgm@gnu.org> + + * files.texi (File Conveniences): Not just GIFs can be animated. + +2013-02-13 Glenn Morris <rgm@gnu.org> + + * ack.texi (Acknowledgments): Don't mention yow any more. + +2013-02-13 Paul Eggert <eggert@cs.ucla.edu> + + * cmdargs.texi (General Variables): + Fix TMPDIR documentation to match the code's behavior. + 2013-02-10 Glenn Morris <rgm@gnu.org> * trouble.texi (Checklist): Update bug keybinding. -2013-01-18 Glenn Morris <rgm@gnu.org> +2013-02-09 Eli Zaretskii <eliz@gnu.org> - * custom.texi (Directory Variables): Fix paren typo. + * msdog.texi (Text and Binary): Delete the description of + file-name-buffer-file-type-alist. -2013-01-16 Glenn Morris <rgm@gnu.org> +2013-01-19 Paul Eggert <eggert@cs.ucla.edu> + + * trouble.texi (Crashing): Suggest -p for newer addr2line. (Bug#13445) + Without it, I don't see function names. Older addr2line + implementations will die out sooner or later, so tailor the + first suggestion to recent addr2line, with a followup about + older ones. + +2013-01-19 Glenn Morris <rgm@gnu.org> + + * custom.texi (Directory Variables): Fix paren typo. * trouble.texi (Crashing): Not all addr2line have -p. (Bug#13445) * custom.texi (Custom Themes): Fix typo. +2013-01-07 Bastien Guerry <bzg@gnu.org> + + * help.texi (Apropos): Document `apropos-user-option' and update + the doc for `apropos-variable'. + 2013-01-05 Glenn Morris <rgm@gnu.org> * text.texi (HTML Mode): Remove deleted nxml C-RET binding. @@ -43,35 +92,63 @@ * frames.texi (Mouse Commands): Fix description of the effect of mouse dragging (Bug#13049). -2012-12-08 Dani Moncayo <dmoncayo@gmail.com> +2012-12-15 Juri Linkov <juri@jurta.org> + + * misc.texi (Recursive Edit): Add a link to "Query Replace". + (Bug#13181) + +2012-12-10 Dani Moncayo <dmoncayo@gmail.com> * killing.texi (Deletion): Doc fix (Bug#12748). -2012-12-03 Juanma Barranquero <lekktu@gmail.com> +2012-12-06 Paul Eggert <eggert@cs.ucla.edu> + + * doclicense.texi, gpl.texi: Update to latest version from FSF. + These are just minor editorial changes. + +2012-12-06 Juanma Barranquero <lekktu@gmail.com> * vc1-xtra.texi (General VC Options): Remove obsolete reference to `vc-path'. -2012-12-02 Chong Yidong <cyd@gnu.org> +2012-12-03 Chong Yidong <cyd@gnu.org> * custom.texi (Init Rebinding): kbd is now a function (Bug#13052). -2012-11-18 Dani Moncayo <dmoncayo@gmail.com> +2012-12-02 Kevin Ryde <user42@zip.com.au> + + * maintaining.texi (Tag Syntax): Mention (defvar foo) handling. + +2012-12-01 Kevin Ryde <user42@zip.com.au> + + * maintaining.texi (Tag Syntax): Mention Perl's "use constant". + +2012-11-24 Paul Eggert <eggert@cs.ucla.edu> + + * doclicense.texi, gpl.texi: Update to latest version from FSF. + These are just minor editorial changes. + +2012-11-21 Dani Moncayo <dmoncayo@gmail.com> * display.texi (Auto Scrolling): Fix some inaccuracies, plus clarifications (Bug#12865). (Horizontal Scrolling): Clarifications. -2012-11-17 Dani Moncayo <dmoncayo@gmail.com> +2012-11-18 Dani Moncayo <dmoncayo@gmail.com> * mark.texi (Disabled Transient Mark): Doc fixes (Bug#12746). -2012-11-12 Chong Yidong <cyd@gnu.org> +2012-11-16 Eli Zaretskii <eliz@gnu.org> + + * trouble.texi (Crashing): Add information about MS-Windows and + the emacs_backtrace.txt file. (Bug#12908) + +2012-11-13 Chong Yidong <cyd@gnu.org> * building.texi (Multithreaded Debugging): gdb-stopped-hooks is actually named gdb-stopped-functions. -2012-11-12 Glenn Morris <rgm@gnu.org> +2012-11-13 Glenn Morris <rgm@gnu.org> * misc.texi (Single Shell): Mention async-shell-command-buffer. @@ -79,23 +156,21 @@ * misc.texi (Terminal emulator): Rename `term-face' to `term'. -2012-11-09 Glenn Morris <rgm@gnu.org> - * emacs.texi (Acknowledgments): Add profiler author. * ack.texi (Acknowledgments): Add some recent contributions. -2012-11-08 Chong Yidong <cyd@gnu.org> +2012-11-10 Chong Yidong <cyd@gnu.org> * files.texi (Diff Mode): Doc fixes for diff-delete-trailing-whitespace (Bug#12831). * trouble.texi (Crashing): Copyedits. -2012-11-08 Glenn Morris <rgm@gnu.org> +2012-11-10 Glenn Morris <rgm@gnu.org> * files.texi (Diff Mode): Trailing whitespace updates. -2012-11-07 Chong Yidong <cyd@gnu.org> +2012-11-10 Chong Yidong <cyd@gnu.org> * misc.texi (Terminal emulator): Document Term mode faces. @@ -110,13 +185,13 @@ * trouble.texi (Memory Full): Capitalize Buffer Menu. -2012-11-05 Eli Zaretskii <eliz@gnu.org> +2012-11-10 Eli Zaretskii <eliz@gnu.org> * display.texi (Auto Scrolling): Clarify that scroll-step is ignored when scroll-conservatively is set to a non-zero value. (Bug#12801) -2012-11-05 Chong Yidong <cyd@gnu.org> +2012-11-10 Chong Yidong <cyd@gnu.org> * dired.texi (Dired Updating): Doc fix (Bug#11744). diff --git a/doc/emacs/ack.texi b/doc/emacs/ack.texi index adb9b54122d..0d0ed9e37f4 100644 --- a/doc/emacs/ack.texi +++ b/doc/emacs/ack.texi @@ -1,4 +1,4 @@ -@c -*- coding: iso-latin-1 -*- +@c -*- coding: utf-8 -*- @c This is part of the Emacs manual. @c Copyright (C) 1994-1997, 1999-2013 Free Software Foundation, Inc. @c See file emacs.texi for copying conditions. @@ -53,7 +53,7 @@ Michael Albinus wrote @file{dbus.el}, a package that implements the D-Bus message bus protocol; @file{zeroconf.el}, a mode for browsing Avahi services; @file{xesam.el}, a Xesam-based search engine interface; and @file{secrets.el}, an interface to keyring daemons for -storing confidential data. He and Kai Großjohann wrote the Tramp package, which +storing confidential data. He and Kai Großjohann wrote the Tramp package, which provides transparent remote file editing using rcp, ssh, ftp, and other network protocols. He and Daniel Pittman wrote @file{tramp-cache.el}. @@ -68,7 +68,7 @@ Joe Arceneaux wrote the original text property implementation, and implemented support for X11. @item -Emil Åström, Milan Zamaza, and Stefan Bruda wrote @file{prolog.el}, +Emil Ã…ström, Milan Zamaza, and Stefan Bruda wrote @file{prolog.el}, a mode for editing Prolog (and Mercury) code. @item @@ -166,7 +166,7 @@ David M. Brown wrote @file{array.el}, for editing arrays and other tabular data. @item -W@l{}odek Bzyl and Ryszard Kubiak wrote @file{ogonek.el}, a package for +WÅ‚odek Bzyl and Ryszard Kubiak wrote @file{ogonek.el}, a package for changing the encoding of Polish characters. @item @@ -260,7 +260,7 @@ text replace the current selection. Eric Ding wrote @file{goto-addr.el}, @item -Jan Djärv added support for the GTK+ toolkit and X drag-and-drop. +Jan Djärv added support for the GTK+ toolkit and X drag-and-drop. He also wrote @file{dynamic-setting.el}. @item @@ -268,7 +268,7 @@ Carsten Dominik wrote Ref@TeX{}, a package for setting up labels and cross-references in @LaTeX{} documents; and co-wrote IDLWAVE mode (q.v.). He was the original author of Org mode, for maintaining notes, todo lists, and project planning. Bastien Guerry subsequently took -over maintainership. Benjamin Andresen, Thomas Baumann, Joel Boehland, Jan Böcker, Lennart +over maintainership. Benjamin Andresen, Thomas Baumann, Joel Boehland, Jan Böcker, Lennart Borgman, Baoqiu Cui, Dan Davison, Christian Egli, Eric S. Fraga, Daniel German, Chris Gray, Konrad Hinsen, Tassilo Horn, Philip Jackson, Martyn Jago, Thorsten Jolitz, Jambunathan K, Tokuya Kameshima, Sergey Litvinov, David Maus, Ross Patterson, Juan Pechiar, Sebastian Rose, Eric Schulte, Paul Sexton, Ulf Stegemann, Andy Stewart, Christopher Suckling, David O'Toole, John Wiegley, Zhang Weize, @@ -303,7 +303,7 @@ folders have mail waiting in them; and @file{iswitchb.el}, a feature for incremental reading and completion of buffer names. @item -Torbjörn Einarsson wrote @file{f90.el}, a mode for Fortran 90 files. +Torbjörn Einarsson wrote @file{f90.el}, a mode for Fortran 90 files. @item Tsugutomo Enami co-wrote the support for international character sets. @@ -365,7 +365,7 @@ Kevin Gallagher rewrote and enhanced the EDT emulation, and wrote flow control. @item -Fabián E. Gallina rewrote @file{python.el}, the major mode for the +Fabián E. Gallina rewrote @file{python.el}, the major mode for the Python programming language used in Emacs 24.3 onwards. @item @@ -373,7 +373,7 @@ Kevin Gallo added multiple-frame support for Windows NT and wrote @file{w32-win.el}, support functions for the MS-Windows window system. @item -Juan León Lahoz García wrote @file{wdired.el}, a package for +Juan León Lahoz GarcÃa wrote @file{wdired.el}, a package for performing file operations by directly editing Dired buffers. @item @@ -510,9 +510,9 @@ He also wrote @file{network-stream.el}, for opening network processes; @file{url-queue.el}, for controlling parallel downloads of URLs; and implemented libxml2 support. Components of Gnus have also been written by: Nagy Andras, David -Blacka, Scott Byer, Ludovic Courtès, Julien Danjou, Kevin Greiner, Kai -Großjohann, Joe Hildebrand, Paul Jarc, Simon Josefsson, Sascha -Lüdecke, David Moore, Jim Radford, Benjamin Rutt, Raymond Scholz, +Blacka, Scott Byer, Ludovic Courtès, Julien Danjou, Kevin Greiner, Kai +Großjohann, Joe Hildebrand, Paul Jarc, Simon Josefsson, Sascha +Lüdecke, David Moore, Jim Radford, Benjamin Rutt, Raymond Scholz, Thomas Steffen, Reiner Steib, Didier Verna, Ilja Weis, Katsumi Yamaoka, Teodor Zlatanov, and others (@pxref{Contributors,,,gnus, the Gnus Manual}). @@ -553,7 +553,7 @@ S/MIME and Sieve components; and @file{tls.el} and @file{starttls.el} for the Transport Layer Security protocol. @item -Arne Jørgensen wrote @file{latexenc.el}, a package to +Arne Jørgensen wrote @file{latexenc.el}, a package to automatically guess the correct coding system in @LaTeX{} files. @item @@ -605,7 +605,7 @@ files and running a PostScript interpreter interactively from within Emacs. @item -Karel Klí@v{c} contributed SELinux support, for preserving the +Karel KlÃÄ contributed SELinux support, for preserving the Security-Enhanced Linux context of files on backup and copy. @item @@ -635,7 +635,7 @@ R. Dodd. He also wrote @file{ls-lisp.el}, a Lisp emulation of the program. @item -David K@ringaccent{a}gedal wrote @file{tempo.el}, providing support for +David KÃ¥gedal wrote @file{tempo.el}, providing support for easy insertion of boilerplate text and other common constructions. @item @@ -694,7 +694,7 @@ directory-local variables; and the @code{info-finder} feature that creates a virtual Info manual of package keywords. @item -Károly L@H{o}rentey wrote the ``multi-terminal'' code, which allows +Károly LÅ‘rentey wrote the ``multi-terminal'' code, which allows Emacs to run on graphical and text terminals simultaneously. @item @@ -811,9 +811,8 @@ Richard Mlynarik wrote @file{cl-indent.el}, a package for indenting Common Lisp code; @file{ebuff-menu.el}, an ``electric'' browser for buffer listings; @file{ehelp.el}, bindings for browsing help screens; @file{rfc822.el}, a parser for E-mail addresses in the RFC-822 format, -used in mail messages and news articles; @file{terminal.el}, a -terminal emulator for Emacs subprocesses; and @file{yow.el}, an -essential utility. +used in mail messages and news articles; and @file{terminal.el}, a +terminal emulator for Emacs subprocesses. @item Gerd Moellmann was the Emacs maintainer from the beginning of Emacs 21 @@ -961,7 +960,7 @@ Fred Pierresteguy and Paul Reilly made Emacs work with X Toolkit widgets. @item -François Pinard, Greg McGary, and Bruno Haible wrote @file{po.el}, +François Pinard, Greg McGary, and Bruno Haible wrote @file{po.el}, support for PO translation files. @item @@ -1225,7 +1224,7 @@ Olaf Sylvester wrote @file{bs.el}, a package for manipulating Emacs buffers. @item -Tibor @v{S}imko and Milan Zamazal wrote @file{slovak.el}, support for +Tibor Å imko and Milan Zamazal wrote @file{slovak.el}, support for editing text in Slovak language. @item @@ -1346,7 +1345,7 @@ mode for editing VHDL source code. John Wiegley wrote @file{align.el}, a set of commands for aligning text according to regular-expression based rules; @file{isearchb.el} for fast buffer switching; @file{timeclock.el}, a package for keeping track of -time spent on projects; the Bahá'í calendar support; +time spent on projects; the Bahá'à calendar support; @file{pcomplete.el}, a programmable completion facility; @file{remember.el}, a mode for jotting down things to remember; @file{eudcb-mab.el}, an address book backend for the Emacs Unified diff --git a/doc/emacs/cal-xtra.texi b/doc/emacs/cal-xtra.texi index 023e4a2926c..1b182327d33 100644 --- a/doc/emacs/cal-xtra.texi +++ b/doc/emacs/cal-xtra.texi @@ -1,4 +1,4 @@ -@c This is part of the Emacs manual. -*- coding: iso-latin-1 -*- +@c This is part of the Emacs manual. -*- coding: utf-8 -*- @c Copyright (C) 2004-2013 Free Software Foundation, Inc. @c See file emacs.texi for copying conditions. @c @@ -203,7 +203,7 @@ the month (1 specifies the first occurrence, 2 the second occurrence, @minus{}1 the last occurrence, @minus{}2 the second-to-last occurrence, and so on). - You can specify holidays that occur on fixed days of the Bahá'í, + You can specify holidays that occur on fixed days of the Bahá'Ã, Chinese, Hebrew, Islamic, and Julian calendars too. For example, @smallexample @@ -420,7 +420,7 @@ the fourth pattern. @subsection Diary Entries Using non-Gregorian Calendars As well as entries based on the standard Gregorian calendar, your -diary can have entries based on Bahá'í, Hebrew, or Islamic dates. +diary can have entries based on Bahá'Ã, Hebrew, or Islamic dates. Recognition of such entries can be time-consuming, however, and since most people don't use them, you must explicitly enable their use. If you want the diary to recognize Hebrew-date diary entries, for example, @@ -440,7 +440,7 @@ you must do this: @end smallexample @noindent -Similarly, for Islamic and Bahá'í entries, add +Similarly, for Islamic and Bahá'à entries, add @code{diary-islamic-list-entries} and @code{diary-islamic-mark-entries}, or @code{diary-bahai-list-entries} and @code{diary-bahai-mark-entries}. @@ -449,7 +449,7 @@ Similarly, for Islamic and Bahá'í entries, add @vindex diary-islamic-entry-symbol These diary entries have the same formats as Gregorian-date diary entries; except that @code{diary-bahai-entry-symbol} (default @samp{B}) -must precede a Bahá'í date, @code{diary-hebrew-entry-symbol} (default +must precede a Bahá'à date, @code{diary-hebrew-entry-symbol} (default @samp{H}) a Hebrew date, and @code{diary-islamic-entry-symbol} (default @samp{I}) an Islamic date. Moreover, non-Gregorian month names may not be abbreviated (because the first three letters are often not unique). @@ -476,7 +476,7 @@ nonmarking if preceded by @code{diary-nonmarking-symbol} (default Here is a table of commands used in the calendar to create diary entries that match the selected date and other dates that are similar in -the Bahá'í, Hebrew, or Islamic calendars: +the Bahá'Ã, Hebrew, or Islamic calendars: @table @kbd @item i h d @@ -851,7 +851,7 @@ Make a diary entry with today's equivalent Julian calendar date. @item %%(diary-astro-day-number) Make a diary entry with today's equivalent astronomical (Julian) day number. @item %%(diary-bahai-date) -Make a diary entry with today's equivalent Bahá'í calendar date. +Make a diary entry with today's equivalent Bahá'à calendar date. @item %%(diary-chinese-date) Make a diary entry with today's equivalent Chinese calendar date. @item %%(diary-coptic-date) diff --git a/doc/emacs/calendar.texi b/doc/emacs/calendar.texi index 4f4ec036ef9..52b966b76e1 100644 --- a/doc/emacs/calendar.texi +++ b/doc/emacs/calendar.texi @@ -1,4 +1,4 @@ -@c This is part of the Emacs manual. -*- coding: iso-latin-1 -*- +@c This is part of the Emacs manual. -*- coding: utf-8 -*- @c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2013 Free Software @c Foundation, Inc. @c See file emacs.texi for copying conditions. @@ -522,7 +522,7 @@ holidays centered around a different month, use @kbd{C-u M-x holidays}, which prompts for the month and year. The holidays known to Emacs include United States holidays and the -major Bahá'í, Chinese, Christian, Islamic, and Jewish holidays; also the +major Bahá'Ã, Chinese, Christian, Islamic, and Jewish holidays; also the solstices and equinoxes. @findex list-holidays @@ -760,8 +760,8 @@ days are named by combining one of ten ``celestial stems'' with one of twelve ``terrestrial branches'' for a total of sixty names that are repeated in a cycle of sixty. -@cindex Bahá'í calendar - The Bahá'í calendar system is based on a solar cycle of 19 months with +@cindex Bahá'à calendar + The Bahá'à calendar system is based on a solar cycle of 19 months with 19 days each. The four remaining ``intercalary'' days are placed between the 18th and 19th months. @@ -801,7 +801,7 @@ Display French Revolutionary date for selected day (@code{calendar-french-print-date}). @findex calendar-bahai-print-date @item p b -Display Bahá'í date for selected day +Display Bahá'à date for selected day (@code{calendar-bahai-print-date}). @findex calendar-chinese-print-date @item p C @@ -869,7 +869,7 @@ Move to a date specified in the Julian calendar Move to a date specified with an astronomical (Julian) day number (@code{calendar-astro-goto-day-number}). @item g b -Move to a date specified in the Bahá'í calendar +Move to a date specified in the Bahá'à calendar (@code{calendar-bahai-goto-date}). @item g h Move to a date specified in the Hebrew calendar diff --git a/doc/emacs/cmdargs.texi b/doc/emacs/cmdargs.texi index c4a74042865..19b439afc7f 100644 --- a/doc/emacs/cmdargs.texi +++ b/doc/emacs/cmdargs.texi @@ -567,10 +567,9 @@ terminal specified by @env{TERM}. This defaults to These environment variables are used to initialize the variable @code{temporary-file-directory}, which specifies a directory in which to put temporary files (@pxref{Backup}). Emacs tries to use -@env{TMPDIR} first; if that is unset, it tries @env{TMP}, then -@env{TEMP}, and finally @file{/tmp}. But on MS-Windows and MS-DOS, -Emacs tries @env{TEMP}, then @env{TMPDIR}, then @env{TMP}, and finally -@file{c:/temp}. +@env{TMPDIR} first. If that is unset, Emacs normally falls back on +@file{/tmp}, but on MS-Windows and MS-DOS it instead falls back on +@env{TMP}, then @env{TEMP}, and finally @file{c:/temp}. @item TZ This specifies the current time zone and possibly also daylight diff --git a/doc/emacs/doclicense.texi b/doc/emacs/doclicense.texi index 51342e96d60..9c3bbe56e91 100644 --- a/doc/emacs/doclicense.texi +++ b/doc/emacs/doclicense.texi @@ -1,4 +1,3 @@ -@c -*-texinfo-*- @c The GNU Free Documentation License. @center Version 1.3, 3 November 2008 @@ -6,7 +5,7 @@ @c hence no sectioning command or @node. @display -Copyright @copyright{} 2000, 2001, 2002, 2007, 2008, 2009 Free Software Foundation, Inc. +Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. @uref{http://fsf.org/} Everyone is permitted to copy and distribute verbatim copies @@ -93,16 +92,16 @@ An image format is not Transparent if used for any substantial amount of text. A copy that is not ``Transparent'' is called ``Opaque''. Examples of suitable formats for Transparent copies include plain -@sc{ascii} without markup, Texinfo input format, La@TeX{} input -format, @acronym{SGML} or @acronym{XML} using a publicly available -@acronym{DTD}, and standard-conforming simple @acronym{HTML}, -PostScript or @acronym{PDF} designed for human modification. Examples -of transparent image formats include @acronym{PNG}, @acronym{XCF} and -@acronym{JPG}. Opaque formats include proprietary formats that can be -read and edited only by proprietary word processors, @acronym{SGML} or -@acronym{XML} for which the @acronym{DTD} and/or processing tools are -not generally available, and the machine-generated @acronym{HTML}, -PostScript or @acronym{PDF} produced by some word processors for +ASCII without markup, Texinfo input format, La@TeX{} input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG@. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for output purposes only. The ``Title Page'' means, for a printed book, the title page itself, @@ -482,7 +481,7 @@ license notices just after the title page: @end smallexample If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the ``with@dots{}Texts.'' line with this: +replace the ``with@dots{}Texts.''@: line with this: @smallexample @group @@ -501,8 +500,6 @@ recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software. - @c Local Variables: @c ispell-local-pdict: "ispell-dict" @c End: - diff --git a/doc/emacs/emacs-xtra.texi b/doc/emacs/emacs-xtra.texi index 40519e7e318..f67ed3d5cad 100644 --- a/doc/emacs/emacs-xtra.texi +++ b/doc/emacs/emacs-xtra.texi @@ -26,7 +26,7 @@ modify this GNU manual.'' @end quotation @end copying -@documentencoding ISO-8859-1 +@documentencoding UTF-8 @dircategory Emacs @direntry diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index 972304ac575..d2ec2154024 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi @@ -1,4 +1,4 @@ -\input texinfo @c -*- coding: iso-latin-1 -*- +\input texinfo @c -*- coding: utf-8 -*- @setfilename ../../info/emacs @settitle GNU Emacs Manual @@ -44,7 +44,7 @@ developing GNU and promoting software freedom.'' @end quotation @end copying -@documentencoding ISO-8859-1 +@documentencoding UTF-8 @dircategory Emacs @direntry @@ -1362,35 +1362,35 @@ USA Contributors to GNU Emacs include Jari Aalto, Per Abrahamsen, Tomas Abrahamsson, Jay K. Adams, Alon Albert, Michael Albinus, Nagy -Andras, Benjamin Andresen, Ralf Angeli, Dmitry Antipov, Joe Arceneaux, Emil Åström, +Andras, Benjamin Andresen, Ralf Angeli, Dmitry Antipov, Joe Arceneaux, Emil Ã…ström, Miles Bader, David Bakhash, Juanma Barranquero, Eli Barzilay, Thomas Baumann, Steven L. Baur, Jay Belanger, Alexander L. Belikoff, Thomas Bellman, Scott Bender, Boaz Ben-Zvi, Sergey Berezin, Karl Berry, Anna M. Bigatti, Ray Blaak, Martin Blais, Jim Blandy, Johan -Bockgård, Jan Böcker, Joel Boehland, Lennart Borgman, Per Bothner, +BockgÃ¥rd, Jan Böcker, Joel Boehland, Lennart Borgman, Per Bothner, Terrence Brannon, Frank Bresz, Peter Breton, Emmanuel Briot, Kevin Broadey, Vincent Broman, Michael Brouwer, David M. Brown, Stefan Bruda, -Georges Brun-Cottan, Joe Buehler, Scott Byer, W@l{}odek Bzyl, +Georges Brun-Cottan, Joe Buehler, Scott Byer, WÅ‚odek Bzyl, Bill Carpenter, Per Cederqvist, Hans Chalupsky, Chris Chase, Bob Chassell, Andrew Choi, Chong Yidong, Sacha Chua, Stewart Clamen, James Clark, Mike Clarkson, Glynn Clements, Andrew Cohen, Daniel Colascione, -Edward O'Connor, Christoph Conrad, Ludovic Courtès, Andrew Csillag, +Christoph Conrad, Ludovic Courtès, Andrew Csillag, Toby Cubitt, Baoqiu Cui, Doug Cutting, Mathias Dahl, Julien Danjou, Satyaki Das, Vivek Dasmohapatra, Dan Davison, Michael DeCorte, Gary Delp, Nachum Dershowitz, Dave Detlefs, Matthieu Devin, Christophe de Dinechin, Eri -Ding, Jan Djärv, Lawrence R. Dodd, Carsten Dominik, Scott Draves, +Ding, Jan Djärv, Lawrence R. Dodd, Carsten Dominik, Scott Draves, Benjamin Drieu, Viktor Dukhovni, Jacques Duthen, Dmitry Dzhus, John Eaton, Rolf Ebert, Carl Edman, David Edmondson, Paul Eggert, Stephen -Eglen, Christian Egli, Torbjörn Einarsson, Tsugutomo Enami, David +Eglen, Christian Egli, Torbjörn Einarsson, Tsugutomo Enami, David Engster, Hans Henrik Eriksen, Michael Ernst, Ata Etemadi, Frederick Farnbach, Oscar Figueiredo, Fred Fish, Steve Fisk, Karl Fogel, Gary Foster, Eric S. Fraga, Romain Francoise, Noah Friedman, Andreas Fuchs, Shigeru Fukaya, Hallvard Furuseth, Keith Gabryelski, Peter S. -Galbraith, Kevin Gallagher, Fabián E. Gallina, Kevin Gallo, Juan León Lahoz García, +Galbraith, Kevin Gallagher, Fabián E. Gallina, Kevin Gallo, Juan León Lahoz GarcÃa, Howard Gayle, Daniel German, Stephen Gildea, Julien Gilles, David Gillespie, Bob Glickstein, Deepak Goel, David De La Harpe Golden, Boris Goldowsky, David Goodger, Chris Gray, Kevin Greiner, Michelangelo Grigni, Odd -Gripenstam, Kai Großjohann, Michael Gschwind, Bastien Guerry, Henry +Gripenstam, Kai Großjohann, Michael Gschwind, Bastien Guerry, Henry Guillaume, Doug Gwyn, Bruno Haible, Ken'ichi Handa, Lars Hansen, Chris Hanson, Jesper Harder, Alexandru Harsanyi, K. Shane Hartman, John Heidemann, Jon K. Hellan, Magnus Henoch, Markus Heritsch, Dirk @@ -1399,19 +1399,19 @@ Jeffrey C. Honig, Tassilo Horn, Kurt Hornik, Tom Houlder, Joakim Hove, Denis Howe, Lars Ingebrigtsen, Andrew Innes, Seiichiro Inoue, Philip Jackson, Martyn Jago, Pavel Janik, Paul Jarc, Ulf Jasper, Thorsten Jolitz, Michael K. Johnson, Kyle Jones, Terry Jones, Simon -Josefsson, Alexandre Julliard, Arne Jørgensen, Tomoji Kagatani, +Josefsson, Alexandre Julliard, Arne Jørgensen, Tomoji Kagatani, Brewster Kahle, Tokuya Kameshima, Lute Kamstra, Ivan Kanis, David Kastrup, David Kaufman, Henry Kautz, Taichi Kawabata, Taro Kawagishi, Howard Kaye, Michael Kifer, Richard King, Peter Kleiweg, Karel -Klí@v{c}, Shuhei Kobayashi, Pavel Kobyakov, Larry K. Kolodney, David +KlÃÄ, Shuhei Kobayashi, Pavel Kobyakov, Larry K. Kolodney, David M. Koppelman, Koseki Yoshinori, Robert Krawitz, Sebastian Kremer, -Ryszard Kubiak, Igor Kuzmin, David Kågedal, Daniel LaLiberte, Karl +Ryszard Kubiak, Igor Kuzmin, David KÃ¥gedal, Daniel LaLiberte, Karl Landstrom, Mario Lang, Aaron Larson, James R. Larus, Vinicius Jose Latorre, Werner Lemberg, Frederic Lepied, Peter Liljenberg, Christian Limpach, Lars Lindberg, Chris Lindblad, Anders Lindgren, Thomas Link, Juri Linkov, Francis Litterio, Sergey Litvinov, Emilio C. Lopes, -Martin Lorentzon, Dave Love, Eric Ludlam, Károly L@H{o}rentey, Sascha -Lüdecke, Greg McGary, Roland McGrath, Michael McNamara, Alan Mackenzie, +Martin Lorentzon, Dave Love, Eric Ludlam, Károly LÅ‘rentey, Sascha +Lüdecke, Greg McGary, Roland McGrath, Michael McNamara, Alan Mackenzie, Christopher J. Madsen, Neil M. Mager, Ken Manheimer, Bill Mann, Brian Marick, Simon Marshall, Bengt Martensson, Charlie Martin, Yukihiro Matsumoto, Tomohiro Matsuyama, David Maus, Thomas May, Will Mengarini, David @@ -1421,12 +1421,12 @@ Monnier, Keith Moore, Jan Moringen, Morioka Tomohiko, Glenn Morris, Don Morrison, Diane Murray, Riccardo Murri, Sen Nagata, Erik Naggum, Gergely Nagy, Nobuyoshi Nakada, Thomas Neumann, Mike Newton, Thien-Thi Nguyen, Jurgen Nickelsen, Dan Nicolaescu, Hrvoje Niksic, Jeff Norden, -Andrew Norman, Kentaro Ohkouchi, Christian Ohler, +Andrew Norman, Edward O'Connor, Kentaro Ohkouchi, Christian Ohler, Kenichi Okada, Alexandre Oliva, Bob Olson, Michael Olson, Takaaki Ota, Pieter E. J. Pareit, Ross Patterson, David Pearson, Juan Pechiar, Jeff Peck, Damon Anton Permezel, Tom Perrine, William M. Perry, Per Persson, Jens Petersen, Daniel Pfeiffer, Justus Piater, Richard L. -Pieri, Fred Pierresteguy, François Pinard, Daniel Pittman, Christian +Pieri, Fred Pierresteguy, François Pinard, Daniel Pittman, Christian Plaunt, Alexander Pohoyda, David Ponce, Francesco A. Potorti, Michael D. Prange, Mukesh Prasad, Ken Raeburn, Marko Rahamaa, Ashwin Ram, Eric S. Raymond, Paul Reilly, Edward M. Reingold, David @@ -1441,7 +1441,7 @@ Philippe Schnoebelen, Jan Schormann, Alex Schroeder, Stefan Schoef, Rainer Schoepf, Raymond Scholz, Eric Schulte, Andreas Schwab, Randal Schwartz, Oliver Seidel, Manuel Serrano, Paul Sexton, Hovav Shacham, Stanislav Shalunov, Marc Shapiro, Richard Sharman, Olin Shivers, Tibor -@v{S}imko, Espen Skoglund, Rick Sladkey, Lynn Slater, Chris Smith, +Å imko, Espen Skoglund, Rick Sladkey, Lynn Slater, Chris Smith, David Smith, Paul D. Smith, Wilson Snyder, William Sommerfeld, Simon South, Andre Spiegel, Michael Staats, Thomas Steffen, Ulf Stegemann, Reiner Steib, Sam Steingold, Ake Stenhoff, Peter Stephenson, Ken diff --git a/doc/emacs/emacsver.texi b/doc/emacs/emacsver.texi index ec0b4940059..408d6612d58 100644 --- a/doc/emacs/emacsver.texi +++ b/doc/emacs/emacsver.texi @@ -1,4 +1,4 @@ @c It would be nicer to generate this using configure and @version@. @c However, that would mean emacsver.texi would always be newer @c then the info files in release tarfiles. -@set EMACSVER 24.3 +@set EMACSVER 24.3.50 diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi index a85c16ee1bc..1f78747eaa6 100644 --- a/doc/emacs/files.texi +++ b/doc/emacs/files.texi @@ -734,10 +734,10 @@ file. @cindex locking files When you make the first modification in an Emacs buffer that is visiting a file, Emacs records that the file is @dfn{locked} by you. -(It does this by creating a specially-named symbolic link in the same -directory.) Emacs removes the lock when you save the changes. The -idea is that the file is locked whenever an Emacs buffer visiting it -has unsaved changes. +(It does this by creating a specially-named symbolic link or regular +file with special contents in the same directory.) Emacs removes the +lock when you save the changes. The idea is that the file is locked +whenever an Emacs buffer visiting it has unsaved changes. @vindex create-lockfiles You can prevent the creation of lock files by setting the variable @@ -774,14 +774,14 @@ multiple names, Emacs does not prevent two users from editing it simultaneously under different names. A lock file cannot be written in some circumstances, e.g., if Emacs -lacks the system permissions or the system does not support symbolic -links. In these cases, Emacs can still detect the collision when you -try to save a file, by checking the file's last-modification date. If -the file has changed since the last time Emacs visited or saved it, -that implies that changes have been made in some other way, and will -be lost if Emacs proceeds with saving. Emacs then displays a warning -message and asks for confirmation before saving; answer @kbd{yes} to -save, and @kbd{no} or @kbd{C-g} cancel the save. +lacks the system permissions or cannot create lock files for some +other reason. In these cases, Emacs can still detect the collision +when you try to save a file, by checking the file's last-modification +date. If the file has changed since the last time Emacs visited or +saved it, that implies that changes have been made in some other way, +and will be lost if Emacs proceeds with saving. Emacs then displays a +warning message and asks for confirmation before saving; answer +@kbd{yes} to save, and @kbd{no} or @kbd{C-g} cancel the save. If you are notified that simultaneous editing has already taken place, one way to compare the buffer to its file is the @kbd{M-x @@ -1937,8 +1937,7 @@ or taller than the frame, the usual point motion keys (@kbd{C-f}, displayed. If the image can be animated, the command @kbd{RET} (@code{image-toggle-animation}) starts or stops the animation. Animation plays once, unless the option @code{image-animate-loop} is -non-@code{nil}. Currently, Emacs only supports animation in GIF -files. +non-@code{nil}. @cindex ImageMagick support @vindex imagemagick-enabled-types diff --git a/doc/emacs/gpl.texi b/doc/emacs/gpl.texi index 1908d1f8f98..0e2e212acb1 100644 --- a/doc/emacs/gpl.texi +++ b/doc/emacs/gpl.texi @@ -2,7 +2,7 @@ @center Version 3, 29 June 2007 @c This file is intended to be included within another document, -@c hence no sectioning command or @node. +@c hence no sectioning command or @node. @display Copyright @copyright{} 2007 Free Software Foundation, Inc. @url{http://fsf.org/} @@ -222,7 +222,7 @@ terms of section 4, provided that you also meet all of these conditions: @enumerate a -@item +@item The work must carry prominent notices stating that you modified it, and giving a relevant date. @@ -623,12 +623,12 @@ later version. @item Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +APPLICABLE LAW@. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND -PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +A PARTICULAR PURPOSE@. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU@. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. @@ -670,7 +670,7 @@ state the exclusion of warranty; and each file should have at least the ``copyright'' line and a pointer to where the full notice is found. @smallexample -@var{one line to give the program's name and a brief idea of what it does.} +@var{one line to give the program's name and a brief idea of what it does.} Copyright (C) @var{year} @var{name of author} This program is free software: you can redistribute it and/or modify @@ -680,7 +680,7 @@ your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License @@ -693,7 +693,7 @@ If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: @smallexample -@var{program} Copyright (C) @var{year} @var{name of author} +@var{program} Copyright (C) @var{year} @var{name of author} This program comes with ABSOLUTELY NO WARRANTY; for details type @samp{show w}. This is free software, and you are welcome to redistribute it under certain conditions; type @samp{show c} for details. diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index 0a0a3865d2d..75b250d0f40 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi @@ -295,11 +295,16 @@ search for noninteractive functions too. Search for functions and variables. Both interactive functions (commands) and noninteractive functions can be found by this. -@item M-x apropos-variable -@findex apropos-variable +@item M-x apropos-user-option +@findex apropos-user-option Search for user-customizable variables. With a prefix argument, search for non-customizable variables too. +@item M-x apropos-variable +@findex apropos-variable +Search for variables. With a prefix argument, search for +customizable variables only. + @item M-x apropos-value @findex apropos-value Search for variables whose values match the specified pattern. With a diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi index acf1a87fc4c..c8d9e9f2087 100644 --- a/doc/emacs/maintaining.texi +++ b/doc/emacs/maintaining.texi @@ -1676,9 +1676,11 @@ specifies (using Bourne shell syntax) that the commands @item In Lisp code, any function defined with @code{defun}, any variable -defined with @code{defvar} or @code{defconst}, and in general the first -argument of any expression that starts with @samp{(def} in column zero is -a tag. +defined with @code{defvar} or @code{defconst}, and in general the +first argument of any expression that starts with @samp{(def} in +column zero is a tag. As an exception, expressions of the form +@code{(defvar @var{foo})} are treated as declarations, and are only +tagged if the @samp{--declarations} option is given. @item In Scheme code, tags include anything defined with @code{def} or with a @@ -1766,11 +1768,11 @@ the file. @item In Perl code, the tags are the packages, subroutines and variables -defined by the @code{package}, @code{sub}, @code{my} and @code{local} -keywords. Use @samp{--globals} if you want to tag global variables. -Tags for subroutines are named @samp{@var{package}::@var{sub}}. The -name for subroutines defined in the default package is -@samp{main::@var{sub}}. +defined by the @code{package}, @code{sub}, @code{use constant}, +@code{my}, and @code{local} keywords. Use @samp{--globals} if you +want to tag global variables. Tags for subroutines are named +@samp{@var{package}::@var{sub}}. The name for subroutines defined in +the default package is @samp{main::@var{sub}}. @item In PHP code, tags are functions, classes and defines. Vars are tags diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index 261676a7c54..73c1c85e2f8 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi @@ -2180,7 +2180,7 @@ commands to perform arbitrary editing while in the middle of another Emacs command. For example, when you type @kbd{C-r} inside of a @code{query-replace}, you enter a recursive edit in which you can change the current buffer. On exiting from the recursive edit, you go back to -the @code{query-replace}. +the @code{query-replace}. @xref{Query Replace}. @kindex C-M-c @findex exit-recursive-edit diff --git a/doc/emacs/msdog.texi b/doc/emacs/msdog.texi index 2c22c89a113..0f01958b51c 100644 --- a/doc/emacs/msdog.texi +++ b/doc/emacs/msdog.texi @@ -218,29 +218,6 @@ set conversion, only end-of-line conversion. Essentially, it directs Emacs to create new files with the Unix-style convention of using newline at the end of a line. @xref{Coding Systems}. -@vindex file-name-buffer-file-type-alist -@cindex binary files, on MS-DOS/MS-Windows - Some kinds of files should not be converted at all, because their -contents are not really text. Therefore, Emacs on MS-Windows distinguishes -certain files as @dfn{binary files}. (This distinction is not part of -MS-Windows; it is made by Emacs only.) Binary files include executable -programs, compressed archives, etc. Emacs uses the file name to decide -whether to treat a file as binary: the variable -@code{file-name-buffer-file-type-alist} defines the file-name patterns -that indicate binary files. If a file name matches one of the patterns -for binary files (those whose associations are of the type -@code{(@var{pattern} . t)}, Emacs reads and writes that file using the -@code{no-conversion} coding system (@pxref{Coding Systems}) which turns -off @emph{all} coding-system conversions, not only the EOL conversion. -@code{file-name-buffer-file-type-alist} also includes file-name patterns -for files which are known to be Windows-style text files with -carriage-return linefeed EOL format, such as @file{CONFIG.SYS}; Emacs -always writes those files with Windows-style EOLs. - - If a file that belongs to an untranslated file system matches one of -the file-name patterns in @code{file-name-buffer-file-type-alist}, the -EOL conversion is determined by @code{file-name-buffer-file-type-alist}. - @node Windows Files @section File Names on MS-Windows @cindex file names on MS-Windows diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi index e83fe769ae9..1c667bc56cb 100644 --- a/doc/emacs/trouble.texi +++ b/doc/emacs/trouble.texi @@ -282,18 +282,23 @@ itself, and the reserve supply may not be enough. @subsection When Emacs Crashes @cindex crash report +@cindex backtrace +@cindex @file{emacs_backtrace.txt} file, MS-Windows Emacs is not supposed to crash, but if it does, it produces a @dfn{crash report} prior to exiting. The crash report is printed to the standard error stream. If Emacs was started from a graphical -desktop, the standard error stream is commonly redirected to a file -such as @file{~/.xsession-errors}, so you can look for the crash -report there. +desktop on a GNU or Unix system, the standard error stream is commonly +redirected to a file such as @file{~/.xsession-errors}, so you can +look for the crash report there. On MS-Windows, the crash report is +written to a file named @file{emacs_backtrace.txt} in the current +directory of the Emacs process, in addition to the standard error +stream. The format of the crash report depends on the platform. On some platforms, such as those using the GNU C Library, the crash report includes a @dfn{backtrace} describing the execution state prior to crashing, which can be used to help debug the crash. Here is an -example: +example for a GNU system: @example Fatal error 11: Segmentation fault @@ -320,23 +325,26 @@ backtrace with source-code line numbers: @example sed -n 's/.*\[\(.*\)]$/\1/p' @var{backtrace} | - addr2line -C -f -i -e @var{bindir}/emacs + addr2line -C -f -i -p -e @var{bindir}/@var{emacs-binary} @end example @noindent Here, @var{backtrace} is the name of a text file containing a copy of -the backtrace, and @var{bindir} is the name of the directory that -contains the Emacs executable.@footnote{You may wish to add the -@option{-p} option, if your version of @command{addr2line} supports it.} +the backtrace, @var{bindir} is the name of the directory that +contains the Emacs executable, and @var{emacs-binary} is the name of +the Emacs executable file, normally @file{emacs} on GNU and Unix +systems and @file{emacs.exe} on MS-Windows and MS-DOS. Omit the +@option{-p} option if your version of @command{addr2line} is too old +to have it. @cindex core dump - Optionally, Emacs can generate a @dfn{core dump} when it crashes. A -core dump is a file containing voluminous data about the state of the -program prior to the crash, usually examined by loading it into a -debugger such as GDB@. On many platforms, core dumps are disabled by -default, and you must explicitly enable them by running the shell -command @samp{ulimit -c unlimited} (e.g., in your shell startup -script). + Optionally, Emacs can generate a @dfn{core dump} when it crashes, on +systems that support core files. A core dump is a file containing +voluminous data about the state of the program prior to the crash, +usually examined by loading it into a debugger such as GDB@. On many +platforms, core dumps are disabled by default, and you must explicitly +enable them by running the shell command @samp{ulimit -c unlimited} +(e.g., in your shell startup script). @node After a Crash @subsection Recovery After a Crash diff --git a/doc/lispintro/ChangeLog b/doc/lispintro/ChangeLog index 4dd7c0e00a5..93084e76203 100644 --- a/doc/lispintro/ChangeLog +++ b/doc/lispintro/ChangeLog @@ -1,11 +1,7 @@ -2013-03-12 Glenn Morris <rgm@gnu.org> +2013-03-16 Glenn Morris <rgm@gnu.org> * emacs-lisp-intro.texi: Add some stuff specific to www.gnu.org. -2013-03-11 Glenn Morris <rgm@gnu.org> - - * Version 24.3 released. - 2013-03-03 Glenn Morris <rgm@gnu.org> * emacs-lisp-intro.texi (Digression into C): Update example. @@ -18,6 +14,23 @@ (emacs-lisp-intro.pdf, emacs-lisp-intro.html): Use $srcs for dependencies. +2012-12-14 Paul Eggert <eggert@cs.ucla.edu> + + Fix permissions bugs with setgid directories etc. (Bug#13125) + * emacs-lisp-intro.texi (Files List): + directory-files-and-attributes now outputs t for attribute that's + now a placeholder. + +2012-12-06 Paul Eggert <eggert@cs.ucla.edu> + + * doclicense.texi: Update to latest version from FSF. + These are just minor editorial changes. + +2012-11-24 Paul Eggert <eggert@cs.ucla.edu> + + * doclicense.texi: Update to latest version from FSF. + These are just minor editorial changes. + 2012-10-24 Paul Eggert <eggert@penguin.cs.ucla.edu> * emacs-lisp-intro.texi (Files List): diff --git a/doc/lispintro/doclicense.texi b/doc/lispintro/doclicense.texi index 51342e96d60..9c3bbe56e91 100644 --- a/doc/lispintro/doclicense.texi +++ b/doc/lispintro/doclicense.texi @@ -1,4 +1,3 @@ -@c -*-texinfo-*- @c The GNU Free Documentation License. @center Version 1.3, 3 November 2008 @@ -6,7 +5,7 @@ @c hence no sectioning command or @node. @display -Copyright @copyright{} 2000, 2001, 2002, 2007, 2008, 2009 Free Software Foundation, Inc. +Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. @uref{http://fsf.org/} Everyone is permitted to copy and distribute verbatim copies @@ -93,16 +92,16 @@ An image format is not Transparent if used for any substantial amount of text. A copy that is not ``Transparent'' is called ``Opaque''. Examples of suitable formats for Transparent copies include plain -@sc{ascii} without markup, Texinfo input format, La@TeX{} input -format, @acronym{SGML} or @acronym{XML} using a publicly available -@acronym{DTD}, and standard-conforming simple @acronym{HTML}, -PostScript or @acronym{PDF} designed for human modification. Examples -of transparent image formats include @acronym{PNG}, @acronym{XCF} and -@acronym{JPG}. Opaque formats include proprietary formats that can be -read and edited only by proprietary word processors, @acronym{SGML} or -@acronym{XML} for which the @acronym{DTD} and/or processing tools are -not generally available, and the machine-generated @acronym{HTML}, -PostScript or @acronym{PDF} produced by some word processors for +ASCII without markup, Texinfo input format, La@TeX{} input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG@. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for output purposes only. The ``Title Page'' means, for a printed book, the title page itself, @@ -482,7 +481,7 @@ license notices just after the title page: @end smallexample If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the ``with@dots{}Texts.'' line with this: +replace the ``with@dots{}Texts.''@: line with this: @smallexample @group @@ -501,8 +500,6 @@ recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software. - @c Local Variables: @c ispell-local-pdict: "ispell-dict" @c End: - diff --git a/doc/lispintro/emacs-lisp-intro.texi b/doc/lispintro/emacs-lisp-intro.texi index 13e12b52785..c42ed210cbc 100644 --- a/doc/lispintro/emacs-lisp-intro.texi +++ b/doc/lispintro/emacs-lisp-intro.texi @@ -15678,7 +15678,7 @@ nil "-rw-r--r--" @end group @group -nil +t 2971624 773) @end group diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 36dd05b125a..31e4f791350 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,28 +1,79 @@ -2013-03-12 Glenn Morris <rgm@gnu.org> +2013-04-15 Christopher Schmidt <christopher@ch.ristopher.com> + + * tips.texi (Coding Conventions): Mention separation of package + descriptor and name of internal symbols by two hyphens. + +2013-04-13 Stephen Berman <stephen.berman@gmx.net> + + * windows.texi (Splitting Windows): Change category of + split-window from a command to a function. + +2013-04-06 Chong Yidong <cyd@gnu.org> + + * display.texi (Faces): Minor clarifications. + (Defining Faces): Clarify default vs custom face specs. Document + face-spec-set. + + * display.texi (Overlay Properties): + * text.texi (Special Properties): Use the "anonymous face" + terminology. Describe foreground-color and background-color forms + as compatibility-only. + +2013-03-24 Eli Zaretskii <eliz@gnu.org> + + * compile.texi (Byte-Code Objects): Add index entry. + (Disassembly): Add cross-references. + +2013-03-23 Eli Zaretskii <eliz@gnu.org> + + * frames.texi (Size Parameters): More accurate description of the + difference between 'fullboth' and 'maximized'. (Bug#13935) + +2013-03-17 Christopher Schmidt <christopher@ch.ristopher.com> + + * symbols.texi (Standard Properties): Document pure. (Bug#13823) + +2013-03-16 Glenn Morris <rgm@gnu.org> * elisp.texi: Add some stuff specific to www.gnu.org. -2013-03-11 Glenn Morris <rgm@gnu.org> +2013-03-11 Teodor Zlatanov <tzz@lifelogs.com> + + * control.texi (Pattern matching case statement): Fix typo. + +2013-03-04 Paul Eggert <eggert@cs.ucla.edu> - * Version 24.3 released. + * elisp.texi, intro.texi: Switch from Latin-1 to UTF-8. 2013-03-03 Glenn Morris <rgm@gnu.org> * objects.texi (Symbol Type): Fix typo. -2013-02-27 Bastien Guerry <bzg@gnu.org> +2013-02-28 Bastien Guerry <bzg@gnu.org> * variables.texi (File Local Variables): Fix reference. -2013-02-23 Eli Zaretskii <eliz@gnu.org> +2013-02-24 Eli Zaretskii <eliz@gnu.org> * files.texi (Magic File Names): Improve wording and indexing. +2013-02-21 Glenn Morris <rgm@gnu.org> + + * display.texi (Multi-Frame Images): Minor rephrasing. + +2013-02-20 Glenn Morris <rgm@gnu.org> + + * display.texi (GIF Images, TIFF Images): Delete these nodes. + (ImageMagick Images): For :index, use an xref rather than duplicating. + (Other Image Types): Add GIF, adjust formatting. + (Multi-Frame Images): Rename from Animated Images. Expand section. + * elisp.texi (Top): Update menu for these changes. + 2013-02-19 Glenn Morris <rgm@gnu.org> * text.texi (Change Hooks): Fix typo. -2013-02-14 Glenn Morris <rgm@gnu.org> +2013-02-15 Glenn Morris <rgm@gnu.org> * modes.texi (Basic Major Modes): 'z' no longer bound in special-mode. @@ -32,31 +83,39 @@ * modes.texi (Minor Mode Conventions): Fix typo. -2013-02-12 Glenn Morris <rgm@gnu.org> - * keymaps.texi (Scanning Keymaps): Remove obsolete sentence about meta characters; this changed in 22.1. (Bug#13684) -2013-02-11 Glenn Morris <rgm@gnu.org> - * objects.texi (Char-Table Type): Add cindex. * keymaps.texi (Key Binding Commands): Trivial rephrasing. -2013-02-09 Glenn Morris <rgm@gnu.org> +2013-02-10 Glenn Morris <rgm@gnu.org> * keymaps.texi (Creating Keymaps): Update make-keymap result. +2013-02-09 Eli Zaretskii <eliz@gnu.org> + + * modes.texi (%-Constructs): Remove the description of %t. + + * nonascii.texi (MS-DOS File Types): Delete node. + 2013-02-08 Glenn Morris <rgm@gnu.org> * keymaps.texi (Active Keymaps, Searching Keymaps): Remove confusing mention of "symbolic prefix". (Bug#13643) -2013-01-16 Glenn Morris <rgm@gnu.org> +2013-01-19 Glenn Morris <rgm@gnu.org> * macros.texi (Indenting Macros): Fix order of an indent symbol's arguments. (Bug#13450) +2013-01-19 Paul Eggert <eggert@cs.ucla.edu> + + Allow floating-point file offsets. + * files.texi (Reading from Files, Writing to Files): + Say that file offsets can be numbers, not just integers. + 2013-01-09 Glenn Morris <rgm@gnu.org> * commands.texi (Interactive Codes): @@ -80,10 +139,14 @@ * keymaps.texi (Key Sequences): Remove obsolete sentence (Bug#13356). -2013-01-03 Ari Roponen <ari.roponen@gmail.com> (tiny change) +2013-01-04 Ari Roponen <ari.roponen@gmail.com> (tiny change) * hash.texi (Defining Hash): Fix typo. (Bug#13345) +2013-01-04 Stefan Monnier <monnier@iro.umontreal.ca> + + * files.texi (File Attributes): Undocument return format of file-acl. + 2013-01-03 Glenn Morris <rgm@gnu.org> * processes.texi (System Processes): @@ -93,7 +156,7 @@ * elisp.texi (DATE): Bump to Jan 2013. -2012-12-31 Glenn Morris <rgm@gnu.org> +2013-01-02 Glenn Morris <rgm@gnu.org> * customize.texi (Common Keywords, Type Keywords): Replace "active field" with "button". (Bug#13310) @@ -101,7 +164,7 @@ * customize.texi (Common Keywords): Add xref. (Bug#13311) * tips.texi (Library Headers): Add cindex. -2012-12-29 Wolfgang Jenkner <wjenkner@inode.at> +2012-12-30 Wolfgang Jenkner <wjenkner@inode.at> * functions.texi (Declare Form): * intro.texi (A Sample Function Description): @@ -109,6 +172,11 @@ * variables.texi (Using Lexical Binding): Don't use @var or CAPS in @def.. commands. (Bug#13292) +2012-12-29 Eli Zaretskii <eliz@gnu.org> + + * files.texi (Changing Files): Document the return values of + set-file-selinux-context and set-file-acl. + 2012-12-27 Glenn Morris <rgm@gnu.org> * files.texi (File Names): Mention Cygwin conversion functions. @@ -118,6 +186,12 @@ * windows.texi (Selecting Windows): Reword description of select-window (Bug#13248). +2012-12-22 Eli Zaretskii <eliz@gnu.org> + + * files.texi (File Attributes, Changing Files): Remove the details + about the text returned by file-acl. Instead, just document that + it is an opaque string meant to be used by set-file-acl. + 2012-12-21 Chong Yidong <cyd@gnu.org> * modes.texi (Auto Major Mode): Fix typo (Bug#13230). @@ -125,26 +199,71 @@ * customize.texi (Simple Types): Document key-sequence type (Bug#13048). -2012-12-15 Chong Yidong <cyd@gnu.org> - * strings.texi (Text Comparison): Doc fix for compare-strings. -2012-12-09 Stefan Monnier <monnier@iro.umontreal.ca> +2012-12-19 Michael Albinus <michael.albinus@gmx.de> - * control.texi (Pattern matching case statement): New node. + * files.texi (Magic File Names): Add `file-acl', + `file-selinux-context', `set-file-acl' and + `set-file-selinux-context'. Make the list consistent. + +2012-12-19 Jonas Bernoulli <jonas@bernoul.li> + + * tips.texi (Library Headers): New header keyword `Homepage'. + Make continuation lines syntax more precise. + +2012-12-17 Eli Zaretskii <eliz@gnu.org> -2012-12-06 Stefan Monnier <monnier@iro.umontreal.ca> + * files.texi (File Attributes, Changing Files): Update to include + MS-Windows support for ACLs. + +2012-12-16 Romain Francoise <romain@orebokech.com> + + * files.texi (File Attributes): Document ACL support and new + `file-acl' function. + (Changing Files): Mention argument name change of `copy-file' and + document new function `set-file-acl'. + +2012-12-14 Paul Eggert <eggert@cs.ucla.edu> + + Fix permissions bugs with setgid directories etc. (Bug#13125) + * files.texi (Testing Accessibility): Document GROUP arg + of file-ownership-preserved-p. + (File Attributes): Document that 9th element is now + just a placeholder. + * os.texi (User Identification): Document new functions group-gid, + group-real-gid. + +2012-12-11 Paul Eggert <eggert@cs.ucla.edu> + + * internals.texi (C Integer Types): New section. + This follows up and records an email in + <http://lists.gnu.org/archive/html/emacs-devel/2012-07/msg00496.html>. + +2012-12-10 Stefan Monnier <monnier@iro.umontreal.ca> + + * control.texi (Pattern matching case statement): New node. * customize.texi (Variable Definitions): Mention the default :group for defcustoms (bug#13093). -2012-12-05 Chong Yidong <cyd@gnu.org> +2012-12-09 Glenn Morris <rgm@gnu.org> + + * customize.texi (Variable Definitions): Mention eval-defun + on a defcustom calls the :set function when appropriate. + +2012-12-06 Paul Eggert <eggert@cs.ucla.edu> + + * doclicense.texi, gpl.texi: Update to latest version from FSF. + These are just minor editorial changes. + +2012-12-06 Chong Yidong <cyd@gnu.org> * lists.texi (Plist Access): Move put example to Symbol Plists. * symbols.texi (Standard Properties): Fix typo. -2012-12-02 Chong Yidong <cyd@gnu.org> +2012-12-03 Chong Yidong <cyd@gnu.org> * symbols.texi (Symbol Properties): New node. (Symbol Plists): Make it a subsection under Symbol Properties. @@ -161,7 +280,17 @@ * commands.texi (Using Interactive): Fix index entry. -2012-11-23 Martin Rudalics <rudalics@gmx.at> +2012-11-24 Paul Eggert <eggert@cs.ucla.edu> + + * doclicense.texi: Update to latest version from FSF. + These are just minor editorial changes. + * elisp.texi (GNU Free Documentation License) + (GNU General Public Licens): + Provide sectioning, since doclicense.texi no longer does that. + + * loading.texi (Named Features): @ -> @@ to fix typo. + +2012-11-24 Martin Rudalics <rudalics@gmx.at> * windows.texi (Basic Windows): Fix typo. (Windows and Frames): Fix example. Move description of @@ -176,34 +305,34 @@ dedicatedness affects functions removing buffers or windows. * buffers.texi (The Buffer List): Fix description of bury-buffer. -2012-11-23 Chong Yidong <cyd@gnu.org> +2012-11-24 Chong Yidong <cyd@gnu.org> * modes.texi (%-Constructs): Fix statement about mode construct padding (Bug#12866). -2012-11-21 Stefan Monnier <monnier@iro.umontreal.ca> +2012-11-24 Stefan Monnier <monnier@iro.umontreal.ca> * debugging.texi (Profiling): Make it more clear that --enable-profiling is about profiling the C code. 2012-11-21 Glenn Morris <rgm@gnu.org> - * debugging.texi (Profiling): Mention --enable-profiling (if !tex). - Add some basic information about the profile report buffer. - (Debugging): Mention profiling in the introduction. - -2012-11-20 Glenn Morris <rgm@gnu.org> + * display.texi (Attribute Functions): + Update for set-face-* name changes. + Add new "inherit" argument for face-bold-p etc. + Move description of this argument to a common section, like "frame". - * debugging.texi (Profiling): New section, in progress. + * debugging.texi (Profiling): New section. + (Debugging): Mention profiling in the introduction. * tips.texi (Compilation Tips): Move profiling to separate section. * elisp.texi: Add Profiling to detailed menu. -2012-11-18 Martin Rudalics <rudalics@gmx.at> +2012-11-21 Martin Rudalics <rudalics@gmx.at> * windows.texi (Display Action Functions): Fix recently added example. Suggested by Michael Heerdegen. -2012-11-18 Paul Eggert <eggert@cs.ucla.edu> +2012-11-21 Paul Eggert <eggert@cs.ucla.edu> Minor cleanup for times as lists of four integers. * os.texi (Time Parsing): Time values can now be four integers. @@ -213,16 +342,14 @@ * loading.texi (How Programs Do Loading): Add eager macro expansion. * macros.texi (Expansion): Mention eager macro expansion. -2012-11-17 Glenn Morris <rgm@gnu.org> - * minibuf.texi (Basic Completion): Mention misc completion-table funcs. -2012-11-17 Leo Liu <sdl.web@gmail.com> +2012-11-18 Leo Liu <sdl.web@gmail.com> * minibuf.texi (Programmed Completion): Doc fix for metadata request (Bug#12850). -2012-11-17 Glenn Morris <rgm@gnu.org> +2012-11-18 Glenn Morris <rgm@gnu.org> * display.texi (Temporary Displays): Document with-temp-buffer-window. @@ -239,31 +366,35 @@ Fix description of display-buffer-below-selected. Reorder actions. Add example (Bug#12848). -2012-11-15 Stefan Monnier <monnier@iro.umontreal.ca> - - * keymaps.texi (Translation Keymaps): Add a subsection "Interaction - with normal keymaps" (bug#12868). - -2012-11-15 Glenn Morris <rgm@gnu.org> +2012-11-16 Glenn Morris <rgm@gnu.org> * display.texi (Face Attributes): Fix :underline COLOR description. (Attribute Functions): Update for set-face-underline rename. Tweak descriptions of face-underline-p, face-inverse-video-p. -2012-11-14 Glenn Morris <rgm@gnu.org> - * keymaps.texi (Searching Keymaps, Tool Bar): Untabify examples, so they align better in info. (Active Keymaps, Searching Keymaps, Controlling Active Maps): Document set-temporary-overlay-map. -2012-11-12 Glenn Morris <rgm@gnu.org> +2012-11-15 Stefan Monnier <monnier@iro.umontreal.ca> + + * keymaps.texi (Translation Keymaps): Add a subsection "Interaction + with normal keymaps". + +2012-11-15 Dmitry Antipov <dmantipov@yandex.ru> + + * internals.texi (Garbage Collection): Update descriptions + of vectorlike_header, garbage-collect and gc-cons-threshold. + (Object Internals): Explain Lisp_Object layout and the basics + of an internal type system. + (Buffer Internals): Update description of struct buffer. + +2012-11-13 Glenn Morris <rgm@gnu.org> * variables.texi (Adding Generalized Variables): At least mention gv-define-expander and gv-letplace. -2012-11-11 Glenn Morris <rgm@gnu.org> - * debugging.texi (Error Debugging): Mention debug-on-message. (Using Debugger): Mention debugger-bury-or-kill. @@ -274,14 +405,14 @@ * variables.texi (Adding Generalized Variables): Use standard formatting for common lisp note about setf functions. -2012-11-07 Martin Rudalics <rudalics@gmx.at> +2012-11-10 Martin Rudalics <rudalics@gmx.at> * elisp.texi (Top): Add Recombining Windows to menu. * windows.texi (Recombining Windows): New subsection. (Splitting Windows): Rewrite text on handling of window combinations and move it to new subsection. -2012-11-07 Chong Yidong <cyd@gnu.org> +2012-11-10 Chong Yidong <cyd@gnu.org> * searching.texi (Replacing Match): Document \? in replace-match. @@ -294,13 +425,11 @@ * edebug.texi (Specification List): setf is no longer CL-only. -2012-11-07 Glenn Morris <rgm@gnu.org> +2012-11-10 Glenn Morris <rgm@gnu.org> * variables.texi (Adding Generalized Variables): Update description of FIX-RETURN expansion. -2012-11-06 Glenn Morris <rgm@gnu.org> - * variables.texi (Setting Generalized Variables): Split most of previous contents into this subsection. (Adding Generalized Variables): New subsection. @@ -308,10 +437,17 @@ * elisp.texi: Add Generalized Variables subsections to detailed menu. -2012-11-05 Chong Yidong <cyd@gnu.org> +2012-11-10 Chong Yidong <cyd@gnu.org> * frames.texi (Initial Parameters): Doc fix (Bug#12144). +2012-11-08 Michael Albinus <michael.albinus@gmx.de> + + * os.texi (Notifications): Update descriptions of + notifications-notify, notifications-close-notification and + notifications-get-capabilities according to latest code changes. + Add notifications-get-server-information. + 2012-11-03 Chong Yidong <cyd@gnu.org> * objects.texi (General Escape Syntax): Clarify the explanation of diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi index d60ffebae70..522a88da61e 100644 --- a/doc/lispref/compile.texi +++ b/doc/lispref/compile.texi @@ -514,6 +514,7 @@ one you intend to suppress. @section Byte-Code Function Objects @cindex compiled function @cindex byte-code function +@cindex byte-code object Byte-compiled functions have a special data type: they are @dfn{byte-code function objects}. Whenever such an object appears as @@ -606,8 +607,9 @@ name of an existing buffer. Then the output goes there, at point, and point is left before the output. The argument @var{object} can be a function name, a lambda expression -or a byte-code object. If it is a lambda expression, @code{disassemble} -compiles it and disassembles the resulting compiled code. +(@pxref{Lambda Expressions}), or a byte-code object (@pxref{Byte-Code +Objects}). If it is a lambda expression, @code{disassemble} compiles +it and disassembles the resulting compiled code. @end deffn Here are two examples of using the @code{disassemble} function. We diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi index 76a2f464792..9ee01299260 100644 --- a/doc/lispref/control.texi +++ b/doc/lispref/control.texi @@ -373,7 +373,7 @@ symbol to the value that it matched, so that you can later refer to it, either in the @var{body-forms} or also later in the pattern. @item _ This so-called @emph{don't care} pattern matches anything, like the previous -one, but unless symbol patterns it does not bind any variable. +one, but unlike symbol patterns it does not bind any variable. @item (pred @var{pred}) This pattern matches if the function @var{pred} returns non-@code{nil} when called with the object being matched. diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi index 2b375b1bcc3..e9260309057 100644 --- a/doc/lispref/customize.texi +++ b/doc/lispref/customize.texi @@ -310,8 +310,10 @@ defined with @code{defgroup} in the same file will be used. This way, most When you evaluate a @code{defcustom} form with @kbd{C-M-x} in Emacs Lisp mode (@code{eval-defun}), a special feature of @code{eval-defun} arranges to set the variable unconditionally, without testing whether -its value is void. (The same feature applies to @code{defvar}.) -@xref{Defining Variables}. +its value is void. (The same feature applies to @code{defvar}, +@pxref{Defining Variables}.) Using @code{eval-defun} on a defcustom +that is already defined calls the @code{:set} function (see below), +if there is one. If you put a @code{defcustom} in a pre-loaded Emacs Lisp file (@pxref{Building Emacs}), the standard value installed at dump time diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index b7ea39ab69d..4adcfdf8f4f 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -1510,31 +1510,31 @@ of the symbol serve as defaults for the properties of the overlay. @item face @kindex face @r{(overlay property)} -This property controls the way text is displayed---for example, which -font and which colors. @xref{Faces}, for more information. - -In the simplest case, the value is a face name. It can also be a list; -then each element can be any of these possibilities: +This property controls the appearance of the text (@pxref{Faces}). +The value of the property can be the following: @itemize @bullet @item A face name (a symbol or string). @item -A property list of face attributes. This has the form (@var{keyword} -@var{value} @dots{}), where each @var{keyword} is a face attribute -name and @var{value} is a meaningful value for that attribute. With -this feature, you do not need to create a face each time you want to -specify a particular attribute for certain text. @xref{Face -Attributes}. +An anonymous face: a property list of the form @code{(@var{keyword} +@var{value} @dots{})}, where each @var{keyword} is a face attribute +name and @var{value} is a value for that attribute. @item -A cons cell, of the form @code{(foreground-color . @var{color-name})} -or @code{(background-color . @var{color-name})}. These elements -specify just the foreground color or just the background color. +A list of faces. Each list element should be either a face name or an +anonymous face. This specifies a face which is an aggregate of the +attributes of each of the listed faces. Faces occurring earlier in +the list have higher priority. -@code{(foreground-color . @var{color-name})} has the same effect as -@code{(:foreground @var{color-name})}; likewise for the background. +@item +A cons cell of the form @code{(foreground-color . @var{color-name})} +or @code{(background-color . @var{color-name})}. This specifies the +foreground or background color, similar to @code{(:foreground +@var{color-name})} or @code{(:background @var{color-name})}. This +form is supported for backward compatibility only, and should be +avoided. @end itemize @item mouse-face @@ -1901,44 +1901,39 @@ height. @section Faces @cindex faces - A @dfn{face} is a collection of graphical @dfn{attributes} for -displaying text: font, foreground color, background color, optional -underlining, etc. Faces control how Emacs displays text in buffers, -as well as other parts of the frame such as the mode line. + A @dfn{face} is a collection of graphical attributes for displaying +text: font, foreground color, background color, optional underlining, +etc. Faces control how Emacs displays text in buffers, as well as +other parts of the frame such as the mode line. @cindex anonymous face One way to represent a face is as a property list of attributes, -like @code{(:foreground "red" :weight bold)}. For example, you can -assign such an @dfn{anonymous face} as the value of the @code{face} -text property; this causes Emacs to display the underlying text with -the specified attributes. @xref{Special Properties}. +like @code{(:foreground "red" :weight bold)}. Such a list is called +an @dfn{anonymous face}. For example, you can assign an anonymous +face as the value of the @code{face} text property, and Emacs will +display the underlying text with the specified attributes. +@xref{Special Properties}. @cindex face name More commonly, a face is referred to via a @dfn{face name}: a Lisp -symbol which is associated with a set of face attributes. Named faces -are defined using the @code{defface} macro (@pxref{Defining Faces}). -Emacs defines several standard named faces; @xref{Standard Faces,,, -emacs, The GNU Emacs Manual}. - - Many parts of Emacs require named faces, and do not accept anonymous -faces. These include the functions documented in @ref{Attribute -Functions}, and the variable @code{font-lock-keywords} +symbol associated with a set of face attributes@footnote{For backward +compatibility, you can also use a string to specify a face name; that +is equivalent to a Lisp symbol with the same name.}. Named faces are +defined using the @code{defface} macro (@pxref{Defining Faces}). +Emacs comes with several standard named faces (@pxref{Basic Faces}). + + Many parts of Emacs required named faces, and do not accept +anonymous faces. These include the functions documented in +@ref{Attribute Functions}, and the variable @code{font-lock-keywords} (@pxref{Search-based Fontification}). Unless otherwise stated, we will use the term @dfn{face} to refer only to named faces. - For backward compatibility, you can also use a string to specify a -face name; that is equivalent to a Lisp symbol with the same name. - @defun facep object This function returns a non-@code{nil} value if @var{object} is a named face: a Lisp symbol or string which serves as a face name. Otherwise, it returns @code{nil}. @end defun - By default, each face name corresponds to the same set of attributes -in all frames. But you can also assign a face name a special set of -attributes in one frame (@pxref{Attribute Functions}). - @menu * Face Attributes:: What is in a face? * Defining Faces:: How to define a face. @@ -2178,32 +2173,47 @@ suitable for use with @code{:stipple} (see above). It returns @node Defining Faces @subsection Defining Faces +@cindex face spec The usual way to define a face is through the @code{defface} macro. -This macro defines a face name, and associates that name with a set of -face attributes. It also sets up the face so that the user can -customize it via the Customize interface (@pxref{Customization}). +This macro associates a face name (a symbol) with a default @dfn{face +spec}. A face spec is a construct which specifies what attributes a +face should have on any given terminal; for example, a face spec might +specify one foreground color on high-color terminals, and a different +foreground color on low-color terminals. + + People are sometimes tempted to create a variable whose value is a +face name. In the vast majority of cases, this is not necessary; the +usual procedure is to define a face with @code{defface}, and then use +its name directly. @defmac defface face spec doc [keyword value]@dots{} -This macro declares @var{face} as a customizable face whose default -attributes are given by @var{spec}. You should not quote the symbol -@var{face}, and it should not end in @samp{-face} (that would be -redundant). The argument @var{doc} is a documentation string for the -face. The additional @var{keyword} arguments have the same meanings -as in @code{defgroup} and @code{defcustom} (@pxref{Common Keywords}). - -When @code{defface} executes, it defines the face according to -@var{spec}, then uses any customizations that were read from the -init file (@pxref{Init File}) to override that specification. - -When you evaluate a @code{defface} form with @kbd{C-M-x} in Emacs -Lisp mode (@code{eval-defun}), a special feature of @code{eval-defun} -overrides any customizations of the face. This way, the face reflects -exactly what the @code{defface} says. - -@cindex face specification -The @var{spec} argument is a @dfn{face specification}, which states -how the face should appear on different kinds of terminals. It should -be an alist whose elements each have the form +This macro declares @var{face} as a named face whose default face spec +is given by @var{spec}. You should not quote the symbol @var{face}, +and it should not end in @samp{-face} (that would be redundant). The +argument @var{doc} is a documentation string for the face. The +additional @var{keyword} arguments have the same meanings as in +@code{defgroup} and @code{defcustom} (@pxref{Common Keywords}). + +If @var{face} already has a default face spec, this macro does +nothing. + +The default face spec determines @var{face}'s appearance when no +customizations are in effect (@pxref{Customization}). If @var{face} +has already been customized (via Custom themes or via customizations +read from the init file), its appearance is determined by the custom +face spec(s), which override the default face spec @var{spec}. +However, if the customizations are subsequently removed, the +appearance of @var{face} will again be determined by its default face +spec. + +As an exception, if you evaluate a @code{defface} form with +@kbd{C-M-x} in Emacs Lisp mode (@code{eval-defun}), a special feature +of @code{eval-defun} overrides any custom face specs on the face, +causing the face to reflect exactly what the @code{defface} says. + +The @var{spec} argument is a @dfn{face spec}, which states how the +face should appear on different kinds of terminals. It should be an +alist whose elements each have the form @example (@var{display} . @var{plist}) @@ -2275,7 +2285,8 @@ terminal must match one of the @var{value}s specified for it in @end table @end defmac - Here's how the standard face @code{highlight} is defined: + For example, here's the definition of the standard face +@code{highlight}: @example (defface highlight @@ -2294,65 +2305,56 @@ terminal must match one of the @var{value}s specified for it in :group 'basic-faces) @end example - Internally, Emacs stores the face's default specification in its + Internally, Emacs stores each face's default spec in its @code{face-defface-spec} symbol property (@pxref{Symbol Properties}). -The @code{saved-face} property stores the face specification saved by -the user, using the customization buffer; the @code{customized-face} -property stores the face specification customized for the current -session, but not saved; and the @code{theme-face} property stores an -alist associating the active customization settings and Custom themes -with their specifications for that face. The face's documentation -string is stored in the @code{face-documentation} property. But -normally you should not try to set any of these properties directly. -@xref{Applying Customizations}, for the @code{custom-set-faces} -function, which is used to apply customized face settings. - - People are sometimes tempted to create variables whose values -specify a face to use. In the vast majority of cases, this is not -necessary; it is preferable to simply use faces directly. +The @code{saved-face} property stores any face spec saved by the user +using the customization buffer; the @code{customized-face} property +stores the face spec customized for the current session, but not +saved; and the @code{theme-face} property stores an alist associating +the active customization settings and Custom themes with the face +specs for that face. The face's documentation string is stored in the +@code{face-documentation} property. + + Normally, a face is declared just once, using @code{defface}, and +any further changes to its appearance are applied using the Customize +framework (e.g., via the Customize user interface or via the +@code{custom-set-faces} function; @pxref{Applying Customizations}), or +by face remapping (@pxref{Face Remapping}). In the rare event that +you need to change a face spec directly from Lisp, you can use the +@code{face-spec-set} function. + +@defun face-spec-set face spec &optional spec-type +This function applies @var{spec} as a face spec for @code{face}. +@var{spec} should be a face spec, as described in the above +documentation for @code{defface}. + +@cindex override spec @r{(for a face)} +The argument @var{spec-type} determines which spec to set. If it is +@code{nil} or @code{face-override-spec}, this function sets the +@dfn{override spec}, which overrides over all other face specs on +@var{face}. If it is @code{face-defface-spec}, this function sets the +default face spec (the same one set by @code{defface}). If it is +@code{reset}, this function clears out all customization specs and +override specs from @var{face} (in this case, the value of @var{spec} +is ignored). Any other value of @var{spec-type} is reserved for +internal use. +@end defun @node Attribute Functions @subsection Face Attribute Functions - This section describes the functions for accessing and modifying the -attributes of an existing named face. - -@defun set-face-attribute face frame &rest arguments -This function sets one or more attributes of @var{face} for -@var{frame}. The attributes you specify this way override whatever -the @code{defface} says. - -The extra arguments @var{arguments} specify the attributes to set, and -the values for them. They should consist of alternating attribute -names (such as @code{:family} or @code{:underline}) and values. Thus, - -@example -(set-face-attribute 'foo nil - :width 'extended - :weight 'bold) -@end example - -@noindent -sets the attribute @code{:width} to @code{extended} and the attribute -@code{:weight} to @code{bold}. - -If @var{frame} is @code{t}, this function sets the default attributes -for new frames. Default attribute values specified this way override -the @code{defface} for newly created frames. - -If @var{frame} is @code{nil}, this function sets the attributes for -all existing frames, and the default for new frames. -@end defun + This section describes functions for directly accessing and +modifying the attributes of a named face. @defun face-attribute face attribute &optional frame inherit -This returns the value of the @var{attribute} attribute of @var{face} -on @var{frame}. If @var{frame} is @code{nil}, that means the selected -frame (@pxref{Input Focus}). +This function returns the value of the @var{attribute} attribute for +@var{face} on @var{frame}. -If @var{frame} is @code{t}, this returns whatever new-frames default -value you previously specified with @code{set-face-attribute} for the -@var{attribute} attribute of @var{face}. If you have not specified -one, it returns @code{nil}. +If @var{frame} is @code{nil}, that means the selected frame +(@pxref{Input Focus}). If @var{frame} is @code{t}, this function +returns the value of the specified attribute for newly-created frames +(this is normally @code{unspecified}, unless you have specified some +value using @code{set-face-attribute}; see below). If @var{inherit} is @code{nil}, only attributes directly defined by @var{face} are considered, so the return value may be @@ -2411,6 +2413,36 @@ If @var{value1} is a relative value for the face attribute face attribute @var{attribute}, returns @var{value1} unchanged. @end defun + Normally, Emacs uses the face specs of each face to automatically +calculate its attributes on each frame (@pxref{Defining Faces}). The +function @code{set-face-attribute} can override this calculation by +directly assigning attributes to a face, either on a specific frame or +for all frames. This function is mostly intended for internal usage. + +@defun set-face-attribute face frame &rest arguments +This function sets one or more attributes of @var{face} for +@var{frame}. The attributes specifies in this way override the face +spec(s) belonging to @var{face}. + +The extra arguments @var{arguments} specify the attributes to set, and +the values for them. They should consist of alternating attribute +names (such as @code{:family} or @code{:underline}) and values. Thus, + +@example +(set-face-attribute 'foo nil :weight 'bold :slant 'italic) +@end example + +@noindent +sets the attribute @code{:weight} to @code{bold} and the attribute +@code{:slant} to @code{italic}. + + +If @var{frame} is @code{t}, this function sets the default attributes +for newly created frames. If @var{frame} is @code{nil}, this function +sets the attributes for all existing frames, as well as for newly +created frames. +@end defun + The following commands and functions mostly provide compatibility with old versions of Emacs. They work by calling @code{set-face-attribute}. Values of @code{t} and @code{nil} for @@ -2433,12 +2465,12 @@ This sets the @code{:stipple} attribute of @var{face} to This sets the @code{:font} attribute of @var{face} to @var{font}. @end deffn -@defun set-face-bold-p face bold-p &optional frame +@defun set-face-bold face bold-p &optional frame This sets the @code{:weight} attribute of @var{face} to @var{normal} if @var{bold-p} is @code{nil}, and to @var{bold} otherwise. @end defun -@defun set-face-italic-p face italic-p &optional frame +@defun set-face-italic face italic-p &optional frame This sets the @code{:slant} attribute of @var{face} to @var{normal} if @var{italic-p} is @code{nil}, and to @var{italic} otherwise. @end defun @@ -2448,7 +2480,7 @@ This sets the @code{:underline} attribute of @var{face} to @var{underline}. @end defun -@defun set-face-inverse-video-p face inverse-video-p &optional frame +@defun set-face-inverse-video face inverse-video-p &optional frame This sets the @code{:inverse-video} attribute of @var{face} to @var{inverse-video-p}. @end defun @@ -2457,63 +2489,53 @@ This sets the @code{:inverse-video} attribute of @var{face} to This swaps the foreground and background colors of face @var{face}. @end deffn - The following functions examine the attributes of a face. If you -don't specify @var{frame}, they refer to the selected frame; @code{t} -refers to the default data for new frames. They return the symbol -@code{unspecified} if the face doesn't define any value for that -attribute. + The following functions examine the attributes of a face. They +mostly provide compatibility with old versions of Emacs. If you don't +specify @var{frame}, they refer to the selected frame; @code{t} refers +to the default data for new frames. They return @code{unspecified} if +the face doesn't define any value for that attribute. If +@var{inherit} is @code{nil}, only an attribute directly defined by the +face is returned. If @var{inherit} is non-@code{nil}, any faces +specified by its @code{:inherit} attribute are considered as well, and +if @var{inherit} is a face or a list of faces, then they are also +considered, until a specified attribute is found. To ensure that the +return value is always specified, use a value of @code{default} for +@var{inherit}. + +@defun face-font face &optional frame +This function returns the name of the font of face @var{face}. +@end defun @defun face-foreground face &optional frame inherit @defunx face-background face &optional frame inherit These functions return the foreground color (or background color, respectively) of face @var{face}, as a string. - -If @var{inherit} is @code{nil}, only a color directly defined by the face is -returned. If @var{inherit} is non-@code{nil}, any faces specified by its -@code{:inherit} attribute are considered as well, and if @var{inherit} -is a face or a list of faces, then they are also considered, until a -specified color is found. To ensure that the return value is always -specified, use a value of @code{default} for @var{inherit}. @end defun @defun face-stipple face &optional frame inherit This function returns the name of the background stipple pattern of face @var{face}, or @code{nil} if it doesn't have one. - -If @var{inherit} is @code{nil}, only a stipple directly defined by the -face is returned. If @var{inherit} is non-@code{nil}, any faces -specified by its @code{:inherit} attribute are considered as well, and -if @var{inherit} is a face or a list of faces, then they are also -considered, until a specified stipple is found. To ensure that the -return value is always specified, use a value of @code{default} for -@var{inherit}. -@end defun - -@defun face-font face &optional frame -This function returns the name of the font of face @var{face}. @end defun -@defun face-bold-p face &optional frame +@defun face-bold-p face &optional frame inherit This function returns a non-@code{nil} value if the @code{:weight} attribute of @var{face} is bolder than normal (i.e., one of @code{semi-bold}, @code{bold}, @code{extra-bold}, or @code{ultra-bold}). Otherwise, it returns @code{nil}. @end defun -@defun face-italic-p face &optional frame +@defun face-italic-p face &optional frame inherit This function returns a non-@code{nil} value if the @code{:slant} attribute of @var{face} is @code{italic} or @code{oblique}, and @code{nil} otherwise. @end defun -@c Note the weasel words. A face that inherits from an underlined -@c face but does not specify :underline will return nil. -@defun face-underline-p face &optional frame +@defun face-underline-p face &optional frame inherit This function returns non-@code{nil} if face @var{face} specifies a non-@code{nil} @code{:underline} attribute. @end defun -@defun face-inverse-video-p face &optional frame +@defun face-inverse-video-p face &optional frame inherit This function returns non-@code{nil} if face @var{face} specifies a non-@code{nil} @code{:inverse-video} attribute. @end defun @@ -2587,13 +2609,13 @@ The value of this variable is an alist whose elements have the form any text having the face @var{face} with @var{remapping}, rather than the ordinary definition of @var{face}. -@var{remapping} may be any face specification suitable for a -@code{face} text property: either a face (i.e., a face name or a -property list of attribute/value pairs), or a list of faces. For -details, see the description of the @code{face} text property in -@ref{Special Properties}. @var{remapping} serves as the complete -specification for the remapped face---it replaces the normal -definition of @var{face}, instead of modifying it. +@var{remapping} may be any face spec suitable for a @code{face} text +property: either a face (i.e., a face name or a property list of +attribute/value pairs), or a list of faces. For details, see the +description of the @code{face} text property in @ref{Special +Properties}. @var{remapping} serves as the complete specification for +the remapped face---it replaces the normal definition of @var{face}, +instead of modifying it. If @code{face-remapping-alist} is buffer-local, its local value takes effect only within that buffer. @@ -2640,7 +2662,7 @@ and @code{face-remap-reset-base} functions; it is intended for major modes to remap faces in the buffers they control. @defun face-remap-add-relative face &rest specs -This functions adds the face specifications in @var{specs} as relative +This functions adds the face spec in @var{specs} as relative remappings for face @var{face} in the current buffer. The remaining arguments, @var{specs}, should form either a list of face names, or a property list of attribute/value pairs. @@ -4210,14 +4232,12 @@ displayed (@pxref{Display Feature Testing}). * Image Descriptors:: How to specify an image for use in @code{:display}. * XBM Images:: Special features for XBM format. * XPM Images:: Special features for XPM format. -* GIF Images:: Special features for GIF format. -* TIFF Images:: Special features for TIFF format. * PostScript Images:: Special features for PostScript format. * ImageMagick Images:: Special features available through ImageMagick. * Other Image Types:: Various other formats are supported. * Defining Images:: Convenient ways to define an image for later use. * Showing Images:: Convenient ways to display an image once it is defined. -* Animated Images:: Some image formats can be animated. +* Multi-Frame Images:: Some images contain more than one frame. * Image Cache:: Internal mechanisms of image display. @end menu @@ -4552,35 +4572,6 @@ the name of a color as it appears in the image file, and @var{color} specifies the actual color to use for displaying that name. @end table -@node GIF Images -@subsection GIF Images -@cindex GIF - - For GIF images, specify image type @code{gif}. - -@table @code -@item :index @var{index} -You can use @code{:index} to specify image number @var{index} from a -GIF file that contains more than one image. If the GIF file doesn't -contain an image with the specified index, the image displays as a -hollow box. GIF files with more than one image can be animated, -@pxref{Animated Images}. -@end table - -@node TIFF Images -@subsection TIFF Images -@cindex TIFF - - For TIFF images, specify image type @code{tiff}. - -@table @code -@item :index @var{index} -You can use @code{:index} to specify image number @var{index} from a -TIFF file that contains more than one image. If the TIFF file doesn't -contain an image with the specified index, the image displays as a -hollow box. -@end table - @node PostScript Images @subsection PostScript Images @cindex postscript images @@ -4664,10 +4655,7 @@ Specifies a rotation angle in degrees. @item :index @c Doesn't work: http://debbugs.gnu.org/7978 -This has the same meaning as it does for GIF images (@pxref{GIF Images}), -i.e., it specifies which image to view inside an image bundle file format -such as DJVM@. You can use the @code{image-metadata} function to -retrieve the total number of images in an image bundle. +@xref{Multi-Frame Images}. @end table @node Other Image Types @@ -4692,13 +4680,27 @@ used for each pixel in the PBM that is 0. The default is the frame's background color. @end table - For JPEG images, specify image type @code{jpeg}. +@noindent +The remaining image types that Emacs can support are: - For TIFF images, specify image type @code{tiff}. +@table @asis +@item GIF +Image type @code{gif}. +Supports the @code{:index} property. @xref{Multi-Frame Images}. + +@item JPEG +Image type @code{jpeg}. - For PNG images, specify image type @code{png}. +@item PNG +Image type @code{png}. - For SVG images, specify image type @code{svg}. +@item SVG +Image type @code{svg}. + +@item TIFF +Image type @code{tiff}. +Supports the @code{:index} property. @xref{Multi-Frame Images}. +@end table @node Defining Images @subsection Defining Images @@ -4934,20 +4936,45 @@ cache, it can always be displayed, even if the value of @var{max-image-size} is subsequently changed (@pxref{Image Cache}). @end defvar -@node Animated Images -@subsection Animated Images +@node Multi-Frame Images +@subsection Multi-Frame Images @cindex animation @cindex image animation -Some image files can contain more than one image. This can be used to -create animation. Currently, Emacs only supports animated GIF files. -The following functions related to animated images are available. +@cindex image frames +Some image files can contain more than one image. We say that there +are multiple ``frames'' in the image. At present, Emacs supports +multiple frames for GIF, TIFF, and certain ImageMagick formats such as +DJVM@. + +The frames can be used either to represent multiple ``pages'' (this is +usually the case with multi-frame TIFF files, for example), or to +create animation (usually the case with multi-frame GIF files). + +A multi-frame image has a property @code{:index}, whose value is an +integer (counting from 0) that specifies which frame is being displayed. + +@defun image-multi-frame-p image +This function returns non-@code{nil} if @var{image} contains more than +one frame. The actual return value is a cons @code{(@var{nimages} +. @var{delay})}, where @var{nimages} is the number of frames and +@var{delay} is the delay in seconds between them, or @code{nil} +if the image does not specify a delay. Images that are intended to be +animated usually specify a frame delay, whereas ones that are intended +to be treated as multiple pages do not. +@end defun + +@defun image-current-frame image +This function returns the index of the current frame number for +@var{image}, counting from 0. +@end defun -@defun image-animated-p image -This function returns non-@code{nil} if @var{image} can be animated. -The actual return value is a cons @code{(@var{nimages} . @var{delay})}, -where @var{nimages} is the number of frames and @var{delay} is the -delay in seconds between them. +@defun image-show-frame image n &optional nocheck +This function switches @var{image} to frame number @var{n}. It +replaces a frame number outside the valid range with that of the end +of the range, unless @var{nocheck} is non-@code{nil}. If @var{image} +does not contain a frame with the specified number, the image displays +as a hollow box. @end defun @defun image-animate image &optional index limit @@ -4959,7 +4986,9 @@ forever; if a number animation stops after that many seconds. @end defun @noindent Animation operates by means of a timer. Note that Emacs imposes a -minimum frame delay of 0.01 seconds. +minimum frame delay of 0.01 (@code{image-minimum-frame-delay}) seconds. +If the image itself does not specify a delay, Emacs uses +@code{image-default-frame-delay}. @defun image-animate-timer image This function returns the timer responsible for animating @var{image}, diff --git a/doc/lispref/doclicense.texi b/doc/lispref/doclicense.texi index 6e7ec924f65..9c3bbe56e91 100644 --- a/doc/lispref/doclicense.texi +++ b/doc/lispref/doclicense.texi @@ -1,15 +1,11 @@ -@c -*-texinfo-*- @c The GNU Free Documentation License. -@node GNU Free Documentation License - -@appendix GNU Free Documentation License @center Version 1.3, 3 November 2008 @c This file is intended to be included within another document, @c hence no sectioning command or @node. @display -Copyright @copyright{} 2000, 2001, 2002, 2007, 2008, 2009 Free Software Foundation, Inc. +Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. @uref{http://fsf.org/} Everyone is permitted to copy and distribute verbatim copies @@ -96,16 +92,16 @@ An image format is not Transparent if used for any substantial amount of text. A copy that is not ``Transparent'' is called ``Opaque''. Examples of suitable formats for Transparent copies include plain -@sc{ascii} without markup, Texinfo input format, La@TeX{} input -format, @acronym{SGML} or @acronym{XML} using a publicly available -@acronym{DTD}, and standard-conforming simple @acronym{HTML}, -PostScript or @acronym{PDF} designed for human modification. Examples -of transparent image formats include @acronym{PNG}, @acronym{XCF} and -@acronym{JPG}. Opaque formats include proprietary formats that can be -read and edited only by proprietary word processors, @acronym{SGML} or -@acronym{XML} for which the @acronym{DTD} and/or processing tools are -not generally available, and the machine-generated @acronym{HTML}, -PostScript or @acronym{PDF} produced by some word processors for +ASCII without markup, Texinfo input format, La@TeX{} input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG@. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for output purposes only. The ``Title Page'' means, for a printed book, the title page itself, @@ -485,7 +481,7 @@ license notices just after the title page: @end smallexample If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the ``with@dots{}Texts.'' line with this: +replace the ``with@dots{}Texts.''@: line with this: @smallexample @group @@ -504,7 +500,6 @@ recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software. - @c Local Variables: @c ispell-local-pdict: "ispell-dict" @c End: diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi index 9acbf85534e..9e9617c10f8 100644 --- a/doc/lispref/elisp.texi +++ b/doc/lispref/elisp.texi @@ -125,7 +125,7 @@ developing GNU and promoting software freedom.'' @end quotation @end copying -@documentencoding ISO-8859-1 +@documentencoding UTF-8 @dircategory GNU Emacs Lisp @direntry @@ -1219,8 +1219,6 @@ Coding Systems for a single file operation. * Explicit Encoding:: Encoding or decoding text without doing I/O. * Terminal I/O Encoding:: Use of encoding for terminal I/O. -* MS-DOS File Types:: How DOS "text" and "binary" files - relate to coding systems. Searching and Matching @@ -1429,15 +1427,13 @@ Images * Image Descriptors:: How to specify an image for use in @code{:display}. * XBM Images:: Special features for XBM format. * XPM Images:: Special features for XPM format. -* GIF Images:: Special features for GIF format. -* TIFF Images:: Special features for TIFF format. * PostScript Images:: Special features for PostScript format. * ImageMagick Images:: Special features available through ImageMagick. * Other Image Types:: Various other formats are supported. * Defining Images:: Convenient ways to define an image for later use. * Showing Images:: Convenient ways to display an image once it is defined. -* Animated Images:: Some image formats can be animated. +* Multi-Frame Images:: Some images contain more than one frame. * Image Cache:: Internal mechanisms of image display. Buttons @@ -1603,7 +1599,11 @@ Object Internals @c appendices @include anti.texi +@node GNU Free Documentation License +@appendix GNU Free Documentation License @include doclicense.texi +@node GPL +@appendix GNU General Public License @include gpl.texi @include tips.texi @include internals.texi diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index 49269d71bf9..971e38f20b7 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi @@ -533,9 +533,9 @@ is visiting the file @var{filename}: these include the buffer's visited file name and its last save file modtime. This feature is used by @code{find-file-noselect} and you probably should not use it yourself. -If @var{beg} and @var{end} are non-@code{nil}, they should be integers -specifying the portion of the file to insert. In this case, @var{visit} -must be @code{nil}. For example, +If @var{beg} and @var{end} are non-@code{nil}, they should be numbers +that are byte offsets specifying the portion of the file to insert. +In this case, @var{visit} must be @code{nil}. For example, @example (insert-file-contents filename nil 0 500) @@ -605,8 +605,8 @@ that string, rather than text from the buffer. @var{end} is ignored in this case. If @var{append} is non-@code{nil}, then the specified text is appended -to the existing file contents (if any). If @var{append} is an -integer, @code{write-region} seeks to that byte offset from the start +to the existing file contents (if any). If @var{append} is a +number, @code{write-region} seeks to that byte offset from the start of the file and writes the data from there. If @var{mustbenew} is non-@code{nil}, then @code{write-region} asks @@ -895,11 +895,14 @@ returns @code{nil}. However, if the open fails, it signals an error using @var{string} as the error message text. @end defun -@defun file-ownership-preserved-p filename +@defun file-ownership-preserved-p filename &optional group This function returns @code{t} if deleting the file @var{filename} and then creating it anew would keep the file's owner unchanged. It also returns @code{t} for nonexistent files. +If the optional argument @var{group} is non-@code{nil}, this function +also checks that the file's group would be unchanged. + If @var{filename} is a symbolic link, then, unlike the other functions discussed here, @code{file-ownership-preserved-p} does @emph{not} replace @var{filename} with its target. However, it does recursively @@ -1246,8 +1249,7 @@ The file's modes, as a string of ten letters or dashes, as in @samp{ls -l}. @item -@code{t} if the file's @acronym{GID} would change if file were -deleted and recreated; @code{nil} otherwise. +An unspecified value, present for backward compatibility. @item The file's inode number. If possible, this is an integer. If the @@ -1279,7 +1281,7 @@ For example, here are the file attributes for @file{files.texi}: (20000 23 0 0) (20614 64555 902289 872000) 122295 "-rw-rw-rw-" - nil (5888 2 . 43978) + t (5888 2 . 43978) (15479 . 46724)) @end group @end example @@ -1318,8 +1320,8 @@ end-of-line format is CR-LF.) @item "-rw-rw-rw-" has a mode of read and write access for the owner, group, and world. -@item nil -would retain the same @acronym{GID} if it were recreated. +@item t +is merely a placeholder; it carries no information. @item (5888 2 . 43978) has an inode number of 6473924464520138. @@ -1350,6 +1352,29 @@ not support SELinux, or if Emacs was not compiled with SELinux support, then the return value is @code{(nil nil nil nil)}. @end defun +@cindex access control list +@cindex ACL entries + If Emacs has been compiled with @dfn{ACL} (access control list) +support, you can use the function @code{file-acl} to retrieve a file's +ACL entries. The interface implementation is platform-specific; on +GNU/Linux and BSD, Emacs uses the POSIX ACL interface, while on +MS-Windows Emacs emulates the POSIX ACL interface with native file +security APIs. + +@defun file-acl filename +This function returns the ACL entries of the file @var{filename}. The +return value is a platform-dependent object containing some +representation of the ACL entries. Don't use it for anything except +passing it to the @code{set-file-acl} function (@pxref{Changing Files, +set-file-acl}). + +If the file does not exist or is inaccessible, or if Emacs was unable to +determine the ACL entries, then the return value is @code{nil}. The +latter can happen for local files if Emacs was not compiled with ACL +support, or for remote files if the file handler returns nil for the +file's ACL entries. +@end defun + @node Locating Files @subsection How to Locate Files in Standard Places @cindex locate file in path @@ -1539,9 +1564,10 @@ non-@code{nil}, we attempt to copy the user and group ownership of the file. This works only on some operating systems, and only if you have the correct permissions to do so. -If the optional argument @var{preserve-selinux} is non-@code{nil}, and -Emacs has been compiled with SELinux support, this function attempts -to copy the file's SELinux context (@pxref{File Attributes}). +If the optional argument @var{preserve-extended-attributes} is +non-@code{nil}, and Emacs has been built with the appropriate support, +this function attempts to copy the file's extended attributes, such as +its SELinux context and ACL entries (@pxref{File Attributes}). @end deffn @deffn Command make-symbolic-link filename newname &optional ok-if-exists @@ -1677,9 +1703,21 @@ This function sets the SELinux security context of the file @var{filename} to @var{context}. @xref{File Attributes}, for a brief description of SELinux contexts. The @var{context} argument should be a list @code{(@var{user} @var{role} @var{type} @var{range})}, like the -return value of @code{file-selinux-context}. The function does -nothing if SELinux is disabled, or if Emacs was compiled without -SELinux support. +return value of @code{file-selinux-context}. The function returns +@code{t} if it succeeds to set the SELinux security context of +@var{filename}, @code{nil} otherwise. The function does nothing and +returns @code{nil} if SELinux is disabled, or if Emacs was compiled +without SELinux support. +@end defun + +@defun set-file-acl filename acl-string +This function sets the ACL entries of the file @var{filename} to +@var{acl-string}. @xref{File Attributes}, for a brief description of +ACLs. The @var{acl-string} argument should be a string containing the +textual representation of the desired ACL entries as returned by +@code{file-acl} (@pxref{File Attributes, file-acl}). The function +returns @code{t} if it succeeds to set the ACL entries of +@var{filename}, @code{nil} otherwise. @end defun @node File Names @@ -2725,9 +2763,12 @@ first, before handlers for jobs such as remote file access. @code{dired-compress-file}, @code{dired-uncache},@* @code{expand-file-name}, @code{file-accessible-directory-p}, +@code{file-acl}, @code{file-attributes}, @code{file-directory-p}, +@code{file-equal-p}, @code{file-executable-p}, @code{file-exists-p}, +@code{file-in-directory-p}, @code{file-local-copy}, @code{file-remote-p}, @code{file-modes}, @code{file-name-all-completions}, @code{file-name-as-directory}, @@ -2736,9 +2777,10 @@ first, before handlers for jobs such as remote file access. @code{file-name-nondirectory}, @code{file-name-sans-versions}, @code{file-newer-than-file-p}, @code{file-ownership-preserved-p}, -@code{file-readable-p}, @code{file-regular-p}, @code{file-in-directory-p}, +@code{file-readable-p}, @code{file-regular-p}, +@code{file-selinux-context}, @code{file-symlink-p}, @code{file-truename}, @code{file-writable-p}, -@code{file-equal-p}, @code{find-backup-file-name}, +@code{find-backup-file-name}, @c Not sure why it was here: @code{find-file-noselect},@* @code{get-file-buffer}, @code{insert-directory}, @@ -2749,7 +2791,8 @@ first, before handlers for jobs such as remote file access. @code{make-directory-internal}, @code{make-symbolic-link},@* @code{process-file}, -@code{rename-file}, @code{set-file-modes}, @code{set-file-times}, +@code{rename-file}, @code{set-file-acl}, @code{set-file-modes}, +@code{set-file-selinux-context}, @code{set-file-times}, @code{set-visited-file-modtime}, @code{shell-command}, @code{start-file-process}, @code{substitute-in-file-name},@* @@ -2772,9 +2815,12 @@ first, before handlers for jobs such as remote file access. @code{dired-compress-file}, @code{dired-uncache}, @code{expand-file-name}, @code{file-accessible-direc@discretionary{}{}{}tory-p}, +@code{file-acl}, @code{file-attributes}, @code{file-direct@discretionary{}{}{}ory-p}, +@code{file-equal-p}, @code{file-executable-p}, @code{file-exists-p}, +@code{file-in-directory-p}, @code{file-local-copy}, @code{file-remote-p}, @code{file-modes}, @code{file-name-all-completions}, @code{file-name-as-directory}, @@ -2783,18 +2829,22 @@ first, before handlers for jobs such as remote file access. @code{file-name-nondirec@discretionary{}{}{}tory}, @code{file-name-sans-versions}, @code{file-newer-than-file-p}, @code{file-ownership-pre@discretionary{}{}{}served-p}, -@code{file-readable-p}, @code{file-regular-p}, @code{file-symlink-p}, -@code{file-truename}, @code{file-writable-p}, +@code{file-readable-p}, @code{file-regular-p}, +@code{file-selinux-context}, +@code{file-symlink-p}, @code{file-truename}, @code{file-writable-p}, @code{find-backup-file-name}, @c Not sure why it was here: @code{find-file-noselect}, @code{get-file-buffer}, @code{insert-directory}, @code{insert-file-contents}, -@code{load}, @code{make-direc@discretionary{}{}{}tory}, +@code{load}, +@code{make-auto-save-file-name}, +@code{make-direc@discretionary{}{}{}tory}, @code{make-direc@discretionary{}{}{}tory-internal}, @code{make-symbolic-link}, @code{process-file}, -@code{rename-file}, @code{set-file-modes}, +@code{rename-file}, @code{set-file-acl}, @code{set-file-modes}, +@code{set-file-selinux-context}, @code{set-file-times}, @code{set-visited-file-modtime}, @code{shell-command}, @code{start-file-process}, @code{substitute-in-file-name}, diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 7d56d38ffad..01d2d1d6c45 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi @@ -632,8 +632,9 @@ possible. The value @code{fullboth} specifies that both the width and the height shall be set to the size of the screen. The value @code{maximized} specifies that the frame shall be maximized. The difference between @code{maximized} and @code{fullboth} is that the -former still has window manager decorations while the latter really -covers the whole screen. +former can still be resized by dragging window manager decorations +with the mouse, while the latter really covers the whole screen and +does not allow resizing by mouse dragging. @end table @node Layout Parameters diff --git a/doc/lispref/gpl.texi b/doc/lispref/gpl.texi index 6dc50a9751c..0e2e212acb1 100644 --- a/doc/lispref/gpl.texi +++ b/doc/lispref/gpl.texi @@ -1,12 +1,8 @@ -@c -*-texinfo-*- - -@node GPL -@appendix GNU General Public License @c The GNU General Public License. @center Version 3, 29 June 2007 @c This file is intended to be included within another document, -@c hence no sectioning command or @node. +@c hence no sectioning command or @node. @display Copyright @copyright{} 2007 Free Software Foundation, Inc. @url{http://fsf.org/} @@ -226,7 +222,7 @@ terms of section 4, provided that you also meet all of these conditions: @enumerate a -@item +@item The work must carry prominent notices stating that you modified it, and giving a relevant date. @@ -627,12 +623,12 @@ later version. @item Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +APPLICABLE LAW@. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND -PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +A PARTICULAR PURPOSE@. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU@. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. @@ -674,7 +670,7 @@ state the exclusion of warranty; and each file should have at least the ``copyright'' line and a pointer to where the full notice is found. @smallexample -@var{one line to give the program's name and a brief idea of what it does.} +@var{one line to give the program's name and a brief idea of what it does.} Copyright (C) @var{year} @var{name of author} This program is free software: you can redistribute it and/or modify @@ -684,7 +680,7 @@ your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License @@ -697,7 +693,7 @@ If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: @smallexample -@var{program} Copyright (C) @var{year} @var{name of author} +@var{program} Copyright (C) @var{year} @var{name of author} This program comes with ABSOLUTELY NO WARRANTY; for details type @samp{show w}. This is free software, and you are welcome to redistribute it under certain conditions; type @samp{show c} for details. diff --git a/doc/lispref/internals.texi b/doc/lispref/internals.texi index 14ebde46b04..3269776b626 100644 --- a/doc/lispref/internals.texi +++ b/doc/lispref/internals.texi @@ -17,6 +17,7 @@ internal aspects of GNU Emacs that may be of interest to C programmers. * Memory Usage:: Info about total size of Lisp objects made so far. * Writing Emacs Primitives:: Writing C code for Emacs. * Object Internals:: Data formats of buffers, windows, processes. +* C Integer Types:: How C integer types are used inside Emacs. @end menu @node Building Emacs @@ -227,12 +228,11 @@ of 8k bytes, and small vectors are packed into blocks of 4k bytes). Beyond the basic vector, a lot of objects like window, buffer, and frame are managed as if they were vectors. The corresponding C data structures include the @code{struct vectorlike_header} field whose -@code{next} field points to the next object in the chain: -@code{header.next.buffer} points to the next buffer (which could be -a killed buffer), and @code{header.next.vector} points to the next -vector in a free list. If a vector is small (smaller than or equal to -@code{VBLOCK_BYTES_MAX} bytes, see @file{alloc.c}), then -@code{header.next.nbytes} contains the vector size in bytes. +@code{size} member contains the subtype enumerated by @code{enum pvec_type} +and an information about how many @code{Lisp_Object} fields this structure +contains and what the size of the rest data is. This information is +needed to calculate the memory footprint of an object, and used +by the vector allocation code while iterating over the vector blocks. @cindex garbage collection It is quite common to use some storage for a while, then release it @@ -285,88 +285,147 @@ the amount of space in use. (Garbage collection can also occur spontaneously if you use more than @code{gc-cons-threshold} bytes of Lisp data since the previous garbage collection.) -@code{garbage-collect} returns a list containing the following -information: +@code{garbage-collect} returns a list with information on amount of space in +use, where each entry has the form @samp{(@var{name} @var{size} @var{used})} +or @samp{(@var{name} @var{size} @var{used} @var{free})}. In the entry, +@var{name} is a symbol describing the kind of objects this entry represents, +@var{size} is the number of bytes used by each one, @var{used} is the number +of those objects that were found live in the heap, and optional @var{free} is +the number of those objects that are not live but that Emacs keeps around for +future allocations. So an overall result is: @example -@group -((@var{used-conses} . @var{free-conses}) - (@var{used-syms} . @var{free-syms}) -@end group - (@var{used-miscs} . @var{free-miscs}) - @var{used-string-chars} - @var{used-vector-slots} - (@var{used-floats} . @var{free-floats}) - (@var{used-intervals} . @var{free-intervals}) - (@var{used-strings} . @var{free-strings})) +((@code{conses} @var{cons-size} @var{used-conses} @var{free-conses}) + (@code{symbols} @var{symbol-size} @var{used-symbols} @var{free-symbols}) + (@code{miscs} @var{misc-size} @var{used-miscs} @var{free-miscs}) + (@code{strings} @var{string-size} @var{used-strings} @var{free-strings}) + (@code{string-bytes} @var{byte-size} @var{used-bytes}) + (@code{vectors} @var{vector-size} @var{used-vectors}) + (@code{vector-slots} @var{slot-size} @var{used-slots} @var{free-slots}) + (@code{floats} @var{float-size} @var{used-floats} @var{free-floats}) + (@code{intervals} @var{interval-size} @var{used-intervals} @var{free-intervals}) + (@code{buffers} @var{buffer-size} @var{used-buffers}) + (@code{heap} @var{unit-size} @var{total-size} @var{free-size})) @end example Here is an example: @example -@group (garbage-collect) - @result{} ((106886 . 13184) (9769 . 0) - (7731 . 4651) 347543 121628 - (31 . 94) (1273 . 168) - (25474 . 3569)) -@end group + @result{} ((conses 16 49126 8058) (symbols 48 14607 0) + (miscs 40 34 56) (strings 32 2942 2607) + (string-bytes 1 78607) (vectors 16 7247) + (vector-slots 8 341609 29474) (floats 8 71 102) + (intervals 56 27 26) (buffers 944 8) + (heap 1024 11715 2678)) @end example -Here is a table explaining each element: +Below is a table explaining each element. Note that last @code{heap} entry +is optional and present only if an underlying @code{malloc} implementation +provides @code{mallinfo} function. @table @var +@item cons-size +Internal size of a cons cell, i.e., @code{sizeof (struct Lisp_Cons)}. + @item used-conses The number of cons cells in use. @item free-conses -The number of cons cells for which space has been obtained from the -operating system, but that are not currently being used. +The number of cons cells for which space has been obtained from +the operating system, but that are not currently being used. -@item used-syms +@item symbol-size +Internal size of a symbol, i.e., @code{sizeof (struct Lisp_Symbol)}. + +@item used-symbols The number of symbols in use. -@item free-syms -The number of symbols for which space has been obtained from the -operating system, but that are not currently being used. +@item free-symbols +The number of symbols for which space has been obtained from +the operating system, but that are not currently being used. + +@item misc-size +Internal size of a miscellaneous entity, i.e., +@code{sizeof (union Lisp_Misc)}, which is a size of the +largest type enumerated in @code{enum Lisp_Misc_Type}. @item used-miscs -The number of miscellaneous objects in use. These include markers and -overlays, plus certain objects not visible to users. +The number of miscellaneous objects in use. These include markers +and overlays, plus certain objects not visible to users. @item free-miscs The number of miscellaneous objects for which space has been obtained from the operating system, but that are not currently being used. -@item used-string-chars -The total size of all strings, in characters. +@item string-size +Internal size of a string header, i.e., @code{sizeof (struct Lisp_String)}. + +@item used-strings +The number of string headers in use. + +@item free-strings +The number of string headers for which space has been obtained +from the operating system, but that are not currently being used. + +@item byte-size +This is used for convenience and equals to @code{sizeof (char)}. + +@item used-bytes +The total size of all string data in bytes. + +@item vector-size +Internal size of a vector header, i.e., @code{sizeof (struct Lisp_Vector)}. + +@item used-vectors +The number of vector headers allocated from the vector blocks. + +@item slot-size +Internal size of a vector slot, always equal to @code{sizeof (Lisp_Object)}. -@item used-vector-slots -The total number of elements of existing vectors. +@item used-slots +The number of slots in all used vectors. + +@item free-slots +The number of free slots in all vector blocks. + +@item float-size +Internal size of a float object, i.e., @code{sizeof (struct Lisp_Float)}. +(Do not confuse it with the native platform @code{float} or @code{double}.) @item used-floats The number of floats in use. @item free-floats -The number of floats for which space has been obtained from the -operating system, but that are not currently being used. +The number of floats for which space has been obtained from +the operating system, but that are not currently being used. + +@item interval-size +Internal size of an interval object, i.e., @code{sizeof (struct interval)}. @item used-intervals -The number of intervals in use. Intervals are an internal -data structure used for representing text properties. +The number of intervals in use. @item free-intervals -The number of intervals for which space has been obtained -from the operating system, but that are not currently being used. +The number of intervals for which space has been obtained from +the operating system, but that are not currently being used. -@item used-strings -The number of strings in use. +@item buffer-size +Internal size of a buffer, i.e., @code{sizeof (struct buffer)}. +(Do not confuse with the value returned by @code{buffer-size} function.) -@item free-strings -The number of string headers for which the space was obtained from the -operating system, but which are currently not in use. (A string -object consists of a header and the storage for the string text -itself; the latter is only allocated when the string is created.) +@item used-buffers +The number of buffer objects in use. This includes killed buffers +invisible to users, i.e., all buffers in @code{all_buffers} list. + +@item unit-size +The unit of heap space measurement, always equal to 1024 bytes. + +@item total-size +Total heap size, in @var{unit-size} units. + +@item free-size +Heap space which is not currently used, in @var{unit-size} units. @end table If there was overflow in pure space (@pxref{Pure Storage}), @@ -389,23 +448,25 @@ careful writing them. @defopt gc-cons-threshold The value of this variable is the number of bytes of storage that must be allocated for Lisp objects after one garbage collection in order to -trigger another garbage collection. A cons cell counts as eight bytes, -a string as one byte per character plus a few bytes of overhead, and so -on; space allocated to the contents of buffers does not count. Note -that the subsequent garbage collection does not happen immediately when -the threshold is exhausted, but only the next time the Lisp evaluator is -called. - -The initial threshold value is 800,000. If you specify a larger -value, garbage collection will happen less often. This reduces the -amount of time spent garbage collecting, but increases total memory use. -You may want to do this when running a program that creates lots of -Lisp data. - -You can make collections more frequent by specifying a smaller value, -down to 10,000. A value less than 10,000 will remain in effect only -until the subsequent garbage collection, at which time -@code{garbage-collect} will set the threshold back to 10,000. +trigger another garbage collection. You can use the result returned by +@code{garbage-collect} to get an information about size of the particular +object type; space allocated to the contents of buffers does not count. +Note that the subsequent garbage collection does not happen immediately +when the threshold is exhausted, but only the next time the Lisp interpreter +is called. + +The initial threshold value is @code{GC_DEFAULT_THRESHOLD}, defined in +@file{alloc.c}. Since it's defined in @code{word_size} units, the value +is 400,000 for the default 32-bit configuration and 800,000 for the 64-bit +one. If you specify a larger value, garbage collection will happen less +often. This reduces the amount of time spent garbage collecting, but +increases total memory use. You may want to do this when running a program +that creates lots of Lisp data. + +You can make collections more frequent by specifying a smaller value, down +to 1/10th of @code{GC_DEFAULT_THRESHOLD}. A value less than this minimum +will remain in effect only until the subsequent garbage collection, at which +time @code{garbage-collect} will set the threshold back to the minimum. @end defopt @defopt gc-cons-percentage @@ -640,7 +701,12 @@ in the file @file{lisp.h}.) If the primitive has no upper limit on the number of Lisp arguments, it must have exactly two C arguments: the first is the number of Lisp arguments, and the second is the address of a block containing their values. These have types -@code{int} and @w{@code{Lisp_Object *}} respectively. +@code{int} and @w{@code{Lisp_Object *}} respectively. Since +@code{Lisp_Object} can hold any Lisp object of any data type, you +can determine the actual data type only at run time; so if you want +a primitive to accept only a certain type of argument, you must check +the type explicitly using a suitable predicate (@pxref{Type Predicates}). +@cindex type checking internals @cindex @code{GCPRO} and @code{UNGCPRO} @cindex protect C variables from garbage collection @@ -821,23 +887,70 @@ knows about it. @section Object Internals @cindex object internals -@c FIXME Is this still true? Does --with-wide-int affect anything? - GNU Emacs Lisp manipulates many different types of data. The actual -data are stored in a heap and the only access that programs have to it -is through pointers. Each pointer is 32 bits wide on 32-bit machines, -and 64 bits wide on 64-bit machines; three of these bits are used for -the tag that identifies the object's type, and the remainder are used -to address the object. - - Because Lisp objects are represented as tagged pointers, it is always -possible to determine the Lisp data type of any object. The C data type -@code{Lisp_Object} can hold any Lisp object of any data type. Ordinary -variables have type @code{Lisp_Object}, which means they can hold any -type of Lisp value; you can determine the actual data type only at run -time. The same is true for function arguments; if you want a function -to accept only a certain type of argument, you must check the type -explicitly using a suitable predicate (@pxref{Type Predicates}). -@cindex type checking internals + Emacs Lisp provides a rich set of the data types. Some of them, like cons +cells, integers and strings, are common to nearly all Lisp dialects. Some +others, like markers and buffers, are quite special and needed to provide +the basic support to write editor commands in Lisp. To implement such +a variety of object types and provide an efficient way to pass objects between +the subsystems of an interpreter, there is a set of C data structures and +a special type to represent the pointers to all of them, which is known as +@dfn{tagged pointer}. + + In C, the tagged pointer is an object of type @code{Lisp_Object}. Any +initialized variable of such a type always holds the value of one of the +following basic data types: integer, symbol, string, cons cell, float, +vectorlike or miscellaneous object. Each of these data types has the +corresponding tag value. All tags are enumerated by @code{enum Lisp_Type} +and placed into a 3-bit bitfield of the @code{Lisp_Object}. The rest of the +bits is the value itself. Integer values are immediate, i.e., directly +represented by those @dfn{value bits}, and all other objects are represented +by the C pointers to a corresponding object allocated from the heap. Width +of the @code{Lisp_Object} is platform- and configuration-dependent: usually +it's equal to the width of an underlying platform pointer (i.e., 32-bit on +a 32-bit machine and 64-bit on a 64-bit one), but also there is a special +configuration where @code{Lisp_Object} is 64-bit but all pointers are 32-bit. +The latter trick was designed to overcome the limited range of values for +Lisp integers on a 32-bit system by using 64-bit @code{long long} type for +@code{Lisp_Object}. + + The following C data structures are defined in @file{lisp.h} to represent +the basic data types beyond integers: + +@table @code +@item struct Lisp_Cons +Cons cell, an object used to construct lists. + +@item struct Lisp_String +String, the basic object to represent a sequence of characters. + +@item struct Lisp_Vector +Array, a fixed-size set of Lisp objects which may be accessed by an index. + +@item struct Lisp_Symbol +Symbol, the unique-named entity commonly used as an identifier. + +@item struct Lisp_Float +Floating point value. + +@item union Lisp_Misc +Miscellaneous kinds of objects which don't fit into any of the above. +@end table + + These types are the first-class citizens of an internal type system. +Since the tag space is limited, all other types are the subtypes of either +@code{Lisp_Vectorlike} or @code{Lisp_Misc}. Vector subtypes are enumerated +by @code{enum pvec_type}, and nearly all complex objects like windows, buffers, +frames, and processes fall into this category. The rest of special types, +including markers and overlays, are enumerated by @code{enum Lisp_Misc_Type} +and form the set of subtypes of @code{Lisp_Misc}. + + Below there is a description of a few subtypes of @code{Lisp_Vectorlike}. +Buffer object represents the text to display and edit. Window is the part +of display structure which shows the buffer or used as a container to +recursively place other windows on the same frame. (Do not confuse Emacs Lisp +window object with the window as an entity managed by the user interface +system like X; in Emacs terminology, the latter is called frame.) Finally, +process object is used to manage the subprocesses. @menu * Buffer Internals:: Components of a buffer structure. @@ -913,12 +1026,8 @@ Some of the fields of @code{struct buffer} are: @table @code @item header -A @code{struct vectorlike_header} structure where @code{header.next} -points to the next buffer, in the chain of all buffers (including -killed buffers). This chain is used only for garbage collection, in -order to collect killed buffers properly. Note that vectors, and most -kinds of objects allocated as vectors, are all on one chain, but -buffers are on a separate chain of their own. +A header of type @code{struct vectorlike_header} is common to all +vectorlike objects. @item own_text A @code{struct buffer_text} structure that ordinarily holds the buffer @@ -929,6 +1038,11 @@ A pointer to the @code{buffer_text} structure for this buffer. In an ordinary buffer, this is the @code{own_text} field above. In an indirect buffer, this is the @code{own_text} field of the base buffer. +@item next +A pointer to the next buffer, in the chain of all buffers, including +killed buffers. This chain is used only for allocation and garbage +collection, in order to collect killed buffers properly. + @item pt @itemx pt_byte The character and byte positions of point in a buffer. @@ -1419,4 +1533,91 @@ Symbol indicating the type of process: @code{real}, @code{network}, @end table +@node C Integer Types +@section C Integer Types +@cindex integer types (C programming language) + +Here are some guidelines for use of integer types in the Emacs C +source code. These guidelines sometimes give competing advice; common +sense is advised. + +@itemize @bullet +@item +Avoid arbitrary limits. For example, avoid @code{int len = strlen +(s);} unless the length of @code{s} is required for other reasons to +fit in @code{int} range. + +@item +Do not assume that signed integer arithmetic wraps around on overflow. +This is no longer true of Emacs porting targets: signed integer +overflow has undefined behavior in practice, and can dump core or +even cause earlier or later code to behave ``illogically''. Unsigned +overflow does wrap around reliably, modulo a power of two. + +@item +Prefer signed types to unsigned, as code gets confusing when signed +and unsigned types are combined. Many other guidelines assume that +types are signed; in the rarer cases where unsigned types are needed, +similar advice may apply to the unsigned counterparts (e.g., +@code{size_t} instead of @code{ptrdiff_t}, or @code{uintptr_t} instead +of @code{intptr_t}). + +@item +Prefer @code{int} for Emacs character codes, in the range 0 ..@: 0x3FFFFF. + +@item +Prefer @code{ptrdiff_t} for sizes, i.e., for integers bounded by the +maximum size of any individual C object or by the maximum number of +elements in any C array. This is part of Emacs's general preference +for signed types. Using @code{ptrdiff_t} limits objects to +@code{PTRDIFF_MAX} bytes, but larger objects would cause trouble +anyway since they would break pointer subtraction, so this does not +impose an arbitrary limit. + +@item +Prefer @code{intptr_t} for internal representations of pointers, or +for integers bounded only by the number of objects that can exist at +any given time or by the total number of bytes that can be allocated. +Currently Emacs sometimes uses other types when @code{intptr_t} would +be better; fixing this is lower priority, as the code works as-is on +Emacs's current porting targets. + +@item +Prefer the Emacs-defined type @code{EMACS_INT} for representing values +converted to or from Emacs Lisp fixnums, as fixnum arithmetic is based +on @code{EMACS_INT}. + +@item +When representing a system value (such as a file size or a count of +seconds since the Epoch), prefer the corresponding system type (e.g., +@code{off_t}, @code{time_t}). Do not assume that a system type is +signed, unless this assumption is known to be safe. For example, +although @code{off_t} is always signed, @code{time_t} need not be. + +@item +Prefer the Emacs-defined type @code{printmax_t} for representing +values that might be any signed integer value that can be printed, +using a @code{printf}-family function. + +@item +Prefer @code{intmax_t} for representing values that might be any +signed integer value. + +@item +In bitfields, prefer @code{unsigned int} or @code{signed int} to +@code{int}, as @code{int} is less portable: it might be signed, and +might not be. Single-bit bit fields are invariably @code{unsigned +int} so that their values are 0 and 1. + +@item +In C, Emacs commonly uses @code{bool}, 1, and 0 for boolean values. +Using @code{bool} for booleans can make programs easier to read and a +bit faster than using @code{int}. Although it is also OK to use +@code{int}, this older style is gradually being phased out. When +using @code{bool}, respect the limitations of the replacement +implementation of @code{bool}, as documented in the source file +@file{lib/stdbool.in.h}, so that Emacs remains portable to pre-C99 +platforms. +@end itemize + @c FIXME Mention src/globals.h somewhere in this file? diff --git a/doc/lispref/intro.texi b/doc/lispref/intro.texi index 948f00d7e5f..803e5229f6e 100644 --- a/doc/lispref/intro.texi +++ b/doc/lispref/intro.texi @@ -1,4 +1,4 @@ -@c -*-coding: iso-latin-1-*- +@c -*-coding: utf-8-*- @c This is part of the GNU Emacs Lisp Reference Manual. @c Copyright (C) 1990-1994, 2001-2013 Free Software Foundation, Inc. @c See the file elisp.texi for copying conditions. @@ -547,7 +547,7 @@ Kirman, Bob Knighten, Frederick M. Korz, Joe Lammens, Glenn M. Lewis, K. Richard Magill, Brian Marick, Roland McGrath, Stefan Monnier, Skip Montanaro, John Gardiner Myers, Thomas A. Peterson, Francesco Potorti, Friedrich Pukelsheim, Arnold D. Robbins, Raul Rockwell, Jason Rumney, -Per Starbäck, Shinichirou Sugou, Kimmo Suominen, Edward Tharp, Bill +Per Starbäck, Shinichirou Sugou, Kimmo Suominen, Edward Tharp, Bill Trost, Rickard Westman, Jean White, Eduard Wiebe, Matthew Wilding, Carl Witty, Dale Worley, Rusty Wright, and David D. Zuhn. diff --git a/doc/lispref/loading.texi b/doc/lispref/loading.texi index 8c2c8498a5c..51a060bc6c6 100644 --- a/doc/lispref/loading.texi +++ b/doc/lispref/loading.texi @@ -729,7 +729,7 @@ file should call @code{provide} at the top level to add the feature to (defun idlwave-complete-filename () "Use the comint stuff to complete a file name." (require 'comint) - (let* ((comint-file-name-chars "~/A-Za-z0-9+@:_.$#%=@{@}\\-") + (let* ((comint-file-name-chars "~/A-Za-z0-9+@@:_.$#%=@{@}\\-") (comint-completion-addsuffix nil) ...) (comint-dynamic-complete-filename))) diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 7093f7fe336..7d42d2591d6 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -2149,11 +2149,6 @@ visible on screen; or @samp{Bottom} or @samp{All}. The status of the subprocess belonging to the current buffer, obtained with @code{process-status}. @xref{Process Information}. -@item %t -Whether the visited file is a text file or a binary file. This is a -meaningful distinction only on certain operating systems (@pxref{MS-DOS -File Types}). - @item %z The mnemonics of keyboard, terminal, and buffer coding systems. diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi index 9ad68be60cb..e462c3b4ce4 100644 --- a/doc/lispref/nonascii.texi +++ b/doc/lispref/nonascii.texi @@ -855,8 +855,6 @@ documented here. for a single file operation. * Explicit Encoding:: Encoding or decoding text without doing I/O. * Terminal I/O Encoding:: Use of encoding for terminal I/O. -* MS-DOS File Types:: How DOS "text" and "binary" files - relate to coding systems. @end menu @node Coding System Basics @@ -1775,62 +1773,6 @@ for encoding terminal output from @var{terminal}. If @code{nil}, that means the currently selected frame's terminal. @end deffn -@node MS-DOS File Types -@subsection MS-DOS File Types -@cindex DOS file types -@cindex MS-DOS file types -@cindex Windows file types -@cindex file types on MS-DOS and Windows -@cindex text files and binary files -@cindex binary files and text files - - On MS-DOS and Microsoft Windows, Emacs guesses the appropriate -end-of-line conversion for a file by looking at the file's name. This -feature classifies files as @dfn{text files} and @dfn{binary files}. By -``binary file'' we mean a file of literal byte values that are not -necessarily meant to be characters; Emacs does no end-of-line conversion -and no character code conversion for them. On the other hand, the bytes -in a text file are intended to represent characters; when you create a -new file whose name implies that it is a text file, Emacs uses DOS -end-of-line conversion. - -@defvar buffer-file-type -This variable, automatically buffer-local in each buffer, records the -file type of the buffer's visited file. When a buffer does not specify -a coding system with @code{buffer-file-coding-system}, this variable is -used to determine which coding system to use when writing the contents -of the buffer. It should be @code{nil} for text, @code{t} for binary. -If it is @code{t}, the coding system is @code{no-conversion}. -Otherwise, @code{undecided-dos} is used. - -Normally this variable is set by visiting a file; it is set to -@code{nil} if the file was visited without any actual conversion. - -Its default value is used to decide how to handle files for which -@code{file-name-buffer-file-type-alist} says nothing about the type: -If the default value is non-@code{nil}, then these files are treated as -binary: the coding system @code{no-conversion} is used. Otherwise, -nothing special is done for them---the coding system is deduced solely -from the file contents, in the usual Emacs fashion. -@end defvar - -@defopt file-name-buffer-file-type-alist -This variable holds an alist for recognizing text and binary files. -Each element has the form (@var{regexp} . @var{type}), where -@var{regexp} is matched against the file name, and @var{type} may be -@code{nil} for text, @code{t} for binary, or a function to call to -compute which. If it is a function, then it is called with a single -argument (the file name) and should return @code{t} or @code{nil}. - -When running on MS-DOS or MS-Windows, Emacs checks this alist to decide -which coding system to use when reading a file. For a text file, -@code{undecided-dos} is used. For a binary file, @code{no-conversion} -is used. - -If no element in this alist matches a given file name, then -the default value of @code{buffer-file-type} says how to treat the file. -@end defopt - @node Input Methods @section Input Methods @cindex input methods diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 6506cdb5da0..b481c330f9f 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi @@ -1157,6 +1157,16 @@ This function returns the effective @acronym{UID} of the user. The value may be a floating point number. @end defun +@defun group-gid +This function returns the effective @acronym{GID} of the Emacs process. +The value may be a floating point number. +@end defun + +@defun group-real-gid +This function returns the real @acronym{GID} of the Emacs process. +The value may be a floating point number. +@end defun + @defun system-users This function returns a list of strings, listing the user names on the system. If Emacs cannot retrieve this information, the return value @@ -2276,13 +2286,19 @@ These arguments should consist of alternating keyword and value pairs. The supported keywords and values are as follows: @table @code +@item :bus @var{bus} +The D-Bus bus. This argument is needed only if a bus other than +@code{:session} shall be used. + @item :title @var{title} The notification title. @item :body @var{text} The notification body text. Depending on the implementation of the notification server, the text could contain HTML markups, like -@samp{"<b>bold text</b>"}, hyperlinks, or images. +@samp{"<b>bold text</b>"}, hyperlinks, or images. Special HTML +characters must be encoded, as @samp{"Contact +<postmaster@@localhost>!"}. @item :app-name @var{name} The name of the application sending the notification. The default is @@ -2317,7 +2333,10 @@ When this keyword is given, the @var{title} string of the actions is interpreted as icon name. @item :category @var{category} -The type of notification this is, a string. +The type of notification this is, a string. See the +@uref{http://developer.gnome.org/notification-spec/#categories, +Desktop Notifications Specification} for a list of standard +categories. @item :desktop-entry @var{filename} This specifies the name of the desktop filename representing the @@ -2420,13 +2439,17 @@ A message window opens on the desktop. Press "I agree" @end example @end defun -@defun notifications-close-notification id +@defun notifications-close-notification id &optional bus This function closes a notification with identifier @var{id}. +@var{bus} can be a string denoting a D-Bus connection, the default is +@code{:session}. @end defun -@defun notifications-get-capabilities -Returns the capabilities of the notification server, a list of strings. -The following capabilities can be expected: +@defun notifications-get-capabilities &optional bus +Returns the capabilities of the notification server, a list of +symbols. @var{bus} can be a string denoting a D-Bus connection, the +default is @code{:session}. The following capabilities can be +expected: @table @code @item :actions @@ -2463,6 +2486,30 @@ Further vendor-specific caps start with @code{:x-vendor}, like @code{:x-gnome-foo-cap}. @end defun +@defun notifications-get-server-information &optional bus +Return information on the notification server, a list of strings. +@var{bus} can be a string denoting a D-Bus connection, the default is +@code{:session}. The returned list is @code{(@var{name} @var{vendor} +@var{version} @var{spec-version})}. + +@table @var +@item name +The product name of the server. + +@item vendor +The vendor name. For example, @samp{"KDE"}, @samp{"GNOME"}. + +@item version +The server's version number. + +@item spec-version +The specification version the server is compliant with. +@end table + +If @var{SPEC_VERSION} is @code{nil}, the server supports a +specification prior to @samp{"1.0"}. +@end defun + @node Dynamic Libraries @section Dynamically Loaded Libraries diff --git a/doc/lispref/symbols.texi b/doc/lispref/symbols.texi index 3e6c8266ef9..82dfa0f4917 100644 --- a/doc/lispref/symbols.texi +++ b/doc/lispref/symbols.texi @@ -539,8 +539,9 @@ deleted from the local value of a hook variable when changing major modes. @xref{Setting Hooks}. @item pure -This property is used internally to mark certain named functions for -byte compiler optimization. Do not set it. +If the value is non-@code{nil}, the named function is considered to be +side-effect free. Calls with constant arguments can be evaluated at +compile time. This may shift run time errors to compile time. @item risky-local-variable If the value is non-@code{nil}, the named variable is considered risky @@ -564,7 +565,7 @@ side-effects, for determining function safety (@pxref{Function Safety}) as well as for byte compiler optimizations. Do not set it. @item variable-documentation -If non-@code{nil}, this specifies the named vaariable's documentation +If non-@code{nil}, this specifies the named variable's documentation string. This is set automatically by @code{defvar} and related functions. @xref{Defining Faces}. @end table diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index c6cbfa5b3f8..6d5a39d887a 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -3008,27 +3008,31 @@ character. @item face @cindex face codes of text @kindex face @r{(text property)} -The @code{face} property controls the appearance of the character, -such as its font and color. @xref{Faces}. The value of the property -can be the following: +The @code{face} property controls the appearance of the character +(@pxref{Faces}). The value of the property can be the following: @itemize @bullet @item A face name (a symbol or string). @item -A property list of face attributes. This has the form (@var{keyword} -@var{value} @dots{}), where each @var{keyword} is a face attribute -name and @var{value} is a meaningful value for that attribute. With -this feature, you do not need to create a face each time you want to -specify a particular attribute for certain text. +An anonymous face: a property list of the form @code{(@var{keyword} +@var{value} @dots{})}, where each @var{keyword} is a face attribute +name and @var{value} is a value for that attribute. @item -A list of faces. This specifies a face which is an aggregate of the +A list of faces. Each list element should be either a face name or an +anonymous face. This specifies a face which is an aggregate of the attributes of each of the listed faces. Faces occurring earlier in -the list have higher priority. Each list element must have one of the -two above forms (i.e., either a face name or a property list of face -attributes). +the list have higher priority. + +@item +A cons cell of the form @code{(foreground-color . @var{color-name})} +or @code{(background-color . @var{color-name})}. This specifies the +foreground or background color, similar to @code{(:foreground +@var{color-name})} or @code{(:background @var{color-name})}. This +form is supported for backward compatibility only, and should be +avoided. @end itemize Font Lock mode (@pxref{Font Lock Mode}) works in most buffers by diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index 4f467f96d71..c40ae408f7f 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi @@ -51,13 +51,15 @@ don't postpone it. @item You should choose a short word to distinguish your program from other -Lisp programs. The names of all global variables, constants, and -functions in your program should begin with that chosen prefix. -Separate the prefix from the rest of the name with a hyphen, @samp{-}. -This practice helps avoid name conflicts, since all global variables -in Emacs Lisp share the same name space, and all functions share -another name space@footnote{The benefits of a Common Lisp-style -package system are considered not to outweigh the costs.}. +Lisp programs. The names of all global symbols in your program, that +is the names of variables, constants, and functions, should begin with +that chosen prefix. Separate the prefix from the rest of the name +with a hyphen, @samp{-}. Use two hyphens if the symbol is not meant +to be used by other packages. This practice helps avoid name +conflicts, since all global variables in Emacs Lisp share the same +name space, and all functions share another name space@footnote{The +benefits of a Common Lisp-style package system are considered not to +outweigh the costs.}. Occasionally, for a command name intended for users to use, it is more convenient if some words come before the package's name prefix. And @@ -942,6 +944,7 @@ explains these conventions, starting with an example: ;; Created: 14 Jul 2010 @group ;; Keywords: languages +;; Homepage: http://example.com/foo ;; This file is not part of GNU Emacs. @@ -980,8 +983,7 @@ the conventional possibilities for @var{header-name}: @item Author This line states the name and email address of at least the principal author of the library. If there are multiple authors, list them on -continuation lines led by @code{;;} and whitespace (this is easier -for tools to parse than having more than one author on one line). +continuation lines led by @code{;;} and a tab or at least two spaces. We recommend including a contact email address, of the form @samp{<@dots{}>}. For example: @@ -1028,6 +1030,9 @@ The name of this field is unfortunate, since people often assume it is the place to write arbitrary keywords that describe their package, rather than just the relevant Finder keywords. +@item Homepage +This line states the homepage of the library. + @item Package-Version If @samp{Version} is not suitable for use by the package manager, then a package can define @samp{Package-Version}; it will be used instead. diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index cca337df4fb..f2a4b3849dd 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi @@ -717,7 +717,7 @@ window. This section describes functions for creating a new window by @dfn{splitting} an existing one. -@deffn Command split-window &optional window size side +@defun split-window &optional window size side This function creates a new live window next to the window @var{window}. If @var{window} is omitted or @code{nil}, it defaults to the selected window. That window is ``split'', and reduced in @@ -767,7 +767,7 @@ called with the arguments @var{window}, @var{size}, and @var{side}, in lieu of the usual action of @code{split-window}. Otherwise, this function obeys the @code{window-atom} or @code{window-side} window parameter, if any. @xref{Window Parameters}. -@end deffn +@end defun As an example, here is a sequence of @code{split-window} calls that yields the window configuration discussed in @ref{Windows and Frames}. @@ -1084,7 +1084,7 @@ including the space earlier stolen from @var{W3}. @end smallexample @noindent -This can be counterintutive, in particular if @var{W4} were used for +This can be counterintuitive, in particular if @var{W4} were used for displaying a buffer only temporarily (@pxref{Temporary Displays}), and you want to continue working with the initial layout. @@ -2443,7 +2443,7 @@ buffer previously shown no longer exists, this function calls @code{switch-to-prev-buffer} (@pxref{Window History}) to show some other buffer instead. -The optional argument @var{bury-or-kill} specifes how to deal with +The optional argument @var{bury-or-kill} specifies how to deal with @var{window}'s buffer. The following values are handled: @table @code diff --git a/doc/man/ChangeLog b/doc/man/ChangeLog index 1898160220b..8b550dc4417 100644 --- a/doc/man/ChangeLog +++ b/doc/man/ChangeLog @@ -1,10 +1,10 @@ -2013-04-10 Petr Hracek <phracek@redhat.com> (tiny change) +2013-04-20 Petr Hracek <phracek@redhat.com> (tiny change) * emacs.1: Add some more command-line options. (Bug#14165) -2013-03-11 Glenn Morris <rgm@gnu.org> +2012-12-02 Kevin Ryde <user42@zip.com.au> - * Version 24.3 released. + * etags.1: Mention effect of --declarations in Lisp. 2012-06-03 Glenn Morris <rgm@gnu.org> diff --git a/doc/man/emacs.1 b/doc/man/emacs.1 index b0f48f0176b..9149be2c523 100644 --- a/doc/man/emacs.1 +++ b/doc/man/emacs.1 @@ -1,5 +1,5 @@ .\" See section COPYING for copyright and redistribution information. -.TH EMACS 1 "2007 April 13" "GNU Emacs 24.3" +.TH EMACS 1 "2007 April 13" "GNU Emacs 24.3.50" . . .SH NAME diff --git a/doc/man/etags.1 b/doc/man/etags.1 index 20be5c82684..5ccf528868b 100644 --- a/doc/man/etags.1 +++ b/doc/man/etags.1 @@ -88,6 +88,7 @@ Only \fBctags\fP accepts this option. .B \-\-declarations In C and derived languages, create tags for function declarations, and create tags for extern variables unless \-\-no\-globals is used. +In Lisp, create tags for (defvar foo) declarations. .TP .B \-D, \-\-no\-defines Do not create tag entries for C preprocessor constant definitions diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 2a62dc852e9..5e9840a86b7 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog @@ -1,6 +1,99 @@ -2013-03-11 Glenn Morris <rgm@gnu.org> +2013-04-16 Michael Albinus <michael.albinus@gmx.de> - * Version 24.3 released. + * tramp.texi (Frequently Asked Questions): Precise, how to define + an own ControlPath. + +2013-04-15 Michael Albinus <michael.albinus@gmx.de> + + * tramp.texi (Frequently Asked Questions): New item for + ControlPath settings. + +2013-03-31 Jay Belanger <jay.p.belanger@gmail.com> + + * calc.texi: (Basic Operations on Units): Streamline some + descriptions. + +2013-03-27 Aidan Gauland <aidalgol@no8wireless.co.nz> + + * eshell.texi (Built-ins): Update manual to mention tramp module. + +2013-03-18 Michael Albinus <michael.albinus@gmx.de> + + * tramp.texi (Filename Syntax): Host names are not allowed to be + any method name, unless method name is specified explicitly. + Remove restriction on unibyte filenames. + + * trampver.texi: Update release number. + +2013-03-17 Paul Eggert <eggert@cs.ucla.edu> + + doc: convert some TeX accents to UTF-8 + * emacs-mime.texi (Interface Functions): Use 'ï' rather than + '@"{@dotless{i}}'. + +2013-03-15 Michael Albinus <michael.albinus@gmx.de> + + Sync with Tramp 2.2.7. + + * trampver.texi: Update release number. + +2013-03-09 Jay Belanger <jay.p.belanger@gmail.com> + + * calc.texi (Basic Operations on Units): Streamline some + descriptions. + +2013-03-08 Glenn Morris <rgm@gnu.org> + + * faq.texi (Top): Don't say this was updated @today. + That's irrelevant and leads to spurious diffs. + +2013-03-08 Jay Belanger <jay.p.belanger@gmail.com> + + * calc.texi (Basic Operations on Units): Fix + cross-reference. + +2013-03-07 Katsumi Yamaoka <yamaoka@jpl.org> + + * gnus-faq.texi (FAQ 3-11): Now Gnus supports POP3 UIDL. + +2013-03-06 Alan Mackenzie <acm@muc.de> + + * cc-mode.texi (Custom Line-Up): Clarify position of point on + calling a line-up function. + +2013-03-04 Paul Eggert <eggert@cs.ucla.edu> + + * emacs-mime.texi, htmlfontify.texi, mairix-el.texi, mh-e.texi: + * ses.texi: Switch from Latin-1 to UTF-8. + +2013-03-03 Michael Albinus <michael.albinus@gmx.de> + + * tramp.texi (External methods): Tramp does not connect Android + devices by itself. + +2013-03-02 Bill Wohler <wohler@newt.com> + + Release MH-E manual version 8.5. + + * mh-e.texi (VERSION, EDITION, UPDATED, UPDATE-MONTH): Update for + release 8.5. + + * mh-e.texi (Preface, Conventions, Getting Started) + (Using This Manual, Folder Selection, Viewing, Aliases) + (Identities, Speedbar, Menu Bar, Tool Bar, Scan Line Formats) + (Bug Reports, Mailing Lists, MH FAQ and Support, Getting MH-E): + Update URLs. + +2013-03-01 Michael Albinus <michael.albinus@gmx.de> + + * tramp.texi (Inline methods): Remove "ssh1", "ssh2", "plink1" + and "plink2" entries. "plink2" is obsolete for a long time. + (External methods): Remove "scp1" and "scp2" entries. Explain + user name and host name specification for "adb". + +2013-02-28 Michael Albinus <michael.albinus@gmx.de> + + * tramp.texi (External methods): Mention `tramp-adb-program'. 2013-02-28 Bastien Guerry <bzg@gnu.org> @@ -9,15 +102,14 @@ visibility settings to be honored in any circumstances. (Progress logging, Checkboxes): Fix typos. -2013-02-25 Michael Albinus <michael.albinus@gmx.de> +2013-02-28 Michael Albinus <michael.albinus@gmx.de> * tramp.texi (top) [xxx, yyy, trampfn]: Provide two versions of the macros, for Texinfo 4.13 and 5.0. 2013-02-24 Michael Albinus <michael.albinus@gmx.de> - Port documentation to Texinfo 5.0. - + Port Tramp documentation to Texinfo 5.0. * tramp.texi (top) [xxx, yyy, trampfn]: Remove superfluous @c. (Filename Syntax): Do not use @trampfn{} in @item. (Filename completion): Use @columnfractions in @multitable. @@ -26,6 +118,34 @@ * flymake.texi (Syntax check statuses): Fix multitable continued rows. +2013-02-21 Paul Eggert <eggert@cs.ucla.edu> + + * Makefile.in (html): New rule. + +2013-02-20 Michael Albinus <michael.albinus@gmx.de> + + * tramp.texi (Android shell setup): Improve. Reported by Thierry + Volpiatto <thierry.volpiatto@gmail.com>. + +2013-02-16 Michael Albinus <michael.albinus@gmx.de> + + * tramp.texi (Top, Configuration): Insert section `Android shell + setup' in menu. + (Android shell setup): New section. + (Connection types, Default Method) + (Frequently Asked Questions): Mention "scp" instead of "scpc". + (External methods): Remove "scpc" and "rsyncc" entries. + (Frequently Asked Questions): Remove entry about ControlPersist. + +2013-02-13 Glenn Morris <rgm@gnu.org> + + * message.texi (News Headers): Don't mention yow any more. + +2013-02-09 Jay Belanger <jay.p.belanger@gmail.com> + + * calc.texi (Basic Operations on Units): + (Customizing Calc): Mention the variable `calc-allow-units-as-numbers'. + 2013-02-08 Aidan Gauland <aidalgol@no8wireless.co.nz> * eshell.texi: Fill most of the missing sections. @@ -37,11 +157,11 @@ (Org-Plot): Fix link. (Checkboxes, Radio lists): Fix typos. -2013-02-06 Glenn Morris <rgm@gnu.org> +2013-02-07 Glenn Morris <rgm@gnu.org> * cl.texi (Equality Predicates): Mention memql. -2013-02-03 Eric Ludlam <zappo@gnu.org> +2013-02-07 Eric Ludlam <zappo@gnu.org> * doc/misc/ede.texi (Creating a project): Make ede-new doc less specific, and only about items it supports, indicating that there @@ -49,14 +169,23 @@ from ede new. (Simple projects): Re-write to not talk about ede-simple-project which is deprecated, and instead use the term to mean projects - that don't do much management, just project wrapping. - Add ede-generic-project link. + that don't do much management, just project wrapping. Add + ede-generic-project link. (ede-generic-project): New node (bug#11441). -2013-02-03 Glenn Morris <rgm@gnu.org> +2013-02-07 Glenn Morris <rgm@gnu.org> * cl.texi (Equality Predicates): Fix eq/eql pedantry. +2013-02-01 Glenn Morris <rgm@gnu.org> + + * calc.texi (Help Commands): Update calc-view-news description. + Mention etc/CALC-NEWS. + +2013-01-24 Michael Albinus <michael.albinus@gmx.de> + + * tramp.texi (Filename Syntax): Filenames must be unibyte strings. + 2013-01-13 Bastien Guerry <bzg@gnu.org> * org.texi (Installation): Simplify. @@ -68,7 +197,11 @@ variable `org-id-link-to-org-use-id'. Mention the need to load the org-id library. -2013-01-08 Bastien Guerry <bzg@gnu.org> +2013-01-10 Michael Albinus <michael.albinus@gmx.de> + + * tramp.texi (Default Host): Introduce `tramp-default-host-alist'. + +2013-01-09 Bastien Guerry <bzg@gnu.org> * org.texi (Pushing to MobileOrg): Add footnote about using symbolic links in `org-directory'. @@ -83,6 +216,11 @@ `org-mark-subtree'. (Tag inheritance): Document `org-agenda-use-tag-inheritance'. +2013-01-08 Juri Linkov <juri@jurta.org> + + * info.texi (Go to node): Mention the abbreviated format + `(FILENAME)' equal to `(FILENAME)Top'. (Bug#13365) + 2013-01-06 Andreas Schwab <schwab@linux-m68k.org> * autotype.texi: Remove undefined command @subtitlefont. @@ -104,7 +242,8 @@ * 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. + * 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. @@ -133,7 +272,12 @@ * htmlfontify.texi: New file. -2012-12-22 Glenn Morris <rgm@gnu.org> +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. @@ -158,14 +302,42 @@ * 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. @@ -188,17 +360,32 @@ * erc.texi: No need to include gpl in this small manual. -2012-12-14 Glenn Morris <rgm@gnu.org> - * org.texi (copying): Include a copy of the GFDL. (GNU Free Documentation License): New section. -2012-12-13 Bastien Guerry <bzg@gnu.org> +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. + (Date Formatting Codes): Mention new codes. + (Standard Date Formats): Mention new formats. + +2012-12-14 Michael Albinus <michael.albinus@gmx.de> + + * tramp.texi (External methods): Move `adb' method here. + 2012-12-13 Glenn Morris <rgm@gnu.org> + * cl.texi (Modify Macros, Obsolete Macros): Now letf == cl-letf. + * wisent.texi: Small edits. Set copyright to FSF, update license to GFDL 1.3+. * Makefile.in (INFO_TARGETS, DVI_TARGETS, PDF_TARGETS): Add wisent. @@ -221,7 +408,7 @@ * bovine.texi, wisent.texi: New files, imported from CEDET trunk. -2012-12-12 Glenn Morris <rgm@gnu.org> +2012-12-13 Glenn Morris <rgm@gnu.org> * flymake.texi (Customizable variables, Locating the buildfile): Remove refs to flymake-buildfile-dirs, removed 2007-07-20. (Bug#13148) @@ -234,11 +421,11 @@ * makefile.w32-in (INFO_TARGETS, DVI_TARGETS, clean): Add srecode. ($(infodir)/srecode$(INFO_EXT), srecode.dvi): New targets. -2012-12-12 Eric Ludlam <zappo@gnu.org> +2012-12-13 Eric Ludlam <zappo@gnu.org> * srecode.texi: New file, imported from CEDET trunk. -2012-12-12 Bastien Guerry <bzg@gnu.org> +2012-12-13 Bastien Guerry <bzg@gnu.org> * org.texi (Summary, Code block specific header arguments) (Code block specific header arguments) @@ -248,47 +435,108 @@ * org.texi (System-wide header arguments) (Header arguments in Org mode properties, Conflicts) - (Dynamic blocks, Using the mapping API): Fix indendation of - Elisp code examples. + (Dynamic blocks, Using the mapping API): + Fix indentation of Elisp code examples. * org.texi (Comment lines): Fix description of the comment syntax. * org.texi (Installation): Mention "make test" in the correct section. -2012-12-02 Michael Albinus <michael.albinus@gmx.de> +2012-12-06 Paul Eggert <eggert@cs.ucla.edu> + + * doclicense.texi, gpl.texi: Update to latest version from FSF. + These are just minor editorial changes. + +2012-12-04 Michael Albinus <michael.albinus@gmx.de> + + * tramp.texi (History): Mention ADB. + (Inline methods): Add `adb' method. + +2012-12-03 Michael Albinus <michael.albinus@gmx.de> * tramp.texi (Top, Obtaining Tramp): Replace CVS by Git. (External methods): Fix typo. -2012-11-30 Glenn Morris <rgm@gnu.org> +2012-12-03 Glenn Morris <rgm@gnu.org> * rcirc.texi (Notices): Fix typo. -2012-11-20 Michael Albinus <michael.albinus@gmx.de> +2012-11-25 Bill Wohler <wohler@newt.com> + + Release MH-E manual version 8.4. + + * mh-e.texi: (VERSION, EDITION, UPDATED, UPDATE-MONTH, Preface): + Update for release 8.4. + + * mh-e.texi (Sequences): Add mh-whitelist-preserves-sequences-flag. + (Junk): Add mh-whitelist-preserves-sequences-flag, + mh-blacklist-msg-hook, mh-whitelist-msg-hook, + mh-folder-blacklisted, mh-folder-whitelisted (closes SF #2945712). + +2012-11-25 Paul Eggert <eggert@cs.ucla.edu> + + * mh-e.texi (Procmail): Fix two @ typos. + +2012-11-24 Paul Eggert <eggert@cs.ucla.edu> + + * doclicense.texi, gpl.texi: Update to latest version from FSF. + These are just minor editorial changes. + +2012-11-23 Jay Belanger <jay.p.belanger@gmail.com> - * trampver.texi: Downgrade version to 2.2.6-24.3, in order to - distinguish from trunk. + * calc.texi (Date Formatting Codes): Mention the new beginning of + the date numbering system. + +2012-11-22 Paul Eggert <eggert@cs.ucla.edu> + + * calc.texi: Fix TeX issues with capitals followed by ".", "?", "!". + (Date Forms): Correct off-by-one error in explanation of + Julian day numbers. Give Gregorian equivalent of its origin. + +2012-11-22 Jay Belanger <jay.p.belanger@gmail.com> + + * doc/misc/calc.texi (Date Forms): Mention the customizable + Gregorian-Julian switch. + (Customizing Calc): Mention the variable `calc-gregorian-switch'. + +2012-11-17 Paul Eggert <eggert@cs.ucla.edu> + + Calc now uses the Gregorian calendar for all dates (Bug#12633). + It also uses January 1, 1 AD as its day number 1. + * calc.texi (Date Forms): Document this. 2012-11-16 Glenn Morris <rgm@gnu.org> * cl.texi (Function Bindings): Clarify that cl-flet is lexical. (Obsolete Macros): Move example here from Function Bindings. -2012-11-13 Glenn Morris <rgm@gnu.org> - * erc.texi: Use @code{nil} rather than just "nil". (Modules): Undocument obsolete "hecomplete". Add "notifications". (Connecting): Add brief section on passwords. (Options): Make a start by adding erc-hide-list, erc-lurker-hide-list. -2012-11-12 Glenn Morris <rgm@gnu.org> +2012-11-13 Glenn Morris <rgm@gnu.org> * flymake.texi (Customizable variables) (Highlighting erroneous lines): Mention flymake-error-bitmap, flymake-warning-bitmap, and flymake-fringe-indicator-position. -2012-11-09 Chong Yidong <cyd@gnu.org> +2012-11-12 Vincent Belaïche <vincentb1@users.sourceforge.net> + + * ses.texi: Doc for ses-rename-cell, ses-repair-cell-reference-all & ses-range. + In all file place SES into @acronym{...}. + (Advanced Features): Add key index and function index for + ses-set-header-row. Add description for function + ses-rename-cell. Add description for function + ses-repair-cell-reference-all. + (Ranges in formulas): Add description for ses-range flags. + +2012-11-12 Paul Eggert <eggert@cs.ucla.edu> + + * texinfo.tex: Merge from gnulib. + +2012-11-10 Chong Yidong <cyd@gnu.org> * url.texi (Introduction): Move url-configuration-directory to Customization node. @@ -299,21 +547,17 @@ Improve docs for url-queue-*. (Supported URL Types): Copyedits. Delete empty subnodes. -2012-11-08 Chong Yidong <cyd@gnu.org> - - * url.texi (Introduction): Rename from Getting Started. - Rewrite the introduction. + * url.texi (Introduction): Rename from Getting Started. Rewrite + the introduction. (URI Parsing): Rewrite. Omit the obsolete attributes slot. -2012-11-07 Glenn Morris <rgm@gnu.org> +2012-11-10 Glenn Morris <rgm@gnu.org> * cl.texi (Obsolete Setf Customization): Revert defsetf example to the more correct let rather than prog1. Give define-modify-macro, defsetf, and define-setf-method gv.el replacements. -2012-11-06 Glenn Morris <rgm@gnu.org> - * cl.texi (Overview): Mention EIEIO here, as well as the appendix. (Setf Extensions): Remove obsolete reference. (Obsolete Setf Customization): @@ -329,11 +573,13 @@ (Compiler Optimizations): Rename from "Optimizing Compiler"; reword. (Creating Symbols, Random Numbers): De-emphasize internal variables cl--gensym-counter and cl--random-state. (Bug#12788) + (Naming Conventions, Type Predicates, Macros) + (Predicates on Numbers): No longer mention cl-floatp-safe. -2012-11-02 Glenn Morris <rgm@gnu.org> +2012-11-02 Katsumi Yamaoka <yamaoka@jpl.org> - * cl.texi (Naming Conventions, Type Predicates, Macros) - (Predicates on Numbers): No longer mention cl-floatp-safe. + * gnus.texi (Mail Source Specifiers): + Document :leave keyword used for pop mail source. 2012-11-01 Glenn Morris <rgm@gnu.org> @@ -402,14 +648,14 @@ 2012-10-26 Bastien Guerry <bzg@gnu.org> - * org.texi (Installation): Update the link to Org's ELPA. - Also don't mention org-install.el anymore as the replacement file + * org.texi (Installation): Update the link to Org's ELPA. Also + don't mention org-install.el anymore as the replacement file org-loaddefs.el is now loaded by org.el. 2012-10-25 Michael Albinus <michael.albinus@gmx.de> - * tramp.texi (Frequently Asked Questions): - Mention `tramp-completion-reread-directory-timeout' for performance + * tramp.texi (Frequently Asked Questions): Mention + `tramp-completion-reread-directory-timeout' for performance improvement. 2012-10-25 Glenn Morris <rgm@gnu.org> @@ -513,7 +759,8 @@ (Imprint): Mention Wolfgang in list of contributors. (Creating Citations): Give a hint about how to auto-revert the BibTeX database file when using external editors. - (Referencing Labels): Simplify section about reference macro cycling. + (Referencing Labels): Simplify section about reference macro + cycling. (Options (Referencing Labels)): Adapt to new structure of `reftex-ref-style-alist'. (Referencing Labels, Reference Styles): Document changes in the @@ -531,8 +778,8 @@ (Referencing Labels): Update regarding reference styles. (Citation Styles): Mention support for ConTeXt. (Options (Defining Label Environments)): Fix typo. - (Options (Creating Citations)): - Document `reftex-cite-key-separator'. + (Options (Creating Citations)): Document + `reftex-cite-key-separator'. 2012-09-30 Achim Gratz <Stromeko@Stromeko.DE> @@ -564,8 +811,8 @@ 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. + * org.texi (Installation, Feedback, Batch execution): Use + (add-to-list 'load-path ... t) for the contrib dir. * org.texi (results): Update documentation for ":results drawer" and ":results org". @@ -582,16 +829,18 @@ * org.texi (History and Acknowledgments): Fix typo. - * org.texi (History and Acknowledgments): Add my own acknowledgments. + * org.texi (History and Acknowledgments): Add my own + acknowledgments. * org.texi (Agenda commands): Document the new command and the new option. * org.texi (Agenda commands): Delete `org-agenda-action' section. - (Agenda commands): Reorder. Document `*' to toggle persistent marks. + (Agenda commands): Reorder. Document `*' to toggle persistent + marks. - * org.texi (Agenda dispatcher): - Mention `org-toggle-agenda-sticky'. + * org.texi (Agenda dispatcher): Mention + `org-toggle-agenda-sticky'. (Agenda commands, Exporting Agenda Views): Fix typo. * org.texi (Templates in contexts, Setting Options): Update to @@ -609,7 +858,8 @@ * org.texi (Formula syntax for Lisp): Reformat. * org.texi (Special properties, Column attributes) - (Agenda column view): Document the new special property CLOCKSUM_T. + (Agenda column view): Document the new special property + CLOCKSUM_T. * org.texi (Template expansion): Document the new %l template. @@ -765,8 +1015,8 @@ (Unsafe Simplifications): Mention `m E'. (Simplification of Units): Mention `m U'. (Trigonometric/Hyperbolic Functions, Reducing and Mapping) - (Kinds of Declarations, Functions for Declarations): - Mention "algebraic simplifications" instead of `a s'. + (Kinds of Declarations, Functions for Declarations): Mention + "algebraic simplifications" instead of `a s'. (Algebraic Entry): Remove mention of default simplifications. 2012-07-30 Jay Belanger <jay.p.belanger@gmail.com> @@ -798,8 +1048,8 @@ 2012-07-06 Michael Albinus <michael.albinus@gmx.de> - * tramp.texi (Multi-hops): - Introduce `tramp-restricted-shell-hosts-alist'. + * tramp.texi (Multi-hops): Introduce + `tramp-restricted-shell-hosts-alist'. 2012-06-26 Lars Magne Ingebrigtsen <larsi@gnus.org> @@ -991,8 +1241,8 @@ (Synchronous Methods): Remove obsolete dbus-call-method-non-blocking. (Asynchronous Methods): Fix description of dbus-call-method-asynchronously. - (Receiving Method Calls): Fix some minor errors. - Add dbus-interface-emacs. + (Receiving Method Calls): Fix some minor errors. Add + dbus-interface-emacs. (Signals): Describe unicast signals and the new match rules. (Alternative Buses): Add the PRIVATE optional argument to dbus-init-bus. Describe its new return value. Add dbus-setenv. @@ -1025,8 +1275,8 @@ 2012-04-09 Eli Zaretskii <eliz@gnu.org> - * makefile.w32-in (INFO_TARGETS, DVI_TARGETS, clean): - Add emacs-gnutls. + * makefile.w32-in (INFO_TARGETS, DVI_TARGETS, clean): Add + emacs-gnutls. ($(infodir)/emacs-gnutls, emacs-gnutls.dvi): New targets. 2012-04-09 Teodor Zlatanov <tzz@lifelogs.com> @@ -1124,11 +1374,12 @@ 2012-04-01 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (MobileOrg): Change the wording to reflect that the - Android Version is no longer just the little brother of the iOS version. + Android Version is no longer just the little brother of the iOS + version. 2012-04-01 Eric Schulte <eric.schulte@gmx.com> - * org.texi (Key bindings and useful functions): Update babel key + * org.texi (Key bindings and useful functions): Updated babel key binding documentation in manual. 2012-04-01 Eric Schulte <eric.schulte@gmx.com> @@ -1229,8 +1480,8 @@ 2012-02-13 Lars Ingebrigtsen <larsi@gnus.org> - * gnus.texi (Customizing the IMAP Connection): - Mention nnimap-record-commands. + * gnus.texi (Customizing the IMAP Connection): Mention + nnimap-record-commands. 2012-02-10 Glenn Morris <rgm@gnu.org> @@ -1278,7 +1529,8 @@ 2012-01-03 Eric Schulte <eric.schulte@gmx.com> * org.texi (Noweb reference syntax): Adding documentation of - the `*org-babel-use-quick-and-dirty-noweb-expansion*' variable. + the `*org-babel-use-quick-and-dirty-noweb-expansion*' + variable. 2012-01-03 Bastien Guerry <bzg@gnu.org> @@ -1300,8 +1552,8 @@ 2012-01-03 Bernt Hansen <bernt@norang.ca> - * org.texi (Agenda commands): - Document `org-clock-report-include-clocking-task'. + * org.texi (Agenda commands): Document + `org-clock-report-include-clocking-task'. 2012-01-03 Bastien Guerry <bzg@gnu.org> @@ -1351,7 +1603,8 @@ 2012-01-03 Thomas Dye <dk@poto.local> - * org.texi: Changed DATA to NAME in Working With Source Code section. + * org.texi: Changed DATA to NAME in Working With Source Code + section. 2012-01-03 Tom Dye <tsd@tsdye.com> @@ -1385,8 +1638,8 @@ 2012-01-03 Eric Schulte <schulte.eric@gmail.com> - * org.texi (Buffer-wide header arguments): - Update documentation to reflect removal of #+PROPERTIES. + * org.texi (Buffer-wide header arguments): Update + documentation to reflect removal of #+PROPERTIES. 2012-01-03 Carsten Dominik <carsten.dominik@gmail.com> @@ -1405,7 +1658,8 @@ 2012-01-03 Tom Dye <tsd@tsdye.com> - * org.texi: Added a line to specify that header arguments are lowercase. + * org.texi: Added a line to specify that header arguments are + lowercase. 2012-01-03 Tom Dye <tsd@tsdye.com> @@ -1418,8 +1672,9 @@ 2012-01-03 David Maus <dmaus@ictsoc.de> - * org.texi (Exporting Agenda Views, Extracting agenda information): - Fix command line syntax, quote symbol parameter values. + * org.texi (Exporting Agenda Views, Extracting agenda + information): Fix command line syntax, quote symbol parameter + values. 2012-01-03 David Maus <dmaus@ictsoc.de> @@ -1545,7 +1800,7 @@ * mh-e.texi (VERSION, EDITION, UPDATED, UPDATE-MONTH): Update for release 8.3. - (Preface): Update support information. + (Preface): Updated support information. (From Bill Wohler): Reset text to original version. As a historical quote, the tense should be correct in the time that it was written. @@ -1585,7 +1840,8 @@ 2011-08-15 Bastien Guerry <bzg@gnu.org> - * org.texi (Languages): Add Lilypond and Awk as supported languages. + * org.texi (Languages): Add Lilypond and Awk as supported + languages. 2011-08-15 Achim Gratz <stromeko@nexgo.de> @@ -1603,7 +1859,8 @@ 2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Results of evaluation): More explicit about the - mechanism through which interactive evaluation of code is performed. + mechanism through which interactive evaluation of code is + performed. 2011-08-15 Eric Schulte <schulte.eric@gmail.com> @@ -1682,11 +1939,13 @@ 2011-08-15 Puneeth Chaganti <punchagan@gmail.com> - * org.texi (Agenda commands): Doc for function option to bulk action. + * org.texi (Agenda commands): Doc for function option to bulk + action. 2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> - * org.texi (Template expansion): Document new %<...> template escape. + * org.texi (Template expansion): Document new %<...> template + escape. 2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> @@ -1706,7 +1965,8 @@ 2011-08-15 Eric Schulte <schulte.eric@gmail.com> - * org.texi (padline): Documentation of the new padline header argument. + * org.texi (padline): Documentation of the new padline header + argument. 2011-08-15 Eric Schulte <schulte.eric@gmail.com> @@ -1727,7 +1987,8 @@ 2011-08-15 Eric Schulte <schulte.eric@gmail.com> - * org.texi (var): Clarification of indexing into tabular variables. + * org.texi (var): Clarification of indexing into tabular + variables. 2011-08-15 Eric Schulte <schulte.eric@gmail.com> @@ -1741,8 +2002,8 @@ 2011-08-15 Bastien Guerry <bzg@gnu.org> - * org.texi (Dynamic blocks, Structure editing): - Mention the function `org-narrow-to-block'. + * org.texi (Dynamic blocks, Structure editing): Mention + the function `org-narrow-to-block'. 2011-08-15 Eric Schulte <schulte.eric@gmail.com> @@ -1769,15 +2030,15 @@ 2011-08-15 Eric Schulte <schulte.eric@gmail.com> - * org.texi (Conflicts): Change "yasnippets" to "yasnippet" and + * org.texi (Conflicts): Changed "yasnippets" to "yasnippet" and added extra whitespace around functions to be consistent with the rest of the section. 2011-08-15 Eric Schulte <schulte.eric@gmail.com> - * org.texi (Evaluating code blocks): Expand discussion of + * org.texi (Evaluating code blocks): Expanded discussion of #+call: line syntax. - (Header arguments in function calls): Expand discussion of + (Header arguments in function calls): Expanded discussion of #+call: line syntax. 2011-08-15 Eric Schulte <schulte.eric@gmail.com> @@ -1807,16 +2068,17 @@ 2011-08-15 Tom Dye <tsd@tsdye.com> - * org.texi (cache): Improve documentation of code block caches. + * org.texi (cache): Improved documentation of code block caches. 2011-08-15 Tom Dye <tsd@tsdye.com> - * org.texi (Code block specific header arguments): - Documentation of multi-line header arguments. + * org.texi (Code block specific header arguments): Documentation + of multi-line header arguments. 2011-08-15 Eric Schulte <schulte.eric@gmail.com> - * org.texi (Code evaluation security): Add example for using a function. + * org.texi (Code evaluation security): Add example for using a + function. 2011-08-15 Eric Schulte <schulte.eric@gmail.com> @@ -1841,7 +2103,8 @@ 2011-07-14 Lars Magne Ingebrigtsen <larsi@gnus.org> * widget.texi (Setting Up the Buffer): Remove mention of the - global keymap parent, which doesn't seem to be accurate (bug#7045). + global keymap parent, which doesn't seem to be accurate + (bug#7045). 2011-07-12 Lars Magne Ingebrigtsen <larsi@gnus.org> @@ -1866,15 +2129,15 @@ 2011-07-04 Michael Albinus <michael.albinus@gmx.de> - * tramp.texi (Cleanup remote connections): - Add `tramp-cleanup-this-connection'. + * tramp.texi (Cleanup remote connections): Add + `tramp-cleanup-this-connection'. 2011-07-03 Lars Magne Ingebrigtsen <larsi@gnus.org> * gnus.texi (Subscription Methods): Link to "Group Levels" to explain zombies. (Checking New Groups): Ditto (bug#8974). - (Checking New Groups): Move the reference to the right place. + (Checking New Groups): Moved the reference to the right place. 2011-07-03 Dave Abrahams <dave@boostpro.com> (tiny change) @@ -1901,8 +2164,8 @@ 2011-06-26 Lars Magne Ingebrigtsen <larsi@gnus.org> - * gnus.texi (Summary Mail Commands): - Document `gnus-summary-reply-to-list-with-original'. + * gnus.texi (Summary Mail Commands): Document + `gnus-summary-reply-to-list-with-original'. 2011-06-20 Stefan Monnier <monnier@iro.umontreal.ca> @@ -1965,7 +2228,7 @@ * gnus.texi (nnmairix caveats, Setup, Registry Article Refer Method) (Fancy splitting to parent, Store arbitrary data): - Update gnus-registry docs. + Updated gnus-registry docs. 2011-04-13 Juanma Barranquero <lekktu@gmail.com> @@ -2037,8 +2300,9 @@ 2011-03-06 Jay Belanger <jay.p.belanger@gmail.com> - * calc.texi (Logarithmic Units): Rename calc-logunits-dblevel and - calc-logunits-nplevel to calc-dblevel and calc-nplevel, respectively. + * calc.texi (Logarithmic Units): Rename calc-logunits-dblevel + and calc-logunits-nplevel to calc-dblevel and calc-nplevel, + respectively. (Musical Notes): New section. (Customizing Calc): Mention the customizable variable calc-note-threshold. @@ -2164,6 +2428,10 @@ dired-add-entry, dired-initial-position, dired-clean-up-after-deletion, dired-read-shell-command, or dired-find-buffer-nocreate. +2013-02-18 Aidan Gauland <aidalgol@no8wireless.co.nz> + + * eshell.texi (Input/Output): Document insert output redirection operator, >>>. + 2011-02-18 Glenn Morris <rgm@gnu.org> * dired-x.texi (Optional Installation File At Point): Simplify. @@ -3081,8 +3349,8 @@ Sync with Tramp 2.1.19. - * tramp.texi (Inline methods, Default Method): - Mention `tramp-inline-compress-start-size'. Remove "kludgy" phrase. + * tramp.texi (Inline methods, Default Method): Mention + `tramp-inline-compress-start-size'. Remove "kludgy" phrase. Remove remark about doubled "-t" argument. (Auto-save and Backup): Remove reference to Emacs 21. (Filename Syntax): Describe port numbers. @@ -5736,7 +6004,7 @@ 2007-10-28 Kevin Greiner <kevin.greiner@compsol.cc> * gnus.texi (nntp-open-via-telnet-and-telnet): Fix grammar. - (Agent Parameters): Update parameter names to match code. + (Agent Parameters): Updated parameter names to match code. (Group Agent Commands): Corrected 'gnus-agent-fetch-series' as 'gnus-agent-summary-fetch-series'. (Agent and flags): New section providing a generalized discussion @@ -6540,7 +6808,7 @@ (Tag searches): Document regular expression search for tags. (Stuck projects): New section. (In-buffer settings): New keywords. - (History and Acknowledgments): Update description. + (History and Acknowledgments): Updated description. 2007-02-24 Alan Mackenzie <acm@muc.de> @@ -6772,7 +7040,7 @@ (Custom agenda views): Section completely rewritten. (Summary): Compare with Planner. (Feedback): More info about creating backtraces. - (Plain lists): Modify example. + (Plain lists): Modified example. (Breaking down tasks): New section. (Custom time format): New section. (Time stamps): Document inactive timestamps. diff --git a/doc/misc/Makefile.in b/doc/misc/Makefile.in index dfe633ca68f..add1b42a545 100644 --- a/doc/misc/Makefile.in +++ b/doc/misc/Makefile.in @@ -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@ @@ -193,6 +192,8 @@ webhack: clean dvi: $(DVI_TARGETS) +html: $(HTML_TARGETS) + pdf: $(PDF_TARGETS) # Note that all the Info targets build the Info files in srcdir. @@ -699,12 +700,12 @@ wisent.pdf: ${srcdir}/wisent.texi ${gfdl} $(ENVADD) $(TEXI2PDF) ${srcdir}/wisent.texi woman : $(buildinfodir)/woman$(INFO_EXT) -$(buildinfodir)/woman$(INFO_EXT): ${srcdir}/woman.texi ${gfdl} +$(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 ${gfdl} +woman.dvi: ${srcdir}/woman.texi $(emacsdir)/emacsver.texi ${gfdl} $(ENVADD) $(TEXI2DVI) ${srcdir}/woman.texi -woman.pdf: ${srcdir}/woman.texi ${gfdl} +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 223911ebb7a..b5a640e13e0 100644 --- a/doc/misc/ada-mode.texi +++ b/doc/misc/ada-mode.texi @@ -37,7 +37,7 @@ modify this GNU manual.'' @contents -@node Top, Overview, (dir), (dir) +@node Top @top Ada Mode @ifnottex @@ -64,7 +64,7 @@ modify this GNU manual.'' @end menu -@node Overview, Installation, Top, Top +@node Overview @chapter Overview The Emacs mode for programming in Ada helps the user in understanding @@ -96,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, @@ -136,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, @@ -175,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 @@ -217,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. @@ -227,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 @@ -245,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 @@ -263,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 @@ -346,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 @@ -366,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 @@ -385,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 @@ -450,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 @@ -461,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 @@ -648,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 @@ -670,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. @@ -836,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 @@ -898,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 @@ -982,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 @@ -1061,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, @@ -1125,7 +1125,7 @@ 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 @@ -1179,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 @@ -1224,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 @@ -1301,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 @@ -1314,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 @@ -1403,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 @@ -1494,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 @@ -1513,11 +1513,11 @@ Uncomment the selected region 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/calc.texi b/doc/misc/calc.texi index ba491a569b7..b2b054ec1ea 100644 --- a/doc/misc/calc.texi +++ b/doc/misc/calc.texi @@ -4460,7 +4460,7 @@ date by one or several months. @xref{Date Arithmetic}, for more. Friday the 13th? @xref{Types Answer 5, 5}. (@bullet{}) (@bullet{}) @strong{Exercise 6.} How many leap years will there be -between now and the year 10001 A.D.? @xref{Types Answer 6, 6}. (@bullet{}) +between now and the year 10001 AD@? @xref{Types Answer 6, 6}. (@bullet{}) @cindex Slope and angle of a line @cindex Angle and slope of a line @@ -8896,7 +8896,7 @@ Note that this rule does not mention @samp{O} at all, so it will apply to any product-of-sum it encounters---this rule may surprise you if you put it into @code{EvalRules}! -In the second rule, the sum of two O's is changed to the smaller O. +In the second rule, the sum of two O's is changed to the smaller O@. The optional constant coefficients are there mostly so that @samp{O(x^2) - O(x^3)} and @samp{O(x^3) - O(x^2)} are handled as well as @samp{O(x^2) + O(x^3)}. @@ -9909,9 +9909,9 @@ listed. @kindex h n The @kbd{h n} or @kbd{h C-n} (@code{calc-view-news}) command displays -the ``news'' or change history of Calc. This is kept in the file -@file{README}, which Calc looks for in the same directory as the Calc -source files. +the ``news'' or change history of Emacs, and jumps to the most recent +portion concerning Calc (if present). For older history, see the file +@file{etc/CALC-NEWS} in the Emacs distribution. @kindex h C-c @kindex h C-d @@ -10986,10 +10986,10 @@ Input is flexible; date forms can be entered in any of the usual notations for dates and times. @xref{Date Formats}. Date forms are stored internally as numbers, specifically the number -of days since midnight on the morning of January 1 of the year 1 AD. +of days since midnight on the morning of December 31 of the year 1 BC@. If the internal number is an integer, the form represents a date only; if the internal number is a fraction or float, the form represents -a date and time. For example, @samp{<6:00am Wed Jan 9, 1991>} +a date and time. For example, @samp{<6:00am Thu Jan 10, 1991>} is represented by the number 726842.25. The standard precision of 12 decimal digits is enough to ensure that a (reasonable) date and time can be stored without roundoff error. @@ -11009,58 +11009,70 @@ You can use the @kbd{v p} (@code{calc-pack}) and @kbd{v u} of a date form. @xref{Packing and Unpacking}. Date forms can go arbitrarily far into the future or past. Negative -year numbers represent years BC@. Calc uses a combination of the -Gregorian and Julian calendars, following the history of Great -Britain and the British colonies. This is the same calendar that -is used by the @code{cal} program in most Unix implementations. +year numbers represent years BC@. There is no ``year 0''; the day +before @samp{<Mon Jan 1, +1>} is @samp{<Sun Dec 31, -1>}. These are +days 1 and 0 respectively in Calc's internal numbering scheme. The +Gregorian calendar is used for all dates, including dates before the +Gregorian calendar was invented (although that can be configured; see +below). Thus Calc's use of the day number @mathit{-10000} to +represent August 15, 28 BC should be taken with a grain of salt. @cindex Julian calendar @cindex Gregorian calendar Some historical background: The Julian calendar was created by -Julius Caesar in the year 46 BC as an attempt to fix the gradual -drift caused by the lack of leap years in the calendar used -until that time. The Julian calendar introduced an extra day in -all years divisible by four. After some initial confusion, the -calendar was adopted around the year we call 8 AD@. Some centuries -later it became apparent that the Julian year of 365.25 days was -itself not quite right. In 1582 Pope Gregory XIII introduced the -Gregorian calendar, which added the new rule that years divisible -by 100, but not by 400, were not to be considered leap years -despite being divisible by four. Many countries delayed adoption -of the Gregorian calendar because of religious differences; -in Britain it was put off until the year 1752, by which time -the Julian calendar had fallen eleven days behind the true -seasons. So the switch to the Gregorian calendar in early -September 1752 introduced a discontinuity: The day after -Sep 2, 1752 is Sep 14, 1752. Calc follows this convention. -To take another example, Russia waited until 1918 before -adopting the new calendar, and thus needed to remove thirteen -days (between Feb 1, 1918 and Feb 14, 1918). This means that -Calc's reckoning will be inconsistent with Russian history between -1752 and 1918, and similarly for various other countries. - -Today's timekeepers introduce an occasional ``leap second'' as -well, but Calc does not take these minor effects into account. -(If it did, it would have to report a non-integer number of days -between, say, @samp{<12:00am Mon Jan 1, 1900>} and +Julius Caesar in the year 46 BC as an attempt to fix the confusion +caused by the irregular Roman calendar that was used before that time. +The Julian calendar introduced an extra day in all years divisible by +four. After some initial confusion, the calendar was adopted around +the year we call 8 AD@. Some centuries later it became +apparent that the Julian year of 365.25 days was itself not quite +right. In 1582 Pope Gregory XIII introduced the Gregorian calendar, +which added the new rule that years divisible by 100, but not by 400, +were not to be considered leap years despite being divisible by four. +Many countries delayed adoption of the Gregorian calendar +because of religious differences. For example, Great Britain and the +British colonies switched to the Gregorian calendar in September +1752, when the Julian calendar was eleven days behind the +Gregorian calendar. That year in Britain, the day after September 2 +was September 14. To take another example, Russia did not adopt the +Gregorian calendar until 1918, and that year in Russia the day after +January 31 was February 14. Calc's reckoning therefore matches English +practice starting in 1752 and Russian practice starting in 1918, but +disagrees with earlier dates in both countries. + +When the Julian calendar was introduced, it had January 1 as the first +day of the year. By the Middle Ages, many European countries +had changed the beginning of a new year to a different date, often to +a religious festival. Almost all countries reverted to using January 1 +as the beginning of the year by the time they adopted the Gregorian +calendar. + +Some calendars attempt to mimic the historical situation by using the +Gregorian calendar for recent dates and the Julian calendar for older +dates. The @code{cal} program in most Unix implementations does this, +for example. While January 1 wasn't always the beginning of a calendar +year, these hybrid calendars still use January 1 as the beginning of +the year even for older dates. The customizable variable +@code{calc-gregorian-switch} (@pxref{Customizing Calc}) can be set to +have Calc's date forms switch from the Julian to Gregorian calendar at +any specified date. + +Today's timekeepers introduce an occasional ``leap second''. +These do not occur regularly and Calc does not take these minor +effects into account. (If it did, it would have to report a +non-integer number of days between, say, +@samp{<12:00am Mon Jan 1, 1900>} and @samp{<12:00am Sat Jan 1, 2000>}.) -Calc uses the Julian calendar for all dates before the year 1752, -including dates BC when the Julian calendar technically had not -yet been invented. Thus the claim that day number @mathit{-10000} is -called ``August 16, 28 BC'' should be taken with a grain of salt. - -Please note that there is no ``year 0''; the day before -@samp{<Sat Jan 1, +1>} is @samp{<Fri Dec 31, -1>}. These are -days 0 and @mathit{-1} respectively in Calc's internal numbering scheme. - @cindex Julian day counting Another day counting system in common use is, confusingly, also called -``Julian.'' The Julian day number is the numbers of days since -12:00 noon (GMT) on Jan 1, 4713 BC, which in Calc's scheme (in GMT) -is @mathit{-1721423.5} (recall that Calc starts at midnight instead -of noon). Thus to convert a Calc date code obtained by unpacking a -date form into a Julian day number, simply add 1721423.5 after +``Julian.'' Julian days go from noon to noon. The Julian day number +is the numbers of days since 12:00 noon (GMT) on November 24, 4714 BC +in the Gregorian calendar (i.e., January 1, 4713 BC in the Julian +calendar). In Calc's scheme (in GMT) the Julian day origin is +@mathit{-1721422.5}, because Calc starts at midnight instead of noon. +Thus to convert a Calc date code obtained by unpacking a +date form into a Julian day number, simply add 1721422.5 after compensating for the time zone difference. The built-in @kbd{t J} command performs this conversion for you. @@ -11092,7 +11104,7 @@ the Julian cycle as an astronomical dating system; this idea was taken up by other astronomers. (At the time, noon was the start of the astronomical day. Herschel originally suggested counting the days since Jan 1, 4713 BC at noon Alexandria time; this was later amended to -noon GMT.) Julian day numbering is largely used in astronomy. +noon GMT@.) Julian day numbering is largely used in astronomy. @cindex Unix time format The Unix operating system measures time as an integer number of @@ -13404,12 +13416,91 @@ dates. @xref{Specifying Operators}. To avoid confusion with nameless functions, your date formats should avoid using the @samp{#} character. @menu +* ISO 8601:: * Date Formatting Codes:: * Free-Form Dates:: * Standard Date Formats:: @end menu -@node Date Formatting Codes, Free-Form Dates, Date Formats, Date Formats +@node ISO 8601, Date Formatting Codes, Date Formats, Date Formats +@subsubsection ISO 8601 + +@noindent +@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 +provides three different but easily distinguishable and unambiguous +ways to represent a date. + +The ISO 8601 calendar date representation is + +@example + @var{YYYY}-@var{MM}-@var{DD} +@end example + +@noindent +where @var{YYYY} is the four digit year, @var{MM} is the two-digit month +number (01 for January to 12 for December), and @var{DD} is the +two-digit day of the month (01 to 31). (Note that @var{YYYY} does not +correspond to Calc's date formatting code, which will be introduced +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. + +The ISO 8601 ordinal date representation is + +@example + @var{YYYY}-@var{DDD} +@end example + +@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. + +The ISO 8601 week date representation is + +@example + @var{YYYY}-W@var{ww}-@var{D} +@end example + +@noindent +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 +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 +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 +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 +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. + +@node Date Formatting Codes, Free-Form Dates, ISO 8601, Date Formats @subsubsection Date Formatting Codes @noindent @@ -13426,7 +13517,7 @@ the time part. The punctuation characters (including spaces) must match exactly; letter fields must correspond to suitable text in the input. If this doesn't work, Calc checks if the input is a simple number; if so, the number is interpreted as a number of days -since Jan 1, 1 AD@. Otherwise, Calc tries a much more relaxed and +since Dec 31, 1 BC@. Otherwise, Calc tries a much more relaxed and flexible algorithm which is described in the next section. Weekday names are ignored during reading. @@ -13450,6 +13541,10 @@ Year: ``91'' for 1991, `` 7'' for 2007, ``+23'' for 23 AD. 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. +@item IYYY +Year: ISO 8601 week-numbering year. @item aa Year: ``ad'' or blank. @item AA @@ -13498,6 +13593,8 @@ Day: ``07'' for 7th day of month. Day: `` 7'' for 7th day of month. @item W Weekday: ``0'' for Sunday, ``6'' for Saturday. +@item w +Weekday: ``1'' for Monday, ``7'' for Sunday. @item WWW Weekday: ``SUN'' for Sunday. @item Www @@ -13508,12 +13605,16 @@ Weekday: ``sun'' for Sunday. Weekday: ``SUNDAY'' for Sunday. @item Wwww Weekday: ``Sunday'' for Sunday. +@item Iww +Week number: ISO 8601 week number, ``W01'' for week 1. @item d Day of year: ``34'' for Feb. 3. @item ddd Day of year: ``034'' for Feb. 3. @item bdd Day of year: `` 34'' for Feb. 3. +@item T +Letter: Literal ``T''. @item h Hour: ``5'' for 5 AM; ``17'' for 5 PM. @item hh @@ -13616,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, @@ -13687,6 +13794,10 @@ command (@pxref{Mode Settings}). @samp{j<, h:mm:ss>} (Julian day plus time) @item 9 @samp{YYddd< hh:mm:ss>} (Year-day format) +@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) @end table @node Truncating the Stack, Justification, Date Formats, Display Modes @@ -27748,18 +27859,14 @@ while typing @kbd{u c au/yr @key{RET}} produces If the units you request are inconsistent with the original units, the number will be converted into your units times whatever ``remainder'' -units are left over. For example, converting @samp{55 mph} into acres +units are left over. (This can be disabled; @pxref{Customizing Calc}.) +For example, converting @samp{55 mph} into acres produces @samp{6.08e-3 acre / m s}. (Recall that multiplication binds more strongly than division in Calc formulas, so the units here are acres per meter-second.) Remainder units are expressed in terms of ``fundamental'' units like @samp{m} and @samp{s}, regardless of the input units. -If you want to disallow using inconsistent units, you can set the customizable variable -@code{calc-ensure-consistent-units} to @code{t} (@pxref{Customizing Calc}). In this case, -if you request units which are inconsistent with the original units, you will be warned about -it and no conversion will occur. - One special exception is that if you specify a single unit name, and a compatible unit appears somewhere in the units expression, then that compatible unit will be converted to the new unit and the @@ -27801,10 +27908,13 @@ Composite units are expanded as if by @kbd{a x}, so that If the value on the stack does not contain any units, @kbd{u c} will prompt first for the old units which this value should be considered -to have, then for the new units. Assuming the old and new units you -give are consistent with each other, the result also will not contain -any units. For example, @kbd{@w{u c} cm @key{RET} in @key{RET}} -converts the number 2 on the stack to 5.08. +to have, then for the new units. (If the value on the stack can be +simplified so that it doesn't contain any units, like @samp{ft/in} can +be simplified to 12, then @kbd{u c} will still prompt for both old +units and new units. Assuming the old and new units you give are +consistent with each other, the result also will not contain any +units. For example, @kbd{@w{u c} cm @key{RET} in @key{RET}} converts +the number 2 on the stack to 5.08. @kindex u b @pindex calc-base-units @@ -35592,6 +35702,20 @@ number of undo steps that will be preserved; if be preserved. The default value of @code{calc-undo-length} is @expr{100}. @end defvar +@defvar calc-gregorian-switch +See @ref{Date Forms}.@* +The variable @code{calc-gregorian-switch} is either a list of integers +@code{(@var{YEAR} @var{MONTH} @var{DAY})} or @code{nil}. +If it is @code{nil}, then Calc's date forms always represent Gregorian dates. +Otherwise, @code{calc-gregorian-switch} represents the date that the +calendar switches from Julian dates to Gregorian dates; +@code{(@var{YEAR} @var{MONTH} @var{DAY})} will be the first Gregorian +date. The customization buffer will offer several standard dates to +choose from, or the user can enter their own date. + +The default value of @code{calc-gregorian-switch} is @code{nil}. +@end defvar + @node Reporting Bugs, Summary, Customizing Calc, Top @appendix Reporting Bugs diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi index bb6a5b001ad..4fa4e12cf88 100644 --- a/doc/misc/cc-mode.texi +++ b/doc/misc/cc-mode.texi @@ -6475,13 +6475,14 @@ think is generally useful, you're very welcome to contribute it; please contact @email{bug-cc-mode@@gnu.org}. Line-up functions are passed a single argument, the syntactic -element (see below). The return value is a @code{c-offsets-alist} -offset specification: for example, an integer, a symbol such as -@code{+}, a vector, @code{nil}@footnote{Returning @code{nil} is useful -when the offset specification for a syntactic element is a list -containing the line-up function (@pxref{c-offsets-alist}).}, or even -another line-up function. Full details of these are in -@ref{c-offsets-alist}. +element (see below). At the time of the call, point will be somewhere +on the line being indented. The return value is a +@code{c-offsets-alist} offset specification: for example, an integer, +a symbol such as @code{+}, a vector, @code{nil}@footnote{Returning +@code{nil} is useful when the offset specification for a syntactic +element is a list containing the line-up function +(@pxref{c-offsets-alist}).}, or even another line-up function. Full +details of these are in @ref{c-offsets-alist}. Line-up functions must not move point or change the content of the buffer (except temporarily). They are however allowed to do diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi index a16dc92de77..83df411cb23 100644 --- a/doc/misc/cl.texi +++ b/doc/misc/cl.texi @@ -703,14 +703,6 @@ The type symbol @code{real} is a synonym for @code{number}, and The type symbols @code{character} and @code{string-char} match integers in the range from 0 to 255. -@c No longer relevant, so covered by first item above (float -> floatp). -@ignore -@item -The type symbol @code{float} uses the @code{cl-floatp-safe} predicate -defined by this package rather than @code{floatp}, so it will work -correctly even in Emacs versions without floating-point support. -@end ignore - @item The type list @code{(integer @var{low} @var{high})} represents all integers between @var{low} and @var{high}, inclusive. Either bound @@ -1200,9 +1192,6 @@ The only exceptions are plain variables and calls to bound on entry, it is simply made unbound by @code{makunbound} or @code{fmakunbound} on exit. @end ignore - -Note that the @file{cl.el} version of this macro behaves slightly -differently. @xref{Obsolete Macros}. @end defmac @defmac cl-letf* (bindings@dots{}) forms@dots{} @@ -2924,14 +2913,6 @@ This predicate tests whether @var{integer} is even. It is an error if the argument is not an integer. @end defun -@ignore -@defun cl-floatp-safe object -This predicate tests whether @var{object} is a floating-point -number. On systems that support floating-point, this is equivalent -to @code{floatp}. On other systems, this always returns @code{nil}. -@end defun -@end ignore - @node Numerical Functions @section Numerical Functions @@ -4888,13 +4869,6 @@ form (@pxref{Obsolete Lexical Binding}), rather than the true lexical binding that @code{cl-labels} uses. @end defmac -@defmac letf (bindings@dots{}) forms@dots{} -This macro is almost exactly the same as @code{cl-letf}, which -replaces it (@pxref{Modify Macros}). The only difference is in -details that relate to some deprecated usage of @code{symbol-function} -in place forms. -@end defmac - @node Obsolete Setf Customization @appendixsec Obsolete Ways to Customize Setf diff --git a/doc/misc/doclicense.texi b/doc/misc/doclicense.texi index a511ffcd5a8..9c3bbe56e91 100644 --- a/doc/misc/doclicense.texi +++ b/doc/misc/doclicense.texi @@ -1,4 +1,3 @@ -@c -*-texinfo-*- @c The GNU Free Documentation License. @center Version 1.3, 3 November 2008 @@ -6,7 +5,7 @@ @c hence no sectioning command or @node. @display -Copyright @copyright{} 2000, 2001, 2002, 2007, 2008, 2009 Free Software Foundation, Inc. +Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. @uref{http://fsf.org/} Everyone is permitted to copy and distribute verbatim copies @@ -93,16 +92,16 @@ An image format is not Transparent if used for any substantial amount of text. A copy that is not ``Transparent'' is called ``Opaque''. Examples of suitable formats for Transparent copies include plain -@sc{ascii} without markup, Texinfo input format, La@TeX{} input -format, @acronym{SGML} or @acronym{XML} using a publicly available -@acronym{DTD}, and standard-conforming simple @acronym{HTML}, -PostScript or @acronym{PDF} designed for human modification. Examples -of transparent image formats include @acronym{PNG}, @acronym{XCF} and -@acronym{JPG}. Opaque formats include proprietary formats that can be -read and edited only by proprietary word processors, @acronym{SGML} or -@acronym{XML} for which the @acronym{DTD} and/or processing tools are -not generally available, and the machine-generated @acronym{HTML}, -PostScript or @acronym{PDF} produced by some word processors for +ASCII without markup, Texinfo input format, La@TeX{} input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG@. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for output purposes only. The ``Title Page'' means, for a printed book, the title page itself, @@ -482,7 +481,7 @@ license notices just after the title page: @end smallexample If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the ``with@dots{}Texts.'' line with this: +replace the ``with@dots{}Texts.''@: line with this: @smallexample @group @@ -501,7 +500,6 @@ recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software. - @c Local Variables: @c ispell-local-pdict: "ispell-dict" @c End: diff --git a/doc/misc/ebrowse.texi b/doc/misc/ebrowse.texi index 471ba822b8e..c7f3e3b1a61 100644 --- a/doc/misc/ebrowse.texi +++ b/doc/misc/ebrowse.texi @@ -44,7 +44,7 @@ modify this GNU manual.'' @contents @ifnottex -@node Top, Overview, (dir), (dir) +@node Top @top Ebrowse You can browse C++ class hierarchies from within Emacs by using @@ -67,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 @@ -177,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 @@ -225,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 @@ -266,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 @@ -301,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 @@ -321,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 @@ -374,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 @@ -395,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 @@ -436,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 @@ -468,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 @@ -497,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*} @@ -561,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 @@ -589,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 @@ -602,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 @@ -633,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 @@ -673,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 @@ -689,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 @@ -705,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 @@ -725,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 @@ -741,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 @@ -783,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 @@ -834,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 @@ -881,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 @@ -919,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 @@ -935,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 @@ -965,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 @@ -984,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 @@ -1029,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 @@ -1086,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 @@ -1121,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 @@ -1140,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 @@ -1173,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 @@ -1186,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 @@ -1202,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 @@ -1218,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 @@ -1234,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 @@ -1254,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 @@ -1314,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 @@ -1351,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 @@ -1389,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 @@ -1403,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 @@ -1421,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 @@ -1432,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 @@ -1440,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/ediff.texi b/doc/misc/ediff.texi index edb2a446cf5..378eee08c51 100644 --- a/doc/misc/ediff.texi +++ b/doc/misc/ediff.texi @@ -61,7 +61,7 @@ modify this GNU manual.'' @contents -@node Top, Introduction, (dir), (dir) +@node Top @top Ediff @insertcopying @@ -79,7 +79,7 @@ modify this GNU manual.'' * Index:: @end menu -@node Introduction, Major Entry Points, Top, Top +@node Introduction @chapter Introduction @cindex Comparing files and buffers @@ -127,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 @@ -397,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 @@ -430,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 @@ -911,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, @@ -977,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 @@ -1008,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 @@ -1127,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 @@ -1150,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 @@ -1186,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: @@ -1332,7 +1332,7 @@ map that controls key bindings in the meta buffer. Since 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 @@ -1356,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 @@ -1493,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 @@ -1608,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 @@ -1735,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 @@ -1767,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 @@ -1839,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 @@ -1948,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 @@ -2152,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 @@ -2197,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} @@ -2216,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: @@ -2333,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 @@ -2402,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 @@ -2520,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/emacs-mime.texi b/doc/misc/emacs-mime.texi index b1cf40aa645..cbb78af9d59 100644 --- a/doc/misc/emacs-mime.texi +++ b/doc/misc/emacs-mime.texi @@ -26,8 +26,8 @@ modify this GNU manual.'' @end quotation @end copying -@c Node ``Interface Functions'' uses Latin-1 characters -@documentencoding ISO-8859-1 +@c Node ``Interface Functions'' uses non-ASCII characters +@documentencoding UTF-8 @dircategory Emacs lisp libraries @direntry @@ -1221,7 +1221,7 @@ Return the value of the field under point. @item mail-encode-encoded-word-region @findex mail-encode-encoded-word-region Encode the non-@acronym{ASCII} words in the region. For instance, -@samp{Na@"{@dotless{i}}ve} is encoded as @samp{=?iso-8859-1?q?Na=EFve?=}. +@samp{Naïve} is encoded as @samp{=?iso-8859-1?q?Na=EFve?=}. @item mail-encode-encoded-word-buffer @findex mail-encode-encoded-word-buffer @@ -1234,7 +1234,7 @@ Encode the words that need encoding in a string, and return the result. @example (mail-encode-encoded-word-string - "This is na@"{@dotless{i}}ve, baby") + "This is naïve, baby") @result{} "This is =?iso-8859-1?q?na=EFve,?= baby" @end example @@ -1249,7 +1249,7 @@ Decode the encoded words in the string and return the result. @example (mail-decode-encoded-word-string "This is =?iso-8859-1?q?na=EFve,?= baby") -@result{} "This is na@"{@dotless{i}}ve, baby" +@result{} "This is naïve, baby" @end example @end table @@ -1890,5 +1890,5 @@ Documentation of the text/plain format parameter for flowed text. @c Local Variables: @c mode: texinfo -@c coding: iso-8859-1 +@c coding: utf-8 @c End: diff --git a/doc/misc/erc.texi b/doc/misc/erc.texi index beb8d545586..cc61cd1ab5b 100644 --- a/doc/misc/erc.texi +++ b/doc/misc/erc.texi @@ -747,7 +747,7 @@ If non, @code{nil}, this is a list of IRC message types to hide, e.g.: @defopt erc-lurker-hide-list Like @code{erc-hide-list}, but only applies to messages sent by lurkers. The function @code{erc-lurker-p} determines whether a given -nickname is considerd a lurker. +nickname is considered a lurker. @end defopt diff --git a/doc/misc/ert.texi b/doc/misc/ert.texi index 1d3a8b0818f..8728d53ea27 100644 --- a/doc/misc/ert.texi +++ b/doc/misc/ert.texi @@ -25,7 +25,7 @@ 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 @@ -86,7 +86,7 @@ Appendix @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, @@ -154,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 @@ -172,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 @@ -251,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 @@ -275,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 @@ -314,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 @@ -334,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 @@ -398,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 @@ -451,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 @@ -506,7 +506,7 @@ 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 @@ -587,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 @@ -600,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: @@ -667,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 @@ -712,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. @@ -723,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 @@ -741,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} @@ -757,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, GNU Free Documentation License , Extending ERT, Top +@node Other Testing Concepts @chapter Other Testing Concepts For information on mocks, stubs, fixtures, or test suites, see below. @@ -768,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 @@ -781,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 @@ -840,7 +840,7 @@ 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, , Other Testing Concepts, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi diff --git a/doc/misc/eshell.texi b/doc/misc/eshell.texi index d24cdc216b5..dca95da2d10 100644 --- a/doc/misc/eshell.texi +++ b/doc/misc/eshell.texi @@ -58,7 +58,7 @@ modify this GNU manual.'' @c ================================================================ @ifnottex -@node Top, What is Eshell?, (dir), (dir) +@node Top @top Eshell Eshell is a shell-like command interpreter @@ -460,8 +460,9 @@ With @samp{cd -42}, you can access the directory stack by number. @cmindex su @itemx sudo @cmindex sudo -Uses TRAMP's @command{su} or @command{sudo} method to run a command via -@command{su} or @command{sudo}. +Uses TRAMP's @command{su} or @command{sudo} method @pxref{Inline methods, , , tramp} +to run a command via @command{su} or @command{sudo}. These commands +are in the eshell-tramp module, which is disabled by default. @end table @@ -709,11 +710,17 @@ which commands need to be run in a terminal, add them to the list @var{eshell-visual-commands}. Redirection is mostly the same in Eshell as it is in other command -shells. The output redirection operators @code{>} and @code{>>} as well -as pipes are supported, but there is not yet any support for input -redirection. Output can also be redirected to Elisp functions, using +shells. The output redirection operators @code{>} and @code{>>} as +well as pipes are supported, but there is not yet any support for +input redirection. Output can also be redirected to buffers, using +the @code{>>>} redirection operator, and Elisp functions, using virtual devices. +The buffer redirection operator, @code{>>>}, expects a buffer object +on the right-hand side, into which it inserts the output of the +left-hand side. e.g., @samp{echo hello >>> #<buffer *scratch*>} +inserts the string @code{"hello"} into the @code{*scratch*} buffer. + @var{eshell-virtual-targets} is a list of mappings of virtual device names to functions. Eshell comes with two virtual devices: @file{/dev/kill}, which sends the text to the kill ring, and @@ -725,8 +732,9 @@ by adding a list of the form @code{("/dev/name" function mode)} to @code{function} may be either a lambda or a function name. If @code{mode} is nil, then the function is the output function; if it is non-nil, then the function is passed the redirection mode as a -symbol--@code{overwrite}, @code{append}, or @code{insert}--and the -function is expected to return the output function. +symbol--@code{overwrite} for @code{>}, @code{append} for @code{>>}, or +@code{insert} for @code{>>>}--and the function is expected to return +the output function. The output function is called once on each line of output until @code{nil} is passed, indicating end of output. diff --git a/doc/misc/eudc.texi b/doc/misc/eudc.texi index 03438eab58d..5b06cc7f11a 100644 --- a/doc/misc/eudc.texi +++ b/doc/misc/eudc.texi @@ -48,9 +48,8 @@ modify this GNU manual.'' @contents @ifnottex -@node Top, Overview, (dir), (dir) +@node Top @top Emacs Unified Directory Client -@comment node-name, next, previous, up @insertcopying @end ifnottex @@ -69,8 +68,7 @@ modify this GNU manual.'' -@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 @@ -115,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 @@ -142,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 @@ -164,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 @@ -187,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: @@ -218,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. @@ -228,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 @@ -248,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 @@ -263,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 @@ -302,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 @@ -326,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 @@ -381,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 @@ -436,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 @@ -514,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 @@ -615,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 @@ -654,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 @@ -691,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 @@ -723,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 @@ -839,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 @@ -852,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 @@ -930,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 @@ -940,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 39b4a9037bd..18e3340a474 100644 --- a/doc/misc/faq.texi +++ b/doc/misc/faq.texi @@ -58,8 +58,7 @@ distribution.] @node Top, FAQ notation, (dir), (dir) @top The GNU Emacs FAQ -@c FIXME @today is just the day we ran `makeinfo'. -This is the GNU Emacs FAQ, last updated on @today{}. +This is the GNU Emacs FAQ. This FAQ is maintained as a part of GNU Emacs. If you find any errors, or have any suggestions, please use @kbd{M-x report-emacs-bug} to report diff --git a/doc/misc/gnus-coding.texi b/doc/misc/gnus-coding.texi index 15393ad8032..4e5855627b8 100644 --- a/doc/misc/gnus-coding.texi +++ b/doc/misc/gnus-coding.texi @@ -387,5 +387,5 @@ changed. @c Local Variables: @c mode: texinfo -@c coding: iso-8859-1 +@c coding: utf-8 @c End: diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi index ede957a5c35..cb900626670 100644 --- a/doc/misc/gnus-faq.texi +++ b/doc/misc/gnus-faq.texi @@ -705,32 +705,9 @@ retrieves via POP3? @subsubheading Answer -First of all, that's not the way POP3 is intended to work, -if you have the possibility, you should use the IMAP -Protocol if you want your messages to stay on the -server. Nevertheless there might be situations where you -need the feature, but sadly Gnus itself has no predefined -functionality to do so. - -However this is Gnus county so there are possibilities to -achieve what you want. The easiest way is to get an external -program which retrieves copies of the mail and stores them -on disk, so Gnus can read it from there. On Unix systems you -could use, e.g., fetchmail for this, on MS Windows you can use -Hamster, an excellent local news and mail server. - -The other solution would be, to replace the method Gnus -uses to get mail from POP3 servers by one which is capable -of leaving the mail on the server. If you use XEmacs, get -the package mail-lib, it includes an enhanced pop3.el, -look in the file, there's documentation on how to tell -Gnus to use it and not to delete the retrieved mail. For -GNU Emacs look for the file epop3.el which can do the same -(If you know the home of this file, please send me an -e-mail). You can also tell Gnus to use an external program -(e.g., fetchmail) to fetch your mail, see the info node -"Mail Source Specifiers" in the Gnus manual on how to do -it. +Yes, if the POP3 server supports the UIDL control (maybe almost servers +do it nowadays). To do that, add a @code{:leave VALUE} pair to each +POP3 mail source. See @pxref{Mail Source Specifiers} for VALUE. @node FAQ 4 - Reading messages @subsection Reading messages diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index b70c31b28fa..983887d721d 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi @@ -1579,6 +1579,10 @@ times you start Gnus. @vindex gnus-before-startup-hook A hook called as the first thing when Gnus is started. +@item gnus-before-resume-hook +@vindex gnus-before-resume-hook +A hook called as the first thing when Gnus is resumed after a suspend. + @item gnus-startup-hook @vindex gnus-startup-hook A hook run as the very last thing after starting up Gnus @@ -3641,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 @@ -14195,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 @@ -14759,20 +14776,37 @@ This can be either the symbol @code{password} or the symbol @code{apop} and says what authentication scheme to use. The default is @code{password}. +@item :leave +Non-@code{nil} if the mail is to be left on the @acronym{POP} server +after fetching. Mails once fetched will never be fetched again by the +@acronym{UIDL} control. Only the built-in @code{pop3-movemail} program +(the default) supports this keyword. + +If this is neither @code{nil} nor a number, all mails will be left on +the server. If this is a number, leave mails on the server for this +many days since you first checked new mails. If this is @code{nil} +(the default), mails will be deleted on the server right after fetching. + +@vindex pop3-uidl-file +The @code{pop3-uidl-file} variable specifies the file to which the +@acronym{UIDL} data are locally stored. The default value is +@file{~/.pop3-uidl}. + +Note that @acronym{POP} servers maintain no state information between +sessions, so what the client believes is there and what is actually +there may not match up. If they do not, then you may get duplicate +mails or the whole thing can fall apart and leave you with a corrupt +mailbox. + @end table -@vindex pop3-movemail +@findex pop3-movemail @vindex pop3-leave-mail-on-server If the @code{:program} and @code{:function} keywords aren't specified, -@code{pop3-movemail} will be used. If @code{pop3-leave-mail-on-server} -is non-@code{nil} the mail is to be left on the @acronym{POP} server -after fetching when using @code{pop3-movemail}. Note that POP servers -maintain no state information between sessions, so what the client -believes is there and what is actually there may not match up. If they -do not, then you may get duplicate mails or the whole thing can fall -apart and leave you with a corrupt mailbox. +@code{pop3-movemail} will be used. Here are some examples for getting mail from a @acronym{POP} server. + Fetch from the default @acronym{POP} server, using the default user name, and default fetcher: @@ -14787,6 +14821,14 @@ Fetch from a named server with a named user and password: :user "user-name" :password "secret") @end lisp +Leave mails on the server for 14 days: + +@lisp +(pop :server "my.pop.server" + :user "user-name" :password "secret" + :leave 14) +@end lisp + Use @samp{movemail} to move the mail: @lisp diff --git a/doc/misc/gpl.texi b/doc/misc/gpl.texi index 1908d1f8f98..0e2e212acb1 100644 --- a/doc/misc/gpl.texi +++ b/doc/misc/gpl.texi @@ -2,7 +2,7 @@ @center Version 3, 29 June 2007 @c This file is intended to be included within another document, -@c hence no sectioning command or @node. +@c hence no sectioning command or @node. @display Copyright @copyright{} 2007 Free Software Foundation, Inc. @url{http://fsf.org/} @@ -222,7 +222,7 @@ terms of section 4, provided that you also meet all of these conditions: @enumerate a -@item +@item The work must carry prominent notices stating that you modified it, and giving a relevant date. @@ -623,12 +623,12 @@ later version. @item Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +APPLICABLE LAW@. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND -PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +A PARTICULAR PURPOSE@. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU@. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. @@ -670,7 +670,7 @@ state the exclusion of warranty; and each file should have at least the ``copyright'' line and a pointer to where the full notice is found. @smallexample -@var{one line to give the program's name and a brief idea of what it does.} +@var{one line to give the program's name and a brief idea of what it does.} Copyright (C) @var{year} @var{name of author} This program is free software: you can redistribute it and/or modify @@ -680,7 +680,7 @@ your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License @@ -693,7 +693,7 @@ If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: @smallexample -@var{program} Copyright (C) @var{year} @var{name of author} +@var{program} Copyright (C) @var{year} @var{name of author} This program comes with ABSOLUTELY NO WARRANTY; for details type @samp{show w}. This is free software, and you are welcome to redistribute it under certain conditions; type @samp{show c} for details. diff --git a/doc/misc/htmlfontify.texi b/doc/misc/htmlfontify.texi index 6cb8942bf15..e45234872e2 100644 --- a/doc/misc/htmlfontify.texi +++ b/doc/misc/htmlfontify.texi @@ -123,8 +123,8 @@ reproduces the look of the current Emacs buffer as closely as possible. 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. +You should, however, note that random control or non-ASCII 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 diff --git a/doc/misc/idlwave.texi b/doc/misc/idlwave.texi index 0c817adcb36..a432d4dc14a 100644 --- a/doc/misc/idlwave.texi +++ b/doc/misc/idlwave.texi @@ -55,7 +55,7 @@ modify this GNU manual.'' @contents @ifnottex -@node Top, Introduction, (dir), (dir) +@node Top @top IDLWAVE IDLWAVE is a package which supports editing source code written in the @@ -165,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) @@ -271,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 @@ -365,7 +365,7 @@ 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 @@ -377,7 +377,7 @@ at point. * 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 @@ -551,7 +551,7 @@ 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, @@ -661,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 @@ -721,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} @@ -745,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 @@ -773,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 @@ -813,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 @@ -887,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 @@ -924,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 @@ -1000,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 @@ -1028,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 @@ -1058,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 @@ -1236,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 @@ -1343,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 @@ -1422,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 @@ -1509,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 @@ -1617,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 @@ -1654,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 @@ -1717,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 @@ -1730,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 @@ -1776,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 @@ -1818,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 @@ -1844,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 @@ -1865,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 @@ -1887,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 @@ -2073,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 @@ -2121,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 @@ -2154,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 @@ -2203,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 @@ -2245,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 @@ -2289,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 @@ -2339,7 +2339,7 @@ IDL program: @end multitable -@node Misc Options, , Motion Commands, The IDLWAVE Major Mode +@node Misc Options @section Miscellaneous Options @cindex Hooks @@ -2360,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} @@ -2389,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 @@ -2499,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 @@ -2626,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 @@ -2667,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 @@ -2705,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 @@ -2725,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 @@ -2771,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 @@ -2903,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 @@ -2936,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 @@ -2958,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*} @@ -3095,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 @@ -3202,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 @@ -3272,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 @@ -3351,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 @@ -3368,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} @@ -3404,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 @@ -3491,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 @@ -3553,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 @@ -3617,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 @@ -3690,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 @@ -3750,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} @@ -3783,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 @@ -3858,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 @@ -4021,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 @@ -4079,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 @@ -4285,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 70dfffde393..d17a65571f1 100644 --- a/doc/misc/info.texi +++ b/doc/misc/info.texi @@ -1079,7 +1079,8 @@ partial node name. node name by putting it at the front, in parentheses. Thus, @kbd{g(dir)Top@key{RET}} would go to the Info Directory node, which is the node @samp{Top} in the Info file @file{dir}. Likewise, -@kbd{g(emacs)Top@key{RET}} goes to the top node of the Emacs manual. +@kbd{g(emacs)Top@key{RET}} (or just @kbd{g(emacs)@key{RET}}) goes to the +top node of the Emacs manual. The node name @samp{*} specifies the whole file. So you can look at all of the current file by typing @kbd{g*@key{RET}} or all of any diff --git a/doc/misc/mairix-el.texi b/doc/misc/mairix-el.texi index ff5b2ca6748..73a1294d28d 100644 --- a/doc/misc/mairix-el.texi +++ b/doc/misc/mairix-el.texi @@ -3,7 +3,7 @@ @setfilename ../../info/mairix-el @settitle Emacs Interface for Mairix -@documentencoding ISO-8859-1 +@documentencoding UTF-8 @copying Copyright @copyright{} 2008--2013 Free Software Foundation, Inc. diff --git a/doc/misc/makefile.w32-in b/doc/misc/makefile.w32-in index b0ea0ed1518..11c76dcfcf7 100644 --- a/doc/misc/makefile.w32-in +++ b/doc/misc/makefile.w32-in @@ -259,9 +259,9 @@ $(infodir)/ebrowse$(INFO_EXT): ebrowse.texi ebrowse.dvi: ebrowse.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/ebrowse.texi -$(infodir)/woman$(INFO_EXT): woman.texi +$(infodir)/woman$(INFO_EXT): woman.texi $(emacsdir)/emacsver.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ woman.texi -woman.dvi: woman.texi +woman.dvi: woman.texi $(emacsdir)/emacsver.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/woman.texi $(infodir)/speedbar$(INFO_EXT): speedbar.texi @@ -309,9 +309,9 @@ $(infodir)/rcirc$(INFO_EXT): rcirc.texi rcirc.dvi: rcirc.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/rcirc.texi -$(infodir)/erc$(INFO_EXT): erc.texi gpl.texi +$(infodir)/erc$(INFO_EXT): erc.texi $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ erc.texi -erc.dvi: erc.texi gpl.texi +erc.dvi: erc.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/erc.texi $(infodir)/ert$(INFO_EXT): ert.texi diff --git a/doc/misc/message.texi b/doc/misc/message.texi index 4d5d82aa6bd..a98c7e48e53 100644 --- a/doc/misc/message.texi +++ b/doc/misc/message.texi @@ -1817,17 +1817,14 @@ a string nor @code{nil}, use the user name only. However, it is highly unlikely that you should need to fiddle with this variable at all. @end table -@findex yow @cindex Mime-Version In addition, you can enter conses into this list. The @sc{car} of this cons should be a symbol. This symbol's name is the name of the header, and the @sc{cdr} can either be a string to be entered verbatim as the value of this header, or it can be a function to be called. This function should -return a string to be inserted. For instance, if you want to insert -@code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")} -into the list. If you want to insert a funny quote, you could enter -something like @code{(X-Yow . yow)} into the list. The function -@code{yow} will then be called without any arguments. +take no arguments, and return a string to be inserted. For +instance, if you want to insert @code{Mime-Version: 1.0}, you should +enter @code{(Mime-Version . "1.0")} into the list. If the list contains a cons where the @sc{car} of the cons is @code{optional}, the @sc{cdr} of this cons will only be inserted if it is diff --git a/doc/misc/mh-e.texi b/doc/misc/mh-e.texi index fa35aa45984..154120f2e3b 100644 --- a/doc/misc/mh-e.texi +++ b/doc/misc/mh-e.texi @@ -1,4 +1,4 @@ -\input texinfo @c -*-texinfo-*- +\input texinfo @c -*- mode: texinfo; coding: utf-8; -*- @c @c Note: This document requires makeinfo version 4.6 or greater to build. @c @@ -8,12 +8,12 @@ @c %**end of header @c Version of the software and manual. -@set VERSION 8.3 +@set VERSION 8.5 @c Edition of the manual. It is either empty for the first edition or @c has the form ", nth Edition" (without the quotes). @set EDITION -@set UPDATED 2011-09-20 -@set UPDATE-MONTH September, 2011 +@set UPDATED 2013-03-02 +@set UPDATE-MONTH March, 2013 @c Other variables. @set MH-BOOK-HOME http://rand-mh.sourceforge.net/book/mh @@ -212,7 +212,7 @@ more niceties about GNU Emacs and MH@. Now I'm fully hooked on both of them. The MH-E package is distributed with Emacs@footnote{Version -@value{VERSION} of MH-E appeared in Emacs 24.1. It is supported in GNU +@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 @@ -236,7 +236,7 @@ read an online tutorial by starting GNU Emacs and typing @kbd{C-h t} @ref{top, , GNU Emacs Manual, emacs, GNU Emacs Manual}, @end ifinfo @ifhtml -@uref{http://www.gnu.org/software/emacs/manual/html_node/, +@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/, @cite{GNU Emacs Manual}}, @end ifhtml from the Free Software Foundation. @@ -255,9 +255,9 @@ version is distributed with Emacs and can be accessed with the @command{info} command (@samp{info mh-e}) or within Emacs (@kbd{C-h i m mh-e @key{RET}}). The online version is available at @uref{http://mh-e.sourceforge.net/manual/, SourceForge}. Another great -online resource is the book @uref{http://www.ics.uci.edu/~mh/book/, -@cite{MH & nmh: Email for Users & Programmers}} (also known as -@dfn{the MH book}). +online resource is the book +@uref{http://rand-mh.sourceforge.net/book/, @cite{MH & nmh: Email for +Users & Programmers}} (also known as @dfn{the MH book}). I hope you enjoy this manual! If you have any comments, or suggestions for this document, please let me know. @@ -384,7 +384,7 @@ GNU Emacs Manual}. @end ifnothtml @ifhtml See section -@uref{http://www.gnu.org/software/emacs/manual/html_node/Easy-Customization.html, +@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/Easy-Customization.html, Easy Customization} in @cite{The GNU Emacs Manual}. @end ifhtml @xref{Options}. @@ -404,7 +404,7 @@ GNU Emacs Manual}. @end ifnothtml @ifhtml See section -@uref{http://www.gnu.org/software/emacs/manual/html_node/Face-Customization.html, +@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/Face-Customization.html, Face Customization} in @cite{The GNU Emacs Manual}. @end ifhtml @@ -422,7 +422,7 @@ Emacs Manual} @end ifnothtml @ifhtml See section -@uref{http://www.gnu.org/software/emacs/manual/html_node/Hooks.html, +@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/Hooks.html, Hooks} in @cite{The GNU Emacs Manual} @end ifhtml for a description about @dfn{normal hooks} and @dfn{abnormal hooks}. @@ -473,7 +473,7 @@ point. @end ifnothtml @ifhtml See the section -@uref{http://www.gnu.org/software/emacs/manual/html_node/Completion.html, +@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/Completion.html, Completion} in @cite{The GNU Emacs Manual}. @end ifhtml Note that @key{SPC} cannot be used for completing filenames and @@ -550,12 +550,12 @@ to install MH or tell MH-E where to find MH. @cindex GNU mailutils MH If you don't have MH on your system already, you must install a -variant of MH@. The Debian mh-e package does this for you automatically -(@pxref{Getting MH-E}). Most people use +variant of MH@. The Debian mh-e package does this for you +automatically (@pxref{Getting MH-E}). Most people use @uref{http://www.nongnu.org/nmh/, nmh}, but you may be interested in -trying out @uref{http://www.gnu.org/software/mailutils/, GNU mailutils -MH}, which supports IMAP@. Your GNU/Linux distribution probably has -packages for both of these. +trying out @uref{http://mailutils.org/, GNU mailutils MH}, which +supports IMAP@. Your GNU/Linux distribution probably has packages for +both of these. @cindex @command{install-mh} @cindex MH commands, @command{install-mh} @@ -1121,27 +1121,27 @@ exist, @footnote{The @cite{GNU Emacs Lisp Reference Manual} may be available online in the Info system by typing @kbd{C-h i m Emacs Lisp @key{RET}}. It is also available online at @* -@uref{http://www.gnu.org/software/emacs/elisp-manual/html_node/}. You -can also order a printed manual, which has the desirable side-effect -of helping to support the Free Software Foundation which made all this -great software available. You can find an order form by running -@kbd{C-h C-d}, or you can request an order form from @i{gnu at +@uref{http://www.gnu.org/savannah-checkouts/gnu/emacs/manual/html_node/elisp/}. +You can also order a printed manual, which has the desirable +side-effect of helping to support the Free Software Foundation which +made all this great software available. You can find an order form by +running @kbd{C-h C-d}, or you can request an order form from @i{gnu at gnu.org}.} @end iftex @ifinfo @footnote{@xref{Top, The GNU Emacs Lisp Reference Manual, , elisp, GNU Emacs Lisp Reference Manual}, which may be available online in the Info system. It is also available online at -@uref{http://www.gnu.org/software/emacs/elisp-manual/html_node/}. You -can also order a printed manual, which has the desirable side-effect -of helping to support the Free Software Foundation which made all this -great software available. You can find an order form by running -@kbd{C-h C-d}, or you can request an order form from @i{gnu at +@uref{http://www.gnu.org/savannah-checkouts/gnu/emacs/manual/html_node/elisp/}. +You can also order a printed manual, which has the desirable +side-effect of helping to support the Free Software Foundation which +made all this great software available. You can find an order form by +running @kbd{C-h C-d}, or you can request an order form from @i{gnu at gnu.org}.} @end ifinfo @ifhtml @footnote{The -@uref{http://www.gnu.org/software/emacs/elisp-manual/html_node/, +@uref{http://www.gnu.org/savannah-checkouts/gnu/emacs/manual/html_node/elisp/, The GNU Emacs Lisp Reference Manual} may also be available online in the Info system by typing @kbd{C-h i m Emacs Lisp @key{RET}}. You can also order a printed manual, which has the desirable side-effect of @@ -1311,7 +1311,7 @@ When you choose a folder in MH-E via a command such as @kbd{o} @end ifnothtml @ifhtml (see the section -@uref{http://www.gnu.org/software/emacs/manual/html_node/Completion.html, +@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/Completion.html, Completion} in @cite{The GNU Emacs Manual}). @end ifhtml In addition, MH-E has several ways of choosing a suitable default so @@ -2089,8 +2089,7 @@ expressions are not allowed. Unique fields should have a @samp{:} suffix; otherwise, the element can be used to render invisible an entire class of fields that start with the same prefix. If you think a header field should be generally ignored, please update -@uref{https://sourceforge.net/tracker/index.php?func=detail&aid=1916032&group_id=13357&atid=113357, -SF #1916032}. +@uref{https://sourceforge.net/p/mh-e/bugs/245/, SF #245}. @cindex header field, @samp{Face:} @cindex header field, @samp{X-Face:} @@ -2142,12 +2141,12 @@ Finally, MH-E will display images referenced by the @samp{X-Face:} fields are present@footnote{The display of the images requires the @uref{http://www.gnu.org/software/wget/wget.html, @command{wget} program} to fetch the image and the @command{convert} -program from the @uref{http://www.imagemagick.org/, ImageMagick -suite}.}. Of the three header fields this is the most efficient in -terms of network usage since the image doesn't need to be transmitted -with every single mail. The option @code{mh-fetch-x-image-url} -controls the fetching of the @samp{X-Image-URL:} header field image -with the following values: +program from the @uref{http://www.imagemagick.org/script/index.php, +ImageMagick suite}.}. Of the three header fields this is the most +efficient in terms of network usage since the image doesn't need to be +transmitted with every single mail. The option +@code{mh-fetch-x-image-url} controls the fetching of the +@samp{X-Image-URL:} header field image with the following values: @table @samp @item Ask Before Fetching @@ -4969,7 +4968,7 @@ Michael W Thelen <thelenm@@stop.mail-abuse.org> wrote: The attribution consists of the sender's name and email address followed by the content of the option @code{mh-extract-from-attribution-verb}. This option can be set to -@samp{wrote:}, @samp{a écrit:}, and @samp{schrieb:}. You can also use +@samp{wrote:}, @samp{a écrit:}, and @samp{schrieb:}. You can also use the @samp{Custom String} menu item to enter your own verb. @vindex mail-citation-hook @@ -6025,7 +6024,7 @@ GNU Emacs Manual}). @end ifnothtml @ifhtml (see the section -@uref{http://www.gnu.org/software/emacs/manual/html_node/Regexps.html, +@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/Regexps.html, Syntax of Regular Expressions} in @cite{The GNU Emacs Manual}). @end ifhtml @@ -6175,7 +6174,7 @@ GNU Emacs Manual}). @end ifnothtml @ifhtml (see the section -@uref{http://www.gnu.org/software/emacs/manual/html_node/Regexps.html, +@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/Regexps.html, Syntax of Regular Expressions} in @cite{The GNU Emacs Manual}). @end ifhtml @@ -6283,7 +6282,7 @@ You can also use the speedbar @end ifnothtml @ifhtml (see the section -@uref{http://www.gnu.org/software/emacs/manual/html_node/Speedbar.html, +@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/Speedbar.html, Speedbar Frames} in @cite{The GNU Emacs Manual}) @end ifhtml to view your folders. To bring up the speedbar, run @kbd{M-x speedbar @@ -6415,7 +6414,7 @@ For a description of the menu bar, please @end ifnothtml @ifhtml see the section -@uref{http://www.gnu.org/software/emacs/manual/html_node/Menu-Bar.html, +@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/Menu-Bar.html, The Menu Bar} in @cite{The GNU Emacs Manual}. @end ifhtml @@ -6437,7 +6436,7 @@ tool bar, please @end ifnothtml @ifhtml see the section -@uref{http://www.gnu.org/software/emacs/manual/html_node/Tool-Bars.html, +@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/Tool-Bars.html, Tool Bars} in @cite{The GNU Emacs Manual}. @end ifhtml @@ -6966,23 +6965,22 @@ swish-e -c /home/user/Mail/.swish/config @cindex @command{mairix} @cindex Unix commands, @command{mairix} -In the examples below, replace @file{/home/user/Mail} with the path to -your MH directory. +In the examples below, replace @file{~/Mail} with the path to your MH +directory. -First create the directory @file{/home/user/Mail/.mairix}. Then create -the file @file{/home/user/Mail/.mairix/config} with the following -contents: +First create the directory @file{~/Mail/.mairix}. Then create the file +@file{~/Mail/.mairix/config} with the following contents: @smallexample @group -base=/home/user/Mail +base=~/Mail # List of folders that should be indexed. 3 dots at the end means there # are subfolders within the folder mh=archive...:inbox:drafts:news:sent:trash -vfolder_format=mh -database=/home/user/Mail/.mairix/database +mformat=mh +database=~/Mail/.mairix/database @end group @end smallexample @@ -6990,7 +6988,7 @@ Use the following command line to generate the mairix index. Run this daily from cron: @smallexample -mairix -f /home/user/Mail/.mairix/config +mairix -f ~/Mail/.mairix/config @end smallexample @subsection namazu @@ -7395,6 +7393,9 @@ The name of the MH sequence for ticked messages (default: @samp{'tick}). @item mh-update-sequences-after-mh-show-flag On means flush MH sequences to disk after message is shown (default: @samp{on}). +@item mh-whitelist-preserves-sequences-flag +On means that sequences are preserved when messages are whitelisted +(default: @samp{on}). @end vtable The following hook is available. @@ -7600,6 +7601,40 @@ Disposition of junk mail (default: @samp{Delete Spam}). Spam program that MH-E should use (default: @samp{Auto-detect}). @end vtable +@cindex @samp{mh-sequences} customization group +@cindex customization group, @samp{mh-sequences} + +The following option in the @samp{mh-sequences} customization group is +also available. + +@vtable @code +@item mh-whitelist-preserves-sequences-flag +On means that sequences are preserved when messages are whitelisted +(default: @samp{on}). +@end vtable + +The following hooks are available. + +@vtable @code +@item mh-blacklist-msg-hook +Hook run by @kbd{J b} (@code{mh-junk-blacklist}) after marking each +message for blacklisting (default: @code{nil}). +@c ------------------------- +@item mh-whitelist-msg-hook +Hook run by @kbd{J w} (@code{mh-junk-whitelist}) after marking each +message for whitelisting (default @samp{nil}). +@end vtable + +The following faces are available. + +@vtable @code +@item mh-folder-blacklisted +Blacklisted message face. +@c ------------------------- +@item mh-folder-whitelisted +Whitelisted message face +@end vtable + @cindex SpamProbe @cindex Spamassassin @cindex bogofilter @@ -7642,6 +7677,18 @@ reclassifies a range of messages (@pxref{Ranges}) as ham if it were incorrectly classified as spam. It then refiles the message into the @file{+inbox} folder. +@cindex MH profile component, @samp{Previous-Sequence:} +@cindex @samp{cur} sequence +@cindex @samp{Previous-Sequence:} MH profile component +@cindex sequence, @samp{cur} +@cindex sequence, @samp{Previous-Sequence} +@vindex mh-whitelist-preserves-sequences-flag + +If a message is in any sequence (except @samp{Previous-Sequence:} and +@samp{cur}) when it is whitelisted, then it will still be in those +sequences in the destination folder. If this behavior is not desired, +then turn off the option @code{mh-whitelist-preserves-sequences-flag}. + @cindex @samp{*MH-E Log*} @cindex buffers, @samp{*MH-E Log*} @findex call-process @@ -8171,7 +8218,7 @@ GNU Emacs Manual}. @end ifnothtml @ifhtml section -@uref{http://www.gnu.org/software/emacs/manual/html_node/Regexps.html, +@uref{http://www.gnu.org/software/emacs/manual/html_node/emacs/Regexps.html, Syntax of Regular Expressions} in @cite{The GNU Emacs Manual}. @end ifhtml @@ -8664,12 +8711,11 @@ I also point out some additional sources of information. @kindex M-x mh-version Bug reports should be filed at -@uref{https://sourceforge.net/tracker/?group_id=13357&atid=113357, -SourceForge}. You need to be a SourceForge user to submit bug reports, -but this is easy enough to do that it shouldn't be a restriction for -you. Please include the output of @kbd{M-x mh-version} -(@pxref{Miscellaneous}) in any bug report you send unless you're 110% -positive we won't ask for it. +@uref{https://sourceforge.net/p/mh-e/bugs/, SourceForge}. You need to +be a SourceForge user to submit bug reports, but this is easy enough +to do that it shouldn't be a restriction for you. Please include the +output of @kbd{M-x mh-version} (@pxref{Miscellaneous}) in any bug +report you send unless you're 110% positive we won't ask for it. @node Mailing Lists, MH FAQ and Support, Bug Reports, Odds and Ends @appendixsec MH-E Mailing Lists @@ -8680,7 +8726,7 @@ positive we won't ask for it. There are several mailing lists for MH-E@. They are @i{mh-e-users at lists.sourceforge.net}, @i{mh-e-announce at lists.sourceforge.net}, and @i{mh-e-devel at lists.sourceforge.net}. You can subscribe or view -the archives at @uref{https://sourceforge.net/mail/?group_id=13357, +the archives at @uref{https://sourceforge.net/p/mh-e/mailman/, SourceForge}. Do not report bugs on these lists; please submit them via SourceForge (@pxref{Bug Reports}). @@ -8698,11 +8744,10 @@ itself which you will find useful. @cindex support -You can find FAQs on MH-E at the -@uref{https://sourceforge.net/tracker/?group_id=13357&atid=213357, -Support Requests} page on SourceForge. If you don't find the answer to -your question, file a support request and your question will become a -new FAQ! +You can find FAQs on MH-E by searching for @i{labels:support} on the +@uref{https://sourceforge.net/p/mh-e/bugs/search/?q=labels%3Asupport, +Tickets} page on SourceForge. If you don't find the answer to your +question, file a ticket and your question will become a new FAQ! @node Getting MH-E, , MH FAQ and Support, Odds and Ends @appendixsec Getting MH-E @@ -8720,13 +8765,13 @@ distribution in @file{miscellany/mh-e}. @cindex release notes New MH-E releases are always available for downloading at -@uref{https://sourceforge.net/project/showfiles.php?group_id=13357, -SourceForge} before they appear in an Emacs release. You can read the -release notes on that page to determine if the given release of MH-E -is already installed in your version of Emacs. You can also read the -change log to see if you are interested in what the given release of -MH-E has to offer (although we have no doubt that you will be -extremely interested in all new releases). +@uref{https://sourceforge.net/projects/mh-e/files/, SourceForge} +before they appear in an Emacs release. You can read the release notes +on that page to determine if the given release of MH-E is already +installed in your version of Emacs. You can also read the change log +to see if you are interested in what the given release of MH-E has to +offer (although we have no doubt that you will be extremely interested +in all new releases). @cindex Debian @@ -8754,10 +8799,10 @@ MH-E@. Check that you're running the new version with the command @cindex documentation In addition to the mh-e package, the -@uref{https://sourceforge.net/project/showfiles.php?group_id=13357, -SourceForge} site also contains doc and contrib packages. The former -is the latest release of this manual, and the latter contains a few -contributed packages you might find useful. +@uref{https://sourceforge.net/projects/mh-e/files/, SourceForge} site +also contains doc and contrib packages. The former is the latest +release of this manual, and the latter contains a few contributed +packages you might find useful. @node History, GFDL, Odds and Ends, Top @appendix History of MH-E diff --git a/doc/misc/pcl-cvs.texi b/doc/misc/pcl-cvs.texi index df972d7991f..7c294591d0e 100644 --- a/doc/misc/pcl-cvs.texi +++ b/doc/misc/pcl-cvs.texi @@ -58,8 +58,8 @@ modify this GNU manual.'' @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 @@ -127,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 @@ -151,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 @@ -228,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 @@ -296,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 @@ -425,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 @@ -467,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 @@ -501,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 @@ -561,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 @@ -617,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 @@ -662,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 @@ -688,7 +688,7 @@ This key moves one file backward, towards the beginning of the buffer @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 @@ -746,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 @@ -805,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 @@ -842,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) @@ -867,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 @@ -908,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 @@ -924,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 @@ -956,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} @@ -974,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} @@ -1037,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 @@ -1069,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 @@ -1082,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 @@ -1109,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 @@ -1154,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 @@ -1187,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 @@ -1208,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)} @@ -1319,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) @@ -1358,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 @@ -1398,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 @@ -1412,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/rcirc.texi b/doc/misc/rcirc.texi index 6af9358c7e6..3bce0c7c24b 100644 --- a/doc/misc/rcirc.texi +++ b/doc/misc/rcirc.texi @@ -35,7 +35,7 @@ modify this GNU manual.'' @contents @ifnottex -@node Top, Basics, (dir), (dir) +@node Top @top rcirc Manual @code{rcirc} is an Emacs IRC client. @@ -92,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), @@ -103,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 @@ -156,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 @@ -245,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 @@ -259,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 @@ -402,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 @@ -430,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 @@ -594,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 @@ -610,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 @@ -668,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 @@ -726,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 @@ -742,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 @@ -774,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 @@ -789,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 @@ -809,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 @@ -828,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 @@ -850,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 @@ -864,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 @@ -887,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 @@ -928,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 15bb2c4cc0a..312b84146fa 100644 --- a/doc/misc/reftex.texi +++ b/doc/misc/reftex.texi @@ -95,7 +95,7 @@ modify this GNU manual.'' @contents @ifnottex -@node Top,,,(dir) +@node Top @top @RefTeX{} @RefTeX{} is a package for managing Labels, References, Citations and @@ -123,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. @@ -214,7 +213,7 @@ Options, Keymaps, Hooks @end ifnottex -@node Introduction, Table of Contents, , Top +@node Introduction @chapter Introduction @cindex Introduction @@ -242,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 @@ -360,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 @@ -516,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 @@ -765,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 @@ -800,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 @@ -867,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 @@ -1092,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 @@ -1197,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 @@ -1230,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 @@ -1362,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 @@ -1410,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 @@ -1470,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 @@ -1494,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 @@ -1521,7 +1520,7 @@ Note that this is automatically done by the @file{amsmath.el} style file 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} @@ -1622,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 @@ -1640,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 @@ -1662,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 @@ -1750,7 +1749,7 @@ 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} @@ -1785,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} @@ -1805,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 @@ -1955,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} @@ -2020,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 @@ -2041,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 @@ -2056,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 @@ -2081,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 @@ -2109,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} @@ -2176,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 @@ -2207,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 @@ -2255,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 @@ -2321,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 @@ -2354,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 @@ -2435,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 @@ -2616,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 @@ -2634,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 @@ -2731,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 @@ -2810,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 @@ -2822,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 @@ -2896,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 @@ -2908,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 @@ -2961,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 @@ -3003,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 @@ -3089,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 @@ -3242,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} @@ -3259,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 @@ -3343,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} @@ -3463,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} @@ -3491,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 @@ -3627,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 @@ -3674,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 @@ -3876,7 +3883,7 @@ 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 @@ -3898,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 @@ -4024,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 @@ -4251,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 @@ -4367,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 @@ -4489,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 @@ -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 @@ -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 @@ -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 @@ -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 0f541981f1a..290c18a7b47 100644 --- a/doc/misc/remember.texi +++ b/doc/misc/remember.texi @@ -44,8 +44,7 @@ modify this GNU manual.'' @contents @ifnottex -@node Top, Preface, (dir), (dir) -@comment node-name, next, previous, up +@node Top @top Remember @insertcopying @@ -76,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, @@ -87,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 @@ -130,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 @@ -143,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 @@ -185,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 @@ -257,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: @@ -291,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: @@ -310,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. @@ -323,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 @@ -344,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 @@ -362,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 @@ -383,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 @@ -398,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/ses.texi b/doc/misc/ses.texi index 2bef526257e..2c84d04c666 100644 --- a/doc/misc/ses.texi +++ b/doc/misc/ses.texi @@ -1,7 +1,7 @@ -\input texinfo @c -*-texinfo-*- +\input texinfo @c -*- mode: texinfo; coding: utf-8; -*- @c %**start of header @setfilename ../../info/ses -@settitle SES: Simple Emacs Spreadsheet +@settitle @acronym{SES}: Simple Emacs Spreadsheet @setchapternewpage off @syncodeindex fn cp @syncodeindex vr cp @@ -9,7 +9,7 @@ @c %**end of header @copying -This file documents SES: the Simple Emacs Spreadsheet. +This file documents @acronym{SES}: the Simple Emacs Spreadsheet. Copyright @copyright{} 2002--2013 Free Software Foundation, Inc. @@ -28,13 +28,13 @@ modify this GNU manual.'' @dircategory Emacs misc features @direntry -* SES: (ses). Simple Emacs Spreadsheet. +* @acronym{SES}: (ses). Simple Emacs Spreadsheet. @end direntry @finalout @titlepage -@title SES +@title @acronym{SES} @subtitle Simple Emacs Spreadsheet @author Jonathan A. Yavner @author @email{jyavner@@member.fsf.org} @@ -49,12 +49,12 @@ modify this GNU manual.'' @c =================================================================== @ifnottex -@node Top, Sales Pitch, (dir), (dir) +@node Top @comment node-name, next, previous, up -@top SES: Simple Emacs Spreadsheet +@top @acronym{SES}: Simple Emacs Spreadsheet @display -SES is a major mode for GNU Emacs to edit spreadsheet files, which +@acronym{SES} is a major mode for GNU Emacs to edit spreadsheet files, which contain a rectangular grid of cells. The cells' values are specified by formulas that can refer to the values of other cells. @end display @@ -65,7 +65,7 @@ To report bugs, send email to @email{jyavner@@member.fsf.org}. @insertcopying @menu -* Sales Pitch:: Why use SES? +* Sales Pitch:: Why use @acronym{SES}? * The Basics:: Basic spreadsheet commands * Advanced Features:: Want to know more? * For Gurus:: Want to know @emph{even more}? @@ -76,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 @@ -98,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 @@ -125,9 +125,9 @@ Moves point to cell, specified by identifier (@code{ses-jump}). Point is always at the left edge of a cell, or at the empty endline. When mark is inactive, the current cell is underlined. When mark is -active, the range is the highlighted rectangle of cells (SES always +active, the range is the highlighted rectangle of cells (@acronym{SES} always uses transient mark mode). Drag the mouse from A1 to A3 to create the -range A1-A2. Many SES commands operate only on single cells, not +range A1-A2. Many @acronym{SES} commands operate only on single cells, not ranges. @table @kbd @@ -154,10 +154,10 @@ Highlight all cells (@code{mark-whole-buffer}). * Printer functions:: * Clearing cells:: * Copy/cut/paste:: -* Customizing SES:: +* Customizing @acronym{SES}:: @end menu -@node Formulas, Resizing, The Basics, The Basics +@node Formulas @section Cell formulas @cindex formulas @cindex formulas, entering @@ -191,7 +191,7 @@ this cell's formula will be reevaluated. While typing in the expression, you can use @kbd{M-@key{TAB}} to complete symbol names. @item ' @r{(apostrophe)} -Enter a symbol (ses-read-symbol). SES remembers all symbols that have +Enter a symbol (ses-read-symbol). @acronym{SES} remembers all symbols that have been used as formulas, so you can type just the beginning of a symbol and use @kbd{@key{SPC}}, @kbd{@key{TAB}}, and @kbd{?} to complete it. @end table @@ -210,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 @@ -266,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 @@ -331,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 @@ -348,7 +348,7 @@ Clear cell and move right (@code{ses-clear-cell-forward}). @end table -@node Copy/cut/paste, Customizing SES, Clearing cells, The Basics +@node Copy/cut/paste @section Copy, cut, and paste @cindex copy @cindex cut @@ -364,7 +364,7 @@ Clear cell and move right (@code{ses-clear-cell-forward}). @findex ses-yank-pop The copy functions work on rectangular regions of cells. You can paste the -copies into non-SES buffers to export the print text. +copies into non-@acronym{SES} buffers to export the print text. @table @kbd @item M-w @@ -393,7 +393,7 @@ Paste from kill ring (@code{yank}). The paste functions behave differently depending on the format of the text being inserted: @itemize @bullet @item -When pasting cells that were cut from a SES buffer, the print text is +When pasting cells that were cut from a @acronym{SES} buffer, the print text is ignored and only the attached formula and printer are inserted; cell references in the formula are relocated unless you use @kbd{C-u}. @item @@ -401,7 +401,7 @@ The pasted text overwrites a rectangle of cells whose top left corner is the current cell. If part of the rectangle is beyond the edges of the spreadsheet, you must confirm the increase in spreadsheet size. @item -Non-SES text is usually inserted as a replacement formula for the +Non-@acronym{SES} text is usually inserted as a replacement formula for the current cell. If the formula would be a symbol, it's treated as a string unless you use @kbd{C-u}. Pasted formulas with syntax errors are always treated as strings. @@ -419,12 +419,12 @@ Set point and paste from secondary clipboard (@code{mouse-yank-secondary}). @item M-y Immediately after a paste, you can replace the text with a preceding element from the kill ring (@code{ses-yank-pop}). Unlike the standard -Emacs yank-pop, the SES version uses @code{undo} to delete the old +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 SES, , Copy/cut/paste, The Basics -@section Customizing SES +@node Customizing @acronym{SES} +@section Customizing @acronym{SES} @cindex customizing @vindex enable-local-eval @vindex ses-mode-hook @@ -442,7 +442,7 @@ up or down. For diagonal movement, select two functions from the list. @code{ses-mode-hook} is a normal mode hook (list of functions to -execute when starting SES mode for a buffer). +execute when starting @acronym{SES} mode for a buffer). The variable @code{safe-functions} is a list of possibly-unsafe functions to be treated as safe when analyzing formulas and printers. @@ -460,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 @@ -468,7 +468,10 @@ safety belts! @table @kbd @item C-c M-C-h -(@code{ses-set-header-row}). The header line at the top of the SES +(@code{ses-set-header-row}). +@findex ses-set-header-row +@kindex C-c M-C-h +The header line at the top of the @acronym{SES} window normally shows the column letter for each column. You can set it to show a copy of some row, such as a row of column titles, so that row will always be visible. Default is to set the current row as the @@ -477,6 +480,16 @@ show column letters again. @item [header-line mouse-3] Pops up a menu to set the current row as the header, or revert to column letters. +@item M-x ses-rename-cell +@findex ses-rename-cell +Rename a cell from a standard A1-like name to any +string. +@item M-x ses-repair-cell-reference-all +@findex ses-repair-cell-reference-all +When you interrupt a cell formula update by clicking @kbd{C-g}, then +the cell reference link may be broken, which will jeopardize automatic +cell update when any other cell on which it depends is changed. To +repair that use function @code{ses-repair-cell-reference-all} @end table @menu @@ -490,16 +503,16 @@ column letters. * 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 @findex ses-renarrow-buffer @findex ses-reprint-all -A SES file consists of a print area and a data area. Normally the +A @acronym{SES} file consists of a print area and a data area. Normally the buffer is narrowed to show only the print area. The print area is -read-only except for special SES commands; it contains cell values +read-only except for special @acronym{SES} commands; it contains cell values formatted by printer functions. The data area records the formula and printer functions, etc. @@ -516,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 @@ -575,8 +588,54 @@ If you insert a new row just beyond the end of a one-column range, or a new column just beyond a one-row range, the new cell is included in the range. New cells inserted just before a range are not included. +Flags can be added to @code{ses-range} immediately after the @var{to} +cell. +@table @code +@item ! +Empty cells in range can be removed by adding the @code{!} flag. An +empty cell is a cell the value of which is one of symbols @code{nil} +or @code{*skip*}. For instance @code{(ses-range A1 A4 !)} will do the +same as @code{(list A1 A3)} when cells @code{A2} and @code{A4} are +empty. +@item _ +Empty cell values are replaced by the argument following flag +@code{_}, or @code{0} when flag @code{_} is last in argument list. For +instance @code{(ses-range A1 A4 _ "empty")} will do the same as +@code{(list A1 "empty" A3 "empty")} when cells @code{A2} and @code{A4} +are empty. Similarly, @code{(ses-range A1 A4 _ )} will do the same as +@code{(list A1 0 A3 0)}. +@item >v +When order matters, list cells by reading cells row-wise from top left +to bottom right. This flag is provided for completeness only as it is +the default reading order. +@item <v +List cells by reading cells row-wise from top right to bottom left. +@item v> +List cells by reading cells column-wise from top left to bottom right. +@item v< +List cells by reading cells column-wise from top right to bottom left. +@item v +A short hand for @code{v>}. +@item ^ +A short hand for @code{^>}. +@item > +A short hand for @code{>v}. +@item < +A short hand for @code{>^}. +@item * +Instead of listing cells, it makes a Calc vector or matrix of it +(@pxref{Top,,,calc,GNU Emacs Calc Manual}). If the range contains only +one row or one column a vector is made, otherwise a matrix is made. +@item *2 +Same as @code{*} except that a matrix is always made even when there +is only one row or column in the range. +@item *1 +Same as @code{*} except that a vector is always made even when there +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 @@ -605,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* @@ -630,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 @@ -652,7 +711,7 @@ the result is too wide for the available space (up to the end of the row or the next non-@code{nil} cell), the result is truncated if the cell's value is a string, or replaced with hash marks otherwise. -SES could get confused by printer results that contain newlines or +@acronym{SES} could get confused by printer results that contain newlines or tabs, so these are replaced with question marks. @table @kbd @@ -678,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 @@ -698,7 +757,7 @@ 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 @@ -725,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 @@ -733,7 +792,7 @@ for more info on how Lisp forms are classified as safe or unsafe. A common organization for spreadsheets is to have a bunch of ``detail'' rows, each perhaps describing a transaction, and then a set of ``summary'' rows that each show reduced data for some subset of the -details. SES supports this organization via the @code{ses-select} +details. @acronym{SES} supports this organization via the @code{ses-select} function. @table @code @@ -761,7 +820,7 @@ details-and-summary spreadsheet. @c =================================================================== -@node For Gurus, Index, Advanced Features, Top +@node For Gurus @chapter For Gurus @cindex advanced features @@ -770,10 +829,10 @@ details-and-summary spreadsheet. * Nonrelocatable references:: * The data area:: * Buffer-local variables in spreadsheets:: -* Uses of defadvice in SES:: +* 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 @@ -798,14 +857,14 @@ progress message of the form ``Writing... (@var{nnn} cells left)''. These deferred cell-writes cannot be interrupted by @kbd{C-g}, so you'll just have to wait. -SES uses @code{run-with-idle-timer} to move the cell underline when +@acronym{SES} uses @code{run-with-idle-timer} to move the cell underline when Emacs will be scrolling the buffer after the end of a command, and also to narrow and underline after @kbd{C-x C-v}. This is visible as 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 @@ -833,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 @@ -842,14 +901,14 @@ Begins with an 014 character, followed by sets of cell-definition macros for each row, followed by column-widths, column-printers, default-printer, and header-row. Then there's the global parameters (file-format ID, numrows, numcols) and the local variables (specifying -SES mode for the buffer, etc.). +@acronym{SES} mode for the buffer, etc.). -When a SES file is loaded, first the numrows and numcols values are +When a @acronym{SES} file is loaded, first the numrows and numcols values are loaded, then the entire data area is @code{eval}ed, and finally the local variables are processed. You can edit the data area, but don't insert or delete any newlines -except in the local-variables part, since SES locates things by +except in the local-variables part, since @acronym{SES} locates things by counting newlines. Use @kbd{C-x C-e} at the end of a line to install your edits into the spreadsheet data structures (this does not update the print area, use, e.g., @kbd{C-c C-l} for that). @@ -865,7 +924,7 @@ data structures: @end table -@node Buffer-local variables in spreadsheets, Uses of defadvice in 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 @@ -899,8 +958,8 @@ avoid virus warnings, each function used in a formula needs (put 'your-function-name 'safe-function t) @end lisp -@node Uses of defadvice in SES, , Buffer-local variables in spreadsheets, For Gurus -@section Uses of defadvice in SES +@node Uses of defadvice in @acronym{SES} +@section Uses of defadvice in @acronym{SES} @cindex defadvice @cindex undo-more @cindex copy-region-as-kill @@ -926,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 @@ -963,9 +1022,9 @@ Yusong Li @email{lyusong@@hotmail.com}@* Juri Linkov @email{juri@@jurta.org}@* Harald Maier @email{maierh@@myself.com}@* Alan Nash @email{anash@@san.rr.com}@* -François Pinard @email{pinard@@iro.umontreal.ca}@* +François Pinard @email{pinard@@iro.umontreal.ca}@* Pedro Pinto @email{ppinto@@cs.cmu.edu}@* -Stefan Reichör @email{xsteve@@riic.at}@* +Stefan Reichör @email{xsteve@@riic.at}@* Oliver Scholz @email{epameinondas@@gmx.de}@* Richard M. Stallman @email{rms@@gnu.org}@* Luc Teirlinck @email{teirllm@@dms.auburn.edu}@* @@ -975,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/speedbar.texi b/doc/misc/speedbar.texi index 0b6f1db43b9..3cb0ec3aed8 100644 --- a/doc/misc/speedbar.texi +++ b/doc/misc/speedbar.texi @@ -37,8 +37,7 @@ modify this GNU manual.'' @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 @@ -83,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 @@ -115,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 @@ -131,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 @@ -205,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 @@ -307,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 @@ -352,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 @@ -369,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 @@ -387,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 @@ -471,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 @@ -498,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 @@ -537,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 @@ -569,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 @@ -592,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 @@ -614,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 @@ -629,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 @@ -652,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 @@ -680,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 @@ -725,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 @@ -805,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 @@ -840,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 @@ -883,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 @@ -908,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 @@ -966,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 @@ -1097,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. @@ -1137,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 @@ -1239,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 dac24f7ca47..d76f9e09184 100644 --- a/doc/misc/srecode.texi +++ b/doc/misc/srecode.texi @@ -225,7 +225,7 @@ template files, and determining which templates are relevant to the current buffer. Template files are sorted by priority, with user templates being found first, and system level default templates last. Templates are also sorted by application. Each application has its -own templates, and are kept seperate from the generic templates. +own templates, and are kept separate from the generic templates. @section Dictionary Dictionaries contain values associated with variable. Variables are @@ -311,7 +311,7 @@ template to be inserted again. By default, when inserting a template, if the user needs to enter text to fill in a part of the template, then the minibuffer is used to -query for that information. SRecode also supports a field-edting mode +query for that information. SRecode also supports a field-editing mode that can be used instead. To enable it set: @defun srecode-insert-ask-variable-method @@ -343,7 +343,7 @@ Once the cursor moves out of the are inserted by the template, all the fields are cancelled. @b{NOTE}: Some conveniences in templates, such as completion, or -character restrictins are lost when using field editing mode. +character restrictions are lost when using field editing mode. @node Template Writing @chapter Template Writing @@ -400,7 +400,7 @@ set VARNAME "some value" @end example Note that a VARIABLE is a name in a dictionary that can be used in a -MACRO in a template. The macro referernces some variable by name. +MACRO in a template. The macro references some variable by name. @menu * String Values:: Basic Variable values @@ -419,7 +419,7 @@ other characters. Strings are interpreted by the Emacs Lisp reader so @code{\n}, @code{\t}, and @code{\"} work. When a string is inserted as part of a template, nothing within the -string is interperted, such as template escape characters. +string is interpreted, such as template escape characters. @node Multi-string Values @subsection Multi-string Values @@ -544,7 +544,7 @@ Any template file that has a project specified will get have a priority that is set between SRecode base templates, and user defined templates. -Templates can be compiled via a project system, such as EDE. EDE +Templates can be compiled via a project system, such as EDE@. EDE loaded templates will get a @var{project} set automatically. Example: @@ -598,7 +598,7 @@ variables from Lisp. A template represents a text pattern that can be inserted into a buffer. -A basic template is declaired like this: +A basic template is declared like this: @example template TEMPLATENAME :arg1 :arg2 @@ -620,7 +620,7 @@ contain the text "-----". @menu * Template Section Dictionaries:: Template Scoped Macro values -* Template Macros:: Macros occuring in template patterns +* Template Macros:: Macros occurring in template patterns @end menu @node Template Section Dictionaries @@ -643,7 +643,7 @@ An end line @end example In this example, the @var{NAME} variable gets the value ``foo'', but -only while it is inside section macro A. The outer scoped NAME will +only while it is inside section macro A@. The outer scoped NAME will be empty. This is particularly useful while using an include macro to pull in a @@ -846,7 +846,7 @@ template foo context C2 -temlate foo +template foo "Foo template in C2" ---- ---- @@ -857,13 +857,13 @@ C1. The second is available in context C2. This is useful if there are multiple ways to declare something like a function or variable that differ only by where it is in the syntax of -the lanugage. The name @code{foo} is not ambiguous because each is in +the language. The name @code{foo} is not ambiguous because each is in a different context. @node Prompts @section Prompt -Some templates use promtping macro insertion. A macro that needs a +Some templates use prompting macro insertion. A macro that needs a prompt looks like this: @example @@ -880,7 +880,7 @@ Specify NAME: For such macros, you can pre-define prompts for any dictionary entry. When that dictionary entry is first encountered, the user is prompted, -and subsequent occurances of that dictionary entry use the same value. +and subsequent occurrences of that dictionary entry use the same value. To get a different prompt, use a prompt command like this: @@ -925,7 +925,7 @@ need to use the @code{defaultmacro} keyword instead. prompt VARNAME "Varname: " defaultmacro "PREFIX" @end example -now, when it attempts to read in VARNAME, it will pre-populte the text +now, when it attempts to read in VARNAME, it will pre-populate the text editing section with whatever the value of PREFIX is. Some language arguments may supply possible prefixes for prompts. @@ -971,7 +971,7 @@ When building an @srecode{} based application, you will need to setup your dictionary values yourself. There are several utility functions for this. -In the simplest form, you can assocate a string with a variable. +In the simplest form, you can associate a string with a variable. @defun srecode-dictionary-set-value dict name value @anchor{srecode-dictionary-set-value} @@ -996,8 +996,9 @@ You can add several dictionaries to the same section entry. For each dictionary added to a variable, the block of codes in the template will be repeated. -If optional argument @var{SHOW-ONLY} is non-@code{nil}, then don't add a new dictionarly -if there is already one in place. Also, don't add @var{FIRST}/@var{LAST} entries. +If optional argument @var{SHOW-ONLY} is non-@code{nil}, then don't add +a new dictionary if there is already one in place. Also, don't add +@var{FIRST}/@var{LAST} entries. These entries are not needed when we are just showing a section. Each dictionary added will automatically get values for positional macros @@ -1125,7 +1126,7 @@ want, but adding dictionary values is the right thing. @node Querying a Dictionary @section Querying a Dictionary -When creating a new argument, it may be useful to ask the dicitonary +When creating a new argument, it may be useful to ask the dictionary what entries are already set there, and conditionally create new entries based on those. @@ -1233,7 +1234,7 @@ The current hour in 24 hour format. @item HOUR12 The current hour in 12 hour format. @item AMPM -Locale equivalent of AM or PM. Usefule with HOUR12. +Locale equivalent of AM or PM@. Useful with HOUR12. @item MINUTE The current minute. @item SECOND @@ -1330,7 +1331,7 @@ entries. @table @code @item ARGS -A Loop macro value. Each argument is inserted in ARGS. To create a +A Loop macro value. Each argument is inserted in ARGS@. To create a comma separated list of arguments, you might do this: @example @@ -1411,7 +1412,7 @@ name. Converts the filename into text that would be suitable as a class-name for the main class in the file. @item CURRENT_PACKAGE -Finds the occurance of ``package'' and gets its value. +Finds the occurrence of ``package'' and gets its value. @end table @subsubsection Argument :el @@ -1429,7 +1430,7 @@ to namespaces in other languages. The name of the Emacs Custom group that instances of @code{defcustom} ought to use. @item FACEGROUP -The name of the Emacs Custom group that faces delcared with +The name of the Emacs Custom group that faces declared with @code{defface} ought to use. @end table @@ -1550,7 +1551,7 @@ tables that do not belong to an application will be searched. @end defun For purposes of an @srecode{} application, it is important to decide -what to call yoru application, and use that with this method call. +what to call your application, and use that with this method call. @section Creating dictionaries @@ -1581,7 +1582,7 @@ If @var{stream} is nil, then use the current buffer. @node Template Naming Conventions @chapter Template Naming Conventions -For @srecode{} to work across langauges reliably, templates need to +For @srecode{} to work across languages reliably, templates need to follow a predictable pattern. For every language of similar nature (OO, functional, doc based) if they all provide the same base templates, then an application can be written against the base @@ -1612,7 +1613,7 @@ Functional languages should attempt to support the following: @item function A standalone function. Not a method, external method, or other. @item method -A method belonging to some class declaired outside the textual bounds +A method belonging to some class declared outside the textual bounds of that class' declaration. @item variable A global variable. @@ -1684,7 +1685,7 @@ also the following useful dictionary values. @table @var @item TAG -A special insertion value TAG. You can use semantic functions to turn +A special insertion value TAG@. You can use semantic functions to turn the tag into a string. @item HAVEDEFAULT @itemx DEFAULT diff --git a/doc/misc/texinfo.tex b/doc/misc/texinfo.tex index f3093d0853f..85f184cc4cb 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-09-12.16} +\def\texinfoversion{2013-02-01.11} % % 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: @@ -2495,7 +2496,7 @@ end \let-\codedash \let_\codeunder \else - \let-\realdash + \let-\normaldash \let_\realunder \fi \codex @@ -2504,7 +2505,7 @@ end \def\codex #1{\tclose{#1}\endgroup} -\def\realdash{-} +\def\normaldash{-} \def\codedash{-\discretionary{}{}{}} \def\codeunder{% % this is all so @math{@code{var_name}+1} can work. In math mode, _ @@ -2519,9 +2520,9 @@ end } % An additional complication: the above will allow breaks after, e.g., -% each of the four underscores in __typeof__. This is undesirable in -% some manuals, especially if they don't have long identifiers in -% general. @allowcodebreaks provides a way to control this. +% each of the four underscores in __typeof__. This is bad. +% @allowcodebreaks provides a document-level way to turn breaking at - +% and _ on and off. % \newif\ifallowcodebreaks \allowcodebreakstrue @@ -4187,7 +4188,7 @@ end % ..., but we might end up with active ones in the argument if % we're called from @code, as @code{@value{foo-bar_}}, though. % So \let them to their normal equivalents. - \let-\realdash \let_\normalunderscore + \let-\normaldash \let_\normalunderscore } } @@ -6559,16 +6560,9 @@ end \makedispenvdef{quotation}{\quotationstart} % \def\quotationstart{% - {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip - \parindent=0pt - % - % @cartouche defines \nonarrowing to inhibit narrowing at next level down. + \indentedblockstart % same as \indentedblock, but increase right margin too. \ifx\nonarrowing\relax - \advance\leftskip by \lispnarrowing \advance\rightskip by \lispnarrowing - \exdentamount = \lispnarrowing - \else - \let\nonarrowing = \relax \fi \parsearg\quotationlabel } @@ -6594,6 +6588,32 @@ end \fi } +% @indentedblock is like @quotation, but indents only on the left and +% has no optional argument. +% +\makedispenvdef{indentedblock}{\indentedblockstart} +% +\def\indentedblockstart{% + {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip + \parindent=0pt + % + % @cartouche defines \nonarrowing to inhibit narrowing at next level down. + \ifx\nonarrowing\relax + \advance\leftskip by \lispnarrowing + \exdentamount = \lispnarrowing + \else + \let\nonarrowing = \relax + \fi +} + +% Keep a nonzero parskip for the environment, since we're doing normal filling. +% +\def\Eindentedblock{% + \par + {\parskip=0pt \afterenvbreak}% +} +\def\Esmallindentedblock{\Eindentedblock} + % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} % If we want to allow any <char> as delimiter, @@ -9973,22 +9993,26 @@ directory should work if nowhere else does.} @gdef@otherbackslash{@let\=@realbackslash} % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of -% the literal character `\'. -% -@def@normalturnoffactive{% - @let"=@normaldoublequote - @let$=@normaldollar %$ font-lock fix - @let+=@normalplus - @let<=@normalless - @let>=@normalgreater - @let\=@normalbackslash - @let^=@normalcaret - @let_=@normalunderscore - @let|=@normalverticalbar - @let~=@normaltilde - @markupsetuplqdefault - @markupsetuprqdefault - @unsepspaces +% the literal character `\'. Also revert - to its normal character, in +% case the active - from code has slipped in. +% +{@catcode`- = @active + @gdef@normalturnoffactive{% + @let-=@normaldash + @let"=@normaldoublequote + @let$=@normaldollar %$ font-lock fix + @let+=@normalplus + @let<=@normalless + @let>=@normalgreater + @let\=@normalbackslash + @let^=@normalcaret + @let_=@normalunderscore + @let|=@normalverticalbar + @let~=@normaltilde + @markupsetuplqdefault + @markupsetuprqdefault + @unsepspaces + } } % Make _ and + \other characters, temporarily. diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index c65d4aac7ed..4c3740f02f7 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi @@ -216,8 +216,9 @@ Configuring @value{tramp} for use * 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. +* Android shell setup:: Android shell setup hints. * Auto-save and Backup:: Auto-save and Backup. +* Windows setup hints:: Issues with Cygwin ssh. Using @value{tramp} @@ -479,7 +480,8 @@ GVFS integration started in February 2009. Remote commands on Windows hosts are available since September 2011. @end ifset Ad-hoc multi-hop methods (with a changed syntax) have been reenabled -in November 2011. +in November 2011. In November 2012, Juergen Hoetzel's +@file{tramp-adb.el} has been added. In December 2001, @value{tramp} has been added to the XEmacs package repository. Being part of the Emacs repository happened in June 2002, @@ -542,6 +544,7 @@ 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. +* Android shell setup:: Android shell setup hints. * Auto-save and Backup:: Auto-save and Backup. * Windows setup hints:: Issues with Cygwin ssh. @end menu @@ -584,9 +587,10 @@ startup may drown out the improvement in file transfer times. External methods should be configured such a way that they don't require a password (with @command{ssh-agent}, or such alike). Modern @command{scp} implementations offer options to reuse existing -@command{ssh} connections, see method @command{scpc}. If it isn't -possible, you should consider @ref{Password handling}, otherwise you -will be prompted for a password every copy action. +@command{ssh} connections, which will be enabled by default if +available. If it isn't possible, you should consider @ref{Password +handling}, otherwise you will be prompted for a password every copy +action. @node Inline methods @@ -645,13 +649,6 @@ Connect to the remote host with @command{ssh}. This is identical to the previous option except that the @command{ssh} package is used, making the connection more secure. -There are also two variants, @option{ssh1} and @option{ssh2}, that -call @samp{ssh -1} and @samp{ssh -2}, respectively. This way, you can -explicitly select whether you want to use the SSH protocol version 1 -or 2 to connect to the remote host. (You can also specify in -@file{~/.ssh/config}, the SSH configuration file, which protocol -should be used, and use the regular @option{ssh} method.) - All the methods based on @command{ssh} have an additional feature: you can specify a host name which looks like @file{host#42} (the real host name, then a hash sign, then a port number). This means to connect to @@ -747,16 +744,6 @@ remote host. This supports the @samp{-P} argument. -Additionally, the methods @option{plink1} and @option{plink2} are -provided, which call @samp{plink -1 -ssh} or @samp{plink -2 -ssh} in -order to use SSH protocol version 1 or 2 explicitly. - -CCC: Do we have to connect to the remote host once from the command -line to accept the SSH key? Maybe this can be made automatic? - -CCC: Say something about the first shell command failing. This might -be due to a wrong setting of @code{tramp-rsh-end-of-line}. - @item @option{plinkx} @cindex method plinkx @@ -820,13 +807,6 @@ The cost of the cryptographic handshake at the start of an @command{scp} session can begin to absorb the advantage that the lack of encoding and decoding presents. -There are also two variants, @option{scp1} and @option{scp2}, that -call @samp{ssh -1} and @samp{ssh -2}, respectively. This way, you can -explicitly select whether you want to use the SSH protocol version 1 -or 2 to connect to the remote host. (You can also specify in -@file{~/.ssh/config}, the SSH configuration file, which protocol -should be used, and use the regular @option{scp} method.) - All the @command{ssh} based methods support the @samp{-p} feature where you can specify a port number to connect to in the host name. For example, the host name @file{host#42} tells @value{tramp} to @@ -894,51 +874,6 @@ 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} -@cindex method scpc -@cindex scpc method -@cindex scp (with scpc method) -@cindex ssh (with scpc method) - -Newer versions of @option{ssh} (for example OpenSSH 4) offer an option -@option{ControlMaster}. This allows @option{scp} to reuse an existing -@option{ssh} channel, which increases performance. - -Before you use this method, you should check whether your @option{ssh} -implementation supports this option. Try from the command line - -@example -ssh localhost -o ControlMaster=yes /bin/true -@end example - -If that command succeeds silently, then you can use @option{scpc}; but -if it fails like - -@example -command-line: line 0: Bad configuration option: ControlMaster -@end example - -then you cannot use it. Note, that the option -@option{ControlPersist}, if it is supported by your @option{ssh} -version, must be set to @option{no}. - -This method supports the @samp{-p} argument. - - -@item @option{rsyncc}---@command{ssh} and @command{rsync} -@cindex method rsyncc -@cindex rsyncc method -@cindex rsync (with rsyncc method) -@cindex ssh (with rsyncc method) - -Like the @option{scpc} method, @option{rsyncc} improves the underlying -@command{ssh} connection by the option @option{ControlMaster}. This -allows @command{rsync} to reuse an existing @command{ssh} channel, -which increases performance. - -This method supports the @samp{-p} argument. - - @item @option{pscp}---@command{plink} and @command{pscp} @cindex method pscp @cindex pscp method @@ -1057,6 +992,33 @@ Windows, this method isn't available. Instead, you can use UNC file names like @file{//melancholia/daniel$$/.emacs}. The only disadvantage is that there's no possibility to specify another user name. + + +@item @option{adb} +@cindex method adb +@cindex adb method + +This special method uses the Android Debug Bridge for accessing +Android devices. The Android Debug Bridge must be installed locally. +Some GNU/Linux distributions offer it for installation, otherwise it +can be installed as part of the Android SDK. If the @command{adb} +program is not found via the @code{$PATH} environment variable, the +variable @var{tramp-adb-program} must point to its absolute path. + +Tramp does not connect Android devices to @command{adb}. This must be +performed outside @value{emacsname}. If there is exactly one Android +device connected to @command{adb}, a host name is not needed in the +remote file name. The default @value{tramp} name to be used is +@file{@trampfn{adb, , ,}} therefore. Otherwise, one could find +potential host names with the command @command{adb devices}. + +Usually, the @command{adb} method does not need any user name. It +runs under the permissions of the @command{adbd} process on the +Android device. If a user name is specified, @value{tramp} applies an +@command{su} on the device. This does not work with all Android +devices, especially with unrooted ones. In that case, an error +message is displayed. + @end table @@ -1105,6 +1067,7 @@ phones. For the time being, @value{tramp} only supports OBEX over Bluetooth. The @option{synce} method allows communication with Windows Mobile devices. Beside GVFS for mounting remote files and directories via FUSE, it also needs the SYNCE-GVFS plugin. + @end table @defopt tramp-gvfs-methods @@ -1255,7 +1218,7 @@ user, see the @option{su} or @option{sudo} methods. They offer shortened syntax for the @samp{root} account, like @file{@trampfn{su, , , /etc/motd}}. -People who edit large files may want to consider @option{scpc} instead +People who edit large files may want to consider @option{scp} instead of @option{ssh}, or @option{pscp} instead of @option{plink}. These external methods are faster than inline methods for large files. Note, however, that external methods suffer from some limitations. @@ -1294,8 +1257,8 @@ example, if you always have to use the user @samp{john} in the domain @end lisp @noindent -See the documentation for the variable -@code{tramp-default-user-alist} for more details. +See the documentation for the variable @code{tramp-default-user-alist} +for more details. One trap to fall in must be known. If @value{tramp} finds a default user, this user will be passed always to the connection command as @@ -1353,6 +1316,18 @@ Note, however, that the most simplification @samp{/::} won't work, because @samp{/:} is the prefix for quoted file names. @end ifset +@vindex tramp-default-host-alist +Like with methods and users, you can also specify different default +hosts for certain method/user combinations via the variable +@code{tramp-default-host-alist}. Usually, this isn't necessary, +because @code{tramp-default-host} should be sufficient. For some +methods, like @option{adb}, that default value must be overwritten, +which is already the initial value of @code{tramp-default-host-alist}. + +@noindent +See the documentation for the variable @code{tramp-default-host-alist} +for more details. + @node Multi-hops @section Connecting to a remote host using multiple hops @@ -1612,6 +1587,7 @@ can return user names only. Finally, a function which parses @file{~/.netrc} like files. This includes also @file{~/.authinfo}-style files. + @end table If you want to keep your own data in a file, with your own structure, @@ -2049,6 +2025,77 @@ fi @end table +@node Android shell setup +@section Android shell setup hints +@cindex android shell setup + +Android devices use a restricted shell. They can be accessed via the +@option{adb} method. However, this restricts the access to a USB +connection, and it requires the installation of the Android SDK on the +local machine. + +When an @command{sshd} process runs on the Android device, like +provided by the @code{SSHDroid} app, any @option{ssh}-based method can +be used. This requires some special settings. + +The default shell @code{/bin/sh} does not exist. Instead, you shall +use just @code{sh}, which invokes the shell installed on the device. +You can instruct @value{tramp} by this form: + +@lisp +(add-to-list 'tramp-connection-properties + (list (regexp-quote "192.168.0.26") "remote-shell" "sh")) +@end lisp + +@noindent +with @samp{192.168.0.26} being the IP address of your Android device. + +The user settings for the @code{$PATH} environment variable must be +preserved. It has also been reported, that the commands in +@file{/system/xbin} are better suited than the ones in +@file{/system/bin}. Add these setting: + +@lisp +(add-to-list 'tramp-remote-path 'tramp-own-remote-path) +(add-to-list 'tramp-remote-path "/system/xbin") +@end lisp + +@noindent +If the Android device is not @samp{rooted}, you must give the shell a +writable directory for temporary files: + +@lisp +(add-to-list 'tramp-remote-process-environment "TMPDIR=$HOME") +@end lisp + +@noindent +Now you shall be able to open a remote connection with @kbd{C-x C-f +@trampfn{ssh, , 192.168.0.26#2222, }}, given that @command{sshd} +listens on port @samp{2222}. + +It is also recommended to add a corresponding entry to your +@file{~/.ssh/config} for that connection, like + +@example +Host android + HostName 192.168.0.26 + User root + Port 2222 +@end example + +@noindent +In this case, you must change the setting for the remote shell to + +@lisp +(add-to-list 'tramp-connection-properties + (list (regexp-quote "android") "remote-shell" "sh")) +@end lisp + +@noindent +You would open the connection with @kbd{C-x C-f @trampfn{ssh, , +android, }} then. + + @node Auto-save and Backup @section Auto-save and Backup configuration @cindex auto-save @@ -2359,6 +2406,13 @@ using the @option{ssh} method to transfer files, and edit @file{.emacs} in my home directory I would specify the filename @file{@trampfn{ssh, daniel, melancholia, .emacs}}. +@ifset emacs +A remote filename containing a host name only, which is equal to a +method name, is not allowed. If such a host name is used, it must +always be preceded by an explicit method name, like +@file{@value{prefix}ssh@value{postfixhop}ssh@value{postfix}}. +@end ifset + Finally, for some methods it is possible to specify a different port number than the default one, given by the method. This is specified by adding @file{#<port>} to the host name, like in @file{@trampfn{ssh, @@ -2944,7 +2998,7 @@ host as well as the time needed to perform the operations there count. In order to speed up @value{tramp}, one could either try to avoid some of the operations, or one could try to improve their performance. -Use an external method, like @option{scpc}. +Use an external method, like @option{scp}. Use caching. This is already enabled by default. Information about the remote host as well as the remote files are cached for reuse. The @@ -3070,17 +3124,42 @@ Host * @item -How can I use @samp{ControlPersist}? +@value{tramp} does not use my @command{ssh} @code{ControlPath} + +Your @code{ControlPath} setting will be overwritten by @command{ssh} +sessions initiated by @value{tramp}. This is because a master +session, initiated outside @value{emacsname}, could be closed, which +would stall all other @command{ssh} sessions for that host inside +@value{emacsname}. + +Consequently, if you connect to a remote host via @value{tramp}, you +might be prompted for a password again, even if you have established +already an @command{ssh} connection to that host. Further +@value{tramp} connections to that host, for example in order to run a +process on that host, will reuse that initial @command{ssh} +connection. + +If your @command{ssh} version supports the @code{ControlPersist} +option, you could customize the variable +@code{tramp-ssh-controlmaster-options} to use your @code{ControlPath}, +for example: -When @samp{ControlPersist} is set to @samp{yes}, the @option{scpc} -method does not work. You can use @option{scpx} instead with the -following settings in @file{~/.ssh/config}: +@lisp +(setq tramp-ssh-controlmaster-options + (concat + "-o ControlPath=/tmp/ssh-ControlPath-%%r@@%%h:%%p " + "-o ControlMaster=auto -o ControlPersist=yes")) +@end lisp -@example -Host * - ControlMaster auto - ControlPersist yes -@end example +Note, that "%r", "%h" and "%p" must be encoded as "%%r", "%%h" and +"%%p", respectively. The entries of @code{ControlPath}, +@code{ControlMaster} and @code{ControlPersist} can be removed from +this setting, if they are configured properly in your +@file{~/.ssh/config}: + +@lisp +(setq tramp-ssh-controlmaster-options "") +@end lisp @item diff --git a/doc/misc/trampver.texi b/doc/misc/trampver.texi index 3c0c3a7e19f..c22141335e1 100644 --- a/doc/misc/trampver.texi +++ b/doc/misc/trampver.texi @@ -8,7 +8,7 @@ @c In the Tramp CVS, the version number is auto-frobbed from @c configure.ac, so you should edit that file and run @c "autoconf && ./configure" to change the version number. -@set trampver 2.2.6-24.3 +@set trampver 2.2.8-pre @c Other flags from configuration @set instprefix /usr/local diff --git a/doc/misc/url.texi b/doc/misc/url.texi index 42b1624aa0a..49f8f3f0959 100644 --- a/doc/misc/url.texi +++ b/doc/misc/url.texi @@ -346,7 +346,7 @@ To use this function, you must @code{(require 'url-queue)}. The value of this option is an integer specifying the maximum number of concurrent @code{url-queue-retrieve} network processes. If the number of @code{url-queue-retrieve} calls is larger than this number, -later ones are queued until ealier ones are finished. +later ones are queued until earlier ones are finished. @end defopt @vindex url-queue-timeout diff --git a/doc/misc/vip.texi b/doc/misc/vip.texi index 327d8d5f45e..7c998b37010 100644 --- a/doc/misc/vip.texi +++ b/doc/misc/vip.texi @@ -40,7 +40,7 @@ modify this GNU manual.'' @end direntry @ifnottex -@node Top, Survey,, (DIR) +@node Top @top VIP VIP is a Vi emulating package written in Emacs Lisp. VIP implements most @@ -90,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 @@ -104,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 @@ -151,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: @@ -177,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}) @@ -257,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}) @@ -267,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 @@ -298,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. @@ -323,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}) @@ -334,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 @@ -347,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}) @@ -363,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}) @@ -378,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 @@ -404,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 @@ -424,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 @@ -438,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. @@ -530,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 @@ -590,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 @@ -614,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 @@ -635,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 @@ -656,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 @@ -683,7 +683,7 @@ Query replace. 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 @@ -704,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 @@ -725,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 @@ -775,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 @@ -842,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, @@ -923,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 @@ -991,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. @@ -1019,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 @@ -1213,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. @@ -1277,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 @@ -1315,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 @@ -1367,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 @@ -1403,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. @@ -1434,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. @@ -1467,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 @@ -1487,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. @@ -1608,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 @@ -1676,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}) @@ -1713,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 @@ -1859,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 @@ -1871,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 @@ -1907,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 @@ -1931,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 69df06a1c57..8b4c9e93f7c 100644 --- a/doc/misc/viper.texi +++ b/doc/misc/viper.texi @@ -46,9 +46,8 @@ modify this GNU manual.'' @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: @@ -99,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 @@ -155,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 @@ -185,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 @@ -313,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 @@ -368,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} @@ -474,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} @@ -506,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 @@ -666,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 @@ -726,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 @@ -758,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 @@ -808,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 @@ -883,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: @@ -904,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 @@ -926,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 @@ -997,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 @@ -1033,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 @@ -1072,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 @@ -1119,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 @@ -1130,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 @@ -1198,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 @@ -1222,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 @@ -1298,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. @@ -1487,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 @@ -1568,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 @@ -1614,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 @@ -1955,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 @@ -2193,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 @@ -2322,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 @@ -2707,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 @@ -2994,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 @@ -3013,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 @@ -3224,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 @@ -3239,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 @@ -3435,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}. @@ -3487,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 @@ -3569,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 @@ -3595,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 @@ -3638,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 @@ -3746,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 @@ -3829,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 @@ -3876,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 @@ -3902,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 @@ -3961,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 @@ -4113,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 @@ -4180,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) @@ -4246,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 @@ -4367,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 @@ -4417,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 @@ -4446,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 @@ -4521,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/wisent.texi b/doc/misc/wisent.texi index 958e4a72b86..d8557b84a4f 100644 --- a/doc/misc/wisent.texi +++ b/doc/misc/wisent.texi @@ -133,10 +133,11 @@ June 1985, Report No. UCB/CSD 85/251. @item For generating the lookahead sets, Wisent uses the well-known -technique of F. DeRemer and A. Pennello they described in: +technique of F. DeRemer and A. Pennello described in: @quotation -@cite{Efficient Construction of LALR(1) Lookahead Sets}@* -October 1982, ACM TOPLS Vol 4 No 4. +@cite{Efficient Computation of LALR(1) Look-Ahead Sets}@* +October 1982, ACM TOPLAS Vol 4 No 4, 615--49, +@uref{http://dx.doi.org/10.1145/69622.357187}. @end quotation @item @@ -224,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 @@ -283,7 +283,7 @@ For example, Says that two groupings of type @samp{exp}, with a @samp{+} token in between, can be combined into a larger grouping of type @samp{exp}. - + @cindex grammar coding conventions By convention, a nonterminal symbol should be in lower case, such as @samp{exp}, @samp{stmt} or @samp{declaration}. Terminal symbols @@ -443,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 @@ -559,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 @@ -618,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 @@ -1214,7 +1211,7 @@ data type. @item start @itemx end -Are the optionals beginning and end positions of @var{value} in the +Are the optional beginning and ending positions of @var{value} in the input stream. @end table @@ -1337,8 +1334,8 @@ of the current statement if an error is detected: @example @group -(stmnt (( error ?; )) ;; on error, skip until ';' is read - ) +(statement (( error ?; )) ;; on error, skip until ';' is read + ) @end group @end example @@ -1606,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 d7ef94872b4..9b9f9947da5 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: <2013-02-12 09:05:54 eggert> -@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. @@ -43,7 +39,7 @@ modify this GNU manual.'' @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 @@ -53,8 +49,6 @@ modify this GNU manual.'' @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 @@ -67,13 +61,11 @@ modify this GNU manual.'' @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} @@ -103,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 @@ -165,8 +156,7 @@ Reporting Bugs}. @c =================================================================== -@node Background, Finding, Introduction, Top -@comment node-name, next, previous, up +@node Background @chapter Background @cindex background @@ -295,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 @@ -352,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 @@ -434,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 @@ -469,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 @@ -496,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 @@ -546,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 @@ -584,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 @@ -615,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 @@ -631,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 @@ -677,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 @@ -721,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 @@ -789,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 @@ -831,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 @@ -852,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 @@ -910,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 @@ -1137,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 @@ -1181,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 @@ -1217,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 @@ -1255,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 @@ -1280,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 @@ -1305,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 @@ -1330,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 @@ -1387,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 @@ -1409,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 @@ -1421,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 |