aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorMiles Bader2005-10-15 00:26:05 +0000
committerMiles Bader2005-10-15 00:26:05 +0000
commit9fe76e1b256aefe892edf84beb1fdfaf5ab0efa1 (patch)
tree4570b6861b88c36c99783d4103d49c8658027834 /man
parent2f0837ccf0ba386b9a9aab0eac2bad3076491a93 (diff)
parentd3a597b7b41c2ebdb457e7c8bb037958138028f2 (diff)
downloademacs-9fe76e1b256aefe892edf84beb1fdfaf5ab0efa1.tar.gz
emacs-9fe76e1b256aefe892edf84beb1fdfaf5ab0efa1.zip
Revision: miles@gnu.org--gnu-2005/emacs--unicode--0--patch-91
Merge from emacs--cvs-trunk--0 Patches applied: * emacs--cvs-trunk--0 (patch 581-597) - Update from CVS - Merge from gnus--rel--5.10 * gnus--rel--5.10 (patch 133-141) - Update from CVS - Merge from emacs--cvs-trunk--0 - Update from CVS: texi/gnus.texi (RSS): Fix key description. - Update from CVS: texi/gnus.texi (Document Server Internals): Addition.
Diffstat (limited to 'man')
-rw-r--r--man/ChangeLog104
-rw-r--r--man/basic.texi11
-rw-r--r--man/building.texi72
-rw-r--r--man/calc.texi29
-rw-r--r--man/cmdargs.texi14
-rw-r--r--man/frames.texi67
-rw-r--r--man/gnus.texi107
-rw-r--r--man/info.texi480
-rw-r--r--man/org.texi4
-rw-r--r--man/speedbar.texi17
-rw-r--r--man/trampver.texi2
11 files changed, 540 insertions, 367 deletions
diff --git a/man/ChangeLog b/man/ChangeLog
index c2dbbc22328..3b98e7985fb 100644
--- a/man/ChangeLog
+++ b/man/ChangeLog
@@ -1,3 +1,107 @@
12005-10-14 Katsumi Yamaoka <yamaoka@jpl.org>
2
3 * gnus.texi (Document Server Internals): Addition.
4
52005-10-13 Katsumi Yamaoka <yamaoka@jpl.org>
6
7 * gnus.texi (A note on namespaces): Fix RFC reference.
8
92005-10-12 Katsumi Yamaoka <yamaoka@jpl.org>
10
11 * gnus.texi (RSS): Fix key description.
12
132005-10-11 Katsumi Yamaoka <yamaoka@jpl.org>
14
15 * gnus.texi: Emacs/w3 -> Emacs/W3.
16 (Browsing the Web): Fix description.
17 (Web Searches): Ditto.
18 (Customizing W3): Ditto.
19
202005-10-07 Katsumi Yamaoka <yamaoka@jpl.org>
21
22 * gnus.texi (Maildir): Clarify expire-age and expire-group.
23
242005-10-13 Kenichi Handa <handa@m17n.org>
25
26 * basic.texi (Position Info): Fix previous change.
27
282005-10-12 Jan Dj,Ad(Brv <jan.h.d@swipnet.se>
29
30 * cmdargs.texi (Icons X): Fix typo.
31
322005-10-12 Kenichi Handa <handa@m17n.org>
33
34 * basic.texi (Position Info): Describe the case that Emacs shows
35 "part of display ...".
36
372005-10-11 Jay Belanger <belanger@truman.edu>
38
39 * calc.texi (Integration): Mention using `a i' to compute definite
40 integrals.
41
422005-10-11 Juri Linkov <juri@jurta.org>
43
44 * info.texi: Rearrange nodes.
45 (Top): Update menu. Change ref `Info for Experts' to
46 `Advanced Info Commands'.
47 (Getting Started): Fix description of manual's parts.
48 (Help-Int): Change xref `Info Search' to `Search Index', and
49 `Expert Info' to `Advanced'.
50 (Advanced): Move node one level up.
51 (Search Text, Search Index): New nodes split out from `Info Search'.
52 (Go to node, Choose menu subtopic, Create Info buffer): New nodes
53 split out from `Advanced'.
54 (Advanced, Emacs Info Variables): De-document editing an Info file
55 in Info.
56 (Emacs Info Variables): Move node from `Expert Info' to `Advanced'.
57 (Creating an Info File): Delete node and move its text to
58 `Expert Info'.
59
602005-10-10 Jan Dj,Ad(Brv <jan.h.d@swipnet.se>
61
62 * cmdargs.texi (Icons X): -nb => -nbi
63
642005-10-10 Chong Yidong <cyd@stupidchicken.com>
65
66 * frames.texi (Speedbar): A couple more clarifications.
67
682005-10-11 Nick Roberts <nickrob@snap.net.nz>
69
70 * building.texi (GDB User Interface Layout): Improve diagram.
71 (Watch Expressions): Explain how to make speedbar global.
72 (Other GDB User Interface Buffers): Make references more precise.
73
742005-10-10 Carsten Dominik <dominik@science.uva.nl>
75
76 * org.texi: (Workflow states): Documented that change in keywords
77 becomes active only after restart of Emacs.
78
792005-10-09 Richard M. Stallman <rms@gnu.org>
80
81 * frames.texi (Speedbar): Clarify the text.
82
832005-10-09 Chong Yidong <cyd@stupidchicken.com>
84
85 * frames.texi (Speedbar): Add information on keybindings,
86 dismissing the speedbar, and buffer display mode. Link to
87 speedbar manual.
88
892005-10-09 Jan Dj,Ad(Brv <jan.h.d@swipnet.se>
90
91 * cmdargs.texi (Icons X): Removed options -i, -itype, --icon-type,
92 added -nb, --no-bitmap-icon.
93
942005-10-08 Michael Albinus <michael.albinus@gmx.de>
95
96 Sync with Tramp 2.0.51.
97
982005-10-08 Nick Roberts <nickrob@snap.net.nz>
99
100 * speedbar.texi (Introduction): Describe new location of speedbar
101 on menubar.
102 (Basic Key Bindings): Remove descriptions of bindings that have
103 been removed.
104
12005-10-07 Nick Roberts <nickrob@snap.net.nz> 1052005-10-07 Nick Roberts <nickrob@snap.net.nz>
2 106
3 * building.texi (GDB Graphical Interface): Add variables and 107 * building.texi (GDB Graphical Interface): Add variables and
diff --git a/man/basic.texi b/man/basic.texi
index 2f5aa3162e1..2c78de612ad 100644
--- a/man/basic.texi
+++ b/man/basic.texi
@@ -636,10 +636,17 @@ Char: c (0143, 99, 0x63) point=21044 of 26883(78%) column 53
636 The four values after @samp{Char:} describe the character that follows 636 The four values after @samp{Char:} describe the character that follows
637point, first by showing it and then by giving its character code in 637point, first by showing it and then by giving its character code in
638octal, decimal and hex. For a non-@acronym{ASCII} multibyte character, these are 638octal, decimal and hex. For a non-@acronym{ASCII} multibyte character, these are
639followed by @samp{ext} and the character's representation, in hex, in 639followed by @samp{file} and the character's representation, in hex, in
640the buffer's coding system, if that coding system encodes the character 640the buffer's coding system, if that coding system encodes the character
641safely and with a single byte (@pxref{Coding Systems}). If the 641safely and with a single byte (@pxref{Coding Systems}). If the
642character's encoding is longer than one byte, Emacs shows @samp{ext ...}. 642character's encoding is longer than one byte, Emacs shows @samp{file ...}.
643
644 However, if the character displayed is in the range 0200 through
6450377 octal, it may actually stand for an invalid UTF-8 byte read from
646a file. In Emacs, that byte is represented as a sequence of 8-bit
647characters, but all of them together display as the original invalid
648byte, in octal code. In this case, @kbd{C-x =} shows @samp{part of
649display ...} instead of @samp{file}.
643 650
644 @samp{point=} is followed by the position of point expressed as a character 651 @samp{point=} is followed by the position of point expressed as a character
645count. The front of the buffer counts as position 1, one character later 652count. The front of the buffer counts as position 1, one character later
diff --git a/man/building.texi b/man/building.texi
index a9a3cc049c7..eb7a8bb00fe 100644
--- a/man/building.texi
+++ b/man/building.texi
@@ -801,18 +801,21 @@ If @code{gdb-many-windows} is non-@code{nil}, regardless of the value of
801@code{gdb-use-inferior-io-buffer} is @code{nil}. In this case the 801@code{gdb-use-inferior-io-buffer} is @code{nil}. In this case the
802source buffer occupies the full width of the frame. 802source buffer occupies the full width of the frame.
803 803
804@multitable @columnfractions .5 .5 804@example
805@item GUD buffer (I/O of GDB) 805+--------------------------------+--------------------------------+
806@tab Locals buffer 806| | |
807@item 807| GUD buffer (I/O of GDB) | Locals buffer |
808@tab 808| | |
809@item Source buffer 809|--------------------------------+--------------------------------+
810@tab Input/Output (of inferior) buffer 810| | |
811@item 811| Source buffer | I/O buffer (of inferior) |
812@tab 812| | |
813@item Stack buffer 813|--------------------------------+--------------------------------+
814@tab Breakpoints buffer 814| | |
815@end multitable 815| Stack buffer | Breakpoints buffer |
816| | |
817+--------------------------------+--------------------------------+
818@end example
816 819
817To toggle this layout, do @kbd{M-x gdb-many-windows}. 820To toggle this layout, do @kbd{M-x gdb-many-windows}.
818 821
@@ -822,12 +825,12 @@ re-compiling your program, then you can restore it with the command
822@code{gdb-restore-windows}. 825@code{gdb-restore-windows}.
823 826
824You may also choose which additional buffers you want to display, 827You may also choose which additional buffers you want to display,
825either in the same frame or a different one. Select GDB-windows or 828either in the same frame or a different one. Select them from
826GDB-Frames from the menu-bar under the heading GUD. If the menu-bar 829@samp{GUD->GDB-windows} or @samp{GUD->GDB-Frames} sub-menu
827is unavailable, type @code{M-x 830respectively. If the menu-bar is unavailable, type @code{M-x
828gdb-display-@var{buffertype}-buffer} or @code{M-x 831gdb-display-@var{buffertype}-buffer} or @code{M-x
829gdb-frame-@var{buffertype}-buffer} respectively, where @var{buffertype} 832gdb-frame-@var{buffertype}-buffer} respectively, where
830is the relevant buffer type e.g breakpoints. 833@var{buffertype} is the relevant buffer type e.g breakpoints.
831 834
832When you finish debugging then kill the GUD buffer with @kbd{C-x k}, 835When you finish debugging then kill the GUD buffer with @kbd{C-x k},
833which will also kill all the buffers associated with the session. 836which will also kill all the buffers associated with the session.
@@ -874,7 +877,7 @@ the current line (@code{gdb-goto-breakpoint}). Alternatively, click
874 877
875The stack buffer displays a @dfn{call stack}, with one line for each 878The stack buffer displays a @dfn{call stack}, with one line for each
876of the nested subroutine calls (@dfn{stack frames}) now active in the 879of the nested subroutine calls (@dfn{stack frames}) now active in the
877program. @xref{Backtrace,,info stack, gdb, The GNU debugger}. 880program. @xref{Backtrace,, Backtraces, gdb, The GNU debugger}.
878 881
879@findex gdb-frames-select 882@findex gdb-frames-select
880The selected frame number is displayed in reverse contrast. Move 883The selected frame number is displayed in reverse contrast. Move
@@ -898,6 +901,12 @@ types, such as arrays, structures and unions are represented in a tree
898format. To expand or contract a complex data type, click @kbd{Mouse-2} 901format. To expand or contract a complex data type, click @kbd{Mouse-2}
899on the tag to the left of the expression. 902on the tag to the left of the expression.
900 903
904By default, watch expressions only display in the speedbar when the
905GUD buffer is selected in the attached frame. If you want your watch
906expressions to remain visible at all times then select the @samp{GUD}
907radio button on the @samp{Speedbar->Displays} sub-menu using
908@kbd{Mouse-3}.
909
901@findex gdb-var-delete 910@findex gdb-var-delete
902With the cursor over the root expression of a complex data type, type 911With the cursor over the root expression of a complex data type, type
903@kbd{D} to delete it from the speedbar 912@kbd{D} to delete it from the speedbar
@@ -936,8 +945,8 @@ available here. @xref{Shell Mode}.
936 945
937@item Locals Buffer 946@item Locals Buffer
938The locals buffer displays the values of local variables of the 947The locals buffer displays the values of local variables of the
939current frame for simple data types (@pxref{Frame Info,,, gdb, The GNU 948current frame for simple data types (@pxref{Frame Info, Frame Info,
940debugger}). 949Information on a frame, gdb, The GNU debugger}).
941 950
942Arrays and structures display their type only. You must display them 951Arrays and structures display their type only. You must display them
943separately to examine their values. @xref{Watch Expressions}. 952separately to examine their values. @xref{Watch Expressions}.
@@ -958,20 +967,21 @@ appear in the fringe or margin.
958@item Threads Buffer 967@item Threads Buffer
959@findex gdb-threads-select 968@findex gdb-threads-select
960The threads buffer displays a summary of all threads currently in your 969The threads buffer displays a summary of all threads currently in your
961program (@pxref{Threads,,, gdb, The GNU debugger}). Move point to any 970program (@pxref{Threads, Threads, Debugging programs with multiple
962thread in the list and press @key{RET} to select it 971threads, gdb, The GNU debugger}). Move point to any thread in the
963(@code{gdb-threads-select}) and display the associated source in the 972list and press @key{RET} to select it (@code{gdb-threads-select}) and
964source buffer. Alternatively, click @kbd{Mouse-2} on a thread to 973display the associated source in the source buffer. Alternatively,
965select it. If the locals buffer is displayed then its contents update 974click @kbd{Mouse-2} on a thread to select it. If the locals buffer is
966to display the variables that are local to the new thread. 975displayed then its contents update to display the variables that are
976local to the new thread.
967 977
968@item Memory Buffer 978@item Memory Buffer
969The memory buffer allows the user to examine sections of program 979The memory buffer allows the user to examine sections of program
970memory (@pxref{Memory,,, gdb, The GNU debugger}). Click @kbd{Mouse-1} 980memory (@pxref{Memory, Memory, Examining memory, gdb, The GNU
971on the appropriate part of the header line to change the starting 981debugger}). Click @kbd{Mouse-1} on the appropriate part of the header
972address or number of data items that the buffer displays. 982line to change the starting address or number of data items that the
973Click @kbd{Mouse-3} on the header line to select the display format 983buffer displays. Click @kbd{Mouse-3} on the header line to select the
974or unit size for these data items. 984display format or unit size for these data items.
975 985
976@end table 986@end table
977 987
diff --git a/man/calc.texi b/man/calc.texi
index 36f9f68eecd..6e397a0052c 100644
--- a/man/calc.texi
+++ b/man/calc.texi
@@ -12817,7 +12817,9 @@ If you press @kbd{m v} with a numeric prefix argument @var{n}, you
12817get a special ``dimensioned'' Matrix mode in which matrices of 12817get a special ``dimensioned'' Matrix mode in which matrices of
12818unknown size are assumed to be @var{n}x@var{n} square matrices. 12818unknown size are assumed to be @var{n}x@var{n} square matrices.
12819Then, the function call @samp{idn(1)} will expand into an actual 12819Then, the function call @samp{idn(1)} will expand into an actual
12820matrix rather than representing a ``generic'' matrix. 12820matrix rather than representing a ``generic'' matrix. Simply typing
12821@kbd{C-u m v} will get you a square Matrix mode, in which matrices of
12822unknown size are assumed to be square matrices of unspecified size.
12821 12823
12822@cindex Declaring scalar variables 12824@cindex Declaring scalar variables
12823Of course these modes are approximations to the true state of 12825Of course these modes are approximations to the true state of
@@ -13205,6 +13207,8 @@ The value is not a vector.
13205The value is a vector. 13207The value is a vector.
13206@item matrix 13208@item matrix
13207The value is a matrix (a rectangular vector of vectors). 13209The value is a matrix (a rectangular vector of vectors).
13210@item sqmatrix
13211The value is a square matrix.
13208@end table 13212@end table
13209 13213
13210These type symbols can be combined with the other type symbols 13214These type symbols can be combined with the other type symbols
@@ -15978,7 +15982,8 @@ Command is @kbd{m p}.
15978 15982
15979@item 15983@item
15980Matrix/Scalar mode. Default value is @mathit{-1}. Value is 0 for Scalar 15984Matrix/Scalar mode. Default value is @mathit{-1}. Value is 0 for Scalar
15981mode, @mathit{-2} for Matrix mode, or @var{N} for 15985mode, @mathit{-2} for Matrix mode, @mathit{-3} for square Matrix mode,
15986or @var{N} for
15982@texline @math{N\times N} 15987@texline @math{N\times N}
15983@infoline @var{N}x@var{N} 15988@infoline @var{N}x@var{N}
15984Matrix mode. Command is @kbd{m v}. 15989Matrix mode. Command is @kbd{m v}.
@@ -16056,7 +16061,10 @@ Symbolic mode (@kbd{m s}; @pxref{Symbolic Mode}).
16056Matrix mode (@kbd{m v}; @pxref{Matrix Mode}). 16061Matrix mode (@kbd{m v}; @pxref{Matrix Mode}).
16057 16062
16058@item Matrix@var{n} 16063@item Matrix@var{n}
16059Dimensioned Matrix mode (@kbd{C-u @var{n} m v}). 16064Dimensioned Matrix mode (@kbd{C-u @var{n} m v}; @pxref{Matrix Mode}).
16065
16066@item SqMatrix
16067Square Matrix mode (@kbd{C-u m v}; @pxref{Matrix Mode}).
16060 16068
16061@item Scalar 16069@item Scalar
16062Scalar mode (@kbd{m v}; @pxref{Matrix Mode}). 16070Scalar mode (@kbd{m v}; @pxref{Matrix Mode}).
@@ -23498,11 +23506,11 @@ argument once).
23498@tindex integ 23506@tindex integ
23499The @kbd{a i} (@code{calc-integral}) [@code{integ}] command computes the 23507The @kbd{a i} (@code{calc-integral}) [@code{integ}] command computes the
23500indefinite integral of the expression on the top of the stack with 23508indefinite integral of the expression on the top of the stack with
23501respect to a variable. The integrator is not guaranteed to work for 23509respect to a prompted-for variable. The integrator is not guaranteed to
23502all integrable functions, but it is able to integrate several large 23510work for all integrable functions, but it is able to integrate several
23503classes of formulas. In particular, any polynomial or rational function 23511large classes of formulas. In particular, any polynomial or rational
23504(a polynomial divided by a polynomial) is acceptable. (Rational functions 23512function (a polynomial divided by a polynomial) is acceptable.
23505don't have to be in explicit quotient form, however; 23513(Rational functions don't have to be in explicit quotient form, however;
23506@texline @math{x/(1+x^{-2})} 23514@texline @math{x/(1+x^{-2})}
23507@infoline @expr{x/(1+x^-2)} 23515@infoline @expr{x/(1+x^-2)}
23508is not strictly a quotient of polynomials, but it is equivalent to 23516is not strictly a quotient of polynomials, but it is equivalent to
@@ -23511,6 +23519,11 @@ is not strictly a quotient of polynomials, but it is equivalent to
23511integrated. Finally, rational functions involving trigonometric or 23519integrated. Finally, rational functions involving trigonometric or
23512hyperbolic functions can be integrated. 23520hyperbolic functions can be integrated.
23513 23521
23522With an argument (@kbd{C-u a i}), this command will compute the definite
23523integral of the expression on top of the stack. In this case, the
23524command will again prompt for an integration variable, then prompt for a
23525lower limit and an upper limit.
23526
23514@ifinfo 23527@ifinfo
23515If you use the @code{integ} function directly in an algebraic formula, 23528If you use the @code{integ} function directly in an algebraic formula,
23516you can also write @samp{integ(f,x,v)} which expresses the resulting 23529you can also write @samp{integ(f,x,v)} which expresses the resulting
diff --git a/man/cmdargs.texi b/man/cmdargs.texi
index dad7e61dbf2..28cb567f0cd 100644
--- a/man/cmdargs.texi
+++ b/man/cmdargs.texi
@@ -1173,12 +1173,12 @@ If you have many clients running at once, you can avoid cluttering up
1173the screen by iconifying most of the clients. 1173the screen by iconifying most of the clients.
1174 1174
1175@table @samp 1175@table @samp
1176@item -i 1176@item -nbi
1177@opindex -i 1177@opindex -nbi
1178@itemx --icon-type 1178@itemx --no-bitmap-icon
1179@opindex --icon-type 1179@opindex --no-bitmap-icon
1180@cindex Emacs icon, a gnu 1180@cindex Emacs icon, a gnu
1181Use a picture of a gnu as the Emacs icon. 1181Do not use a picture of a gnu as the Emacs icon.
1182 1182
1183@item -iconic 1183@item -iconic
1184@opindex --iconic 1184@opindex --iconic
@@ -1187,8 +1187,8 @@ Use a picture of a gnu as the Emacs icon.
1187Start Emacs in iconified state. 1187Start Emacs in iconified state.
1188@end table 1188@end table
1189 1189
1190 The @samp{-i} or @samp{--icon-type} option tells Emacs to use an icon 1190 By default Emacs uses an icon window containing a picture of the GNU gnu.
1191window containing a picture of the GNU gnu. If omitted, Emacs lets the 1191The @samp{-nbi} or @samp{--no-bitmap-icon} option tells Emacs to let the
1192window manager choose what sort of icon to use---usually just a small 1192window manager choose what sort of icon to use---usually just a small
1193rectangle containing the frame's title. 1193rectangle containing the frame's title.
1194 1194
diff --git a/man/frames.texi b/man/frames.texi
index 2928aa7a62a..daaa9599bf7 100644
--- a/man/frames.texi
+++ b/man/frames.texi
@@ -545,26 +545,53 @@ selects it, that variable should be @code{t}; if a click is necessary,
545the variable should be @code{nil}. 545the variable should be @code{nil}.
546 546
547@node Speedbar 547@node Speedbar
548@section Making and Using a Speedbar Frame 548@section Speedbar Frames
549@cindex speedbar 549@cindex speedbar
550 550
551 An Emacs frame can have a @dfn{speedbar}, which is a vertical window 551@cindex attached frame (of speedbar)
552that serves as a scrollable menu of files you could visit and tags 552 The @dfn{speedbar} is a special frame for conveniently navigating in
553within those files. To create a speedbar, type @kbd{M-x speedbar}; this 553or operating on another frame. The speedbar, when it exists, is
554creates a speedbar window for the selected frame. From then on, you can 554always associated with a specific frame, called its @dfn{attached
555click on a file name in the speedbar to visit that file in the 555frame}; all speedbar operations act on that frame.
556corresponding Emacs frame, or click on a tag name to jump to that tag in 556
557the Emacs frame. 557 Type @kbd{M-x speedbar} to create the speedbar and associate it with
558 558the current frame. To dismiss the speedbar, type @kbd{M-x speedbar}
559 Initially the speedbar lists the immediate contents of the current 559again, or select the speedbar and type @kbd{q}. (You can also delete
560directory, one file per line. Each line also has a box, @samp{[+]} or 560the speedbar frame like any other Emacs frame.) If you wish to
561@samp{<+>}, that you can click on with @kbd{Mouse-2} to ``open up'' the 561associate the speedbar with a different frame, dismiss it and call
562contents of that item. If the line names a directory, opening it adds 562@kbd{M-x speedbar} from that frame.
563
564 The speedbar can operate in various modes. Its default mode is
565@dfn{File Display} mode, which shows the files in the current
566directory of the selected window of the attached frame, one file per
567line. Clicking on a file name visits that file in the selected window
568of the attached frame, and clicking on a directory name shows that
569directory in the speedbar (@pxref{Mouse References}). Each line also
570has a box, @samp{[+]} or @samp{<+>}, that you can click on to
571@dfn{expand} the contents of that item. Expanding a directory adds
563the contents of that directory to the speedbar display, underneath the 572the contents of that directory to the speedbar display, underneath the
564directory's own line. If the line lists an ordinary file, opening it up 573directory's own line. Expanding an ordinary file adds a list of the
565adds a list of the tags in that file to the speedbar display. When a 574tags in that file to the speedbar display; you can click on a tag name
566file is opened up, the @samp{[+]} changes to @samp{[-]}; you can click 575to jump to that tag in the selected window of the attached frame.
567on that box to ``close up'' that file (hide its contents). 576When a file or directory is expanded, the @samp{[+]} changes to
577@samp{[-]}; you can click on that box to @dfn{contract} the item,
578hiding its contents.
579
580 You navigate through the speedbar using the keyboard, too. Typing
581@kbd{RET} while point is on a line in the speedbar is equivalent to
582clicking the item on the current line, and @kbd{SPC} expands or
583contracts the item. @kbd{U} displays the parent directory of the
584current directory. To copy, delete, or rename the file on the current
585line, type @kbd{C}, @kbd{D}, and @kbd{R} respectively. To create a
586new directory, type @kbd{M}.
587
588 Another general-purpose speedbar mode is @dfn{Buffer Display} mode;
589in this mode, the speedbar displays a list of Emacs buffers. To
590switch to this mode, type @kbd{b} in the speedbar. To return to File
591Display mode, type @kbd{f}. You can also change the display mode by
592clicking @kbd{mouse-3} anywhere in the speedbar window (or
593@kbd{mouse-1} on the mode-line) and selecting @samp{Displays} in the
594pop-up menu.
568 595
569 Some major modes, including Rmail mode, Info, and GUD, have 596 Some major modes, including Rmail mode, Info, and GUD, have
570specialized ways of putting useful items into the speedbar for you to 597specialized ways of putting useful items into the speedbar for you to
@@ -572,10 +599,8 @@ select. For example, in Rmail mode, the speedbar shows a list of Rmail
572files, and lets you move the current message to another Rmail file by 599files, and lets you move the current message to another Rmail file by
573clicking on its @samp{<M>} box. 600clicking on its @samp{<M>} box.
574 601
575 A speedbar belongs to one Emacs frame, and always operates on that 602 For more details on using and programming the speedbar, @xref{Top,
576frame. If you use multiple frames, you can make a speedbar for some or 603Speedbar,,speedbar, Speedbar Manual}.
577all of the frames; type @kbd{M-x speedbar} in any given frame to make a
578speedbar for it.
579 604
580@node Multiple Displays 605@node Multiple Displays
581@section Multiple Displays 606@section Multiple Displays
diff --git a/man/gnus.texi b/man/gnus.texi
index 7ced947a5ce..1a66bd763e0 100644
--- a/man/gnus.texi
+++ b/man/gnus.texi
@@ -683,7 +683,7 @@ Browsing the Web
683* Ultimate:: The Ultimate Bulletin Board systems. 683* Ultimate:: The Ultimate Bulletin Board systems.
684* Web Archive:: Reading mailing list archived on web. 684* Web Archive:: Reading mailing list archived on web.
685* RSS:: Reading RDF site summary. 685* RSS:: Reading RDF site summary.
686* Customizing w3:: Doing stuff to Emacs/w3 from Gnus. 686* Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
687 687
688@acronym{IMAP} 688@acronym{IMAP}
689 689
@@ -8569,8 +8569,8 @@ Customization, emacs-mime, The Emacs MIME Manual}) to convert the
8569can use include: 8569can use include:
8570 8570
8571@table @code 8571@table @code
8572@item w3 8572@item W3
8573Use Emacs/w3. 8573Use Emacs/W3.
8574 8574
8575@item w3m 8575@item w3m
8576Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}. 8576Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
@@ -15093,8 +15093,9 @@ An integer specifying the minimum age, in seconds, of an article
15093before it will be expired, or the symbol @code{never} to specify that 15093before it will be expired, or the symbol @code{never} to specify that
15094articles should never be expired. If this parameter is not set, 15094articles should never be expired. If this parameter is not set,
15095@code{nnmaildir} falls back to the usual 15095@code{nnmaildir} falls back to the usual
15096@code{nnmail-expiry-wait}(@code{-function}) variables (overrideable by 15096@code{nnmail-expiry-wait}(@code{-function}) variables (the
15097the @code{expiry-wait}(@code{-function}) group parameters. If you 15097@code{expiry-wait} group parameter overrides @code{nnmail-expiry-wait}
15098and makes @code{nnmail-expiry-wait-function} ineffective). If you
15098wanted a value of 3 days, you could use something like @code{[(* 3 24 15099wanted a value of 3 days, you could use something like @code{[(* 3 24
1509960 60)]}; @code{nnmaildir} will evaluate the form and use the result. 1510060 60)]}; @code{nnmaildir} will evaluate the form and use the result.
15100An article's age is measured starting from the article file's 15101An article's age is measured starting from the article file's
@@ -15117,8 +15118,8 @@ the parameter belongs to, then the article is not expired at all. If
15117you use the vector form, the first element is evaluated once for each 15118you use the vector form, the first element is evaluated once for each
15118article. So that form can refer to 15119article. So that form can refer to
15119@code{nnmaildir-article-file-name}, etc., to decide where to put the 15120@code{nnmaildir-article-file-name}, etc., to decide where to put the
15120article. @emph{If this parameter is not set, @code{nnmaildir} does 15121article. @emph{Even if this parameter is not set, @code{nnmaildir}
15121not fall back to the @code{expiry-target} group parameter or the 15122does not fall back to the @code{expiry-target} group parameter or the
15122@code{nnmail-expiry-target} variable.} 15123@code{nnmail-expiry-target} variable.}
15123 15124
15124@item read-only 15125@item read-only
@@ -15534,10 +15535,11 @@ interfaces to these sources.
15534* Ultimate:: The Ultimate Bulletin Board systems. 15535* Ultimate:: The Ultimate Bulletin Board systems.
15535* Web Archive:: Reading mailing list archived on web. 15536* Web Archive:: Reading mailing list archived on web.
15536* RSS:: Reading RDF site summary. 15537* RSS:: Reading RDF site summary.
15537* Customizing w3:: Doing stuff to Emacs/w3 from Gnus. 15538* Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
15538@end menu 15539@end menu
15539 15540
15540All the web sources require Emacs/w3 and the url library to work. 15541All the web sources require Emacs/W3 and the url library or those
15542alternatives to work.
15541 15543
15542The main caveat with all these web sources is that they probably won't 15544The main caveat with all these web sources is that they probably won't
15543work for a very long time. Gleaning information from the @acronym{HTML} data 15545work for a very long time. Gleaning information from the @acronym{HTML} data
@@ -15624,8 +15626,9 @@ make money off of advertisements, not to provide services to the
15624community. Since @code{nnweb} washes the ads off all the articles, one 15626community. Since @code{nnweb} washes the ads off all the articles, one
15625might think that the providers might be somewhat miffed. We'll see. 15627might think that the providers might be somewhat miffed. We'll see.
15626 15628
15627You must have the @code{url} and @code{w3} package installed to be able 15629You must have the @code{url} and @code{W3} package or those alternatives
15628to use @code{nnweb}. 15630(try @code{customize-group} on the @samp{mm-url} variable group)
15631installed to be able to use @code{nnweb}.
15629 15632
15630Virtual server variables: 15633Virtual server variables:
15631 15634
@@ -15845,9 +15848,9 @@ system because @acronym{RSS} uses UTF-8 for encoding non-@acronym{ASCII}
15845text by default. It is also used by default for non-@acronym{ASCII} 15848text by default. It is also used by default for non-@acronym{ASCII}
15846group names. 15849group names.
15847 15850
15848@kindex G R (Summary) 15851@kindex G R (Group)
15849Use @kbd{G R} from the summary buffer to subscribe to a feed---you will 15852Use @kbd{G R} from the group buffer to subscribe to a feed---you will be
15850be prompted for the location, the title and the description of the feed. 15853prompted for the location, the title and the description of the feed.
15851The title, which allows any characters, will be used for the group name 15854The title, which allows any characters, will be used for the group name
15852and the name of the group data file. The description can be omitted. 15855and the name of the group data file. The description can be omitted.
15853 15856
@@ -15940,18 +15943,19 @@ summary buffer.
15940(add-to-list 'nnmail-extra-headers nnrss-url-field) 15943(add-to-list 'nnmail-extra-headers nnrss-url-field)
15941@end lisp 15944@end lisp
15942 15945
15943@node Customizing w3 15946@node Customizing W3
15944@subsection Customizing w3 15947@subsection Customizing W3
15945@cindex w3 15948@cindex W3
15946@cindex html 15949@cindex html
15947@cindex url 15950@cindex url
15948@cindex Netscape 15951@cindex Netscape
15949 15952
15950Gnus uses the url library to fetch web pages and Emacs/w3 to display web 15953Gnus uses the url library to fetch web pages and Emacs/W3 (or those
15951pages. Emacs/w3 is documented in its own manual, but there are some 15954alternatives) to display web pages. Emacs/W3 is documented in its own
15952things that may be more relevant for Gnus users. 15955manual, but there are some things that may be more relevant for Gnus
15956users.
15953 15957
15954For instance, a common question is how to make Emacs/w3 follow links 15958For instance, a common question is how to make Emacs/W3 follow links
15955using the @code{browse-url} functions (which will call some external web 15959using the @code{browse-url} functions (which will call some external web
15956browser like Netscape). Here's one way: 15960browser like Netscape). Here's one way:
15957 15961
@@ -15966,7 +15970,7 @@ browser like Netscape). Here's one way:
15966 (w3-fetch-orig url target))))) 15970 (w3-fetch-orig url target)))))
15967@end lisp 15971@end lisp
15968 15972
15969Put that in your @file{.emacs} file, and hitting links in w3-rendered 15973Put that in your @file{.emacs} file, and hitting links in W3-rendered
15970@acronym{HTML} in the Gnus article buffers will use @code{browse-url} to 15974@acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
15971follow the link. 15975follow the link.
15972 15976
@@ -16559,7 +16563,7 @@ delete them.
16559@cindex namespaces 16563@cindex namespaces
16560 16564
16561The @acronym{IMAP} protocol has a concept called namespaces, described 16565The @acronym{IMAP} protocol has a concept called namespaces, described
16562by the following text in the RFC: 16566by the following text in the RFC2060:
16563 16567
16564@display 16568@display
165655.1.2. Mailbox Namespace Naming Convention 165695.1.2. Mailbox Namespace Naming Convention
@@ -16891,34 +16895,48 @@ totally ignored.
16891 16895
16892@item article-begin 16896@item article-begin
16893This setting has to be present in all document type definitions. It 16897This setting has to be present in all document type definitions. It
16894says what the beginning of each article looks like. 16898says what the beginning of each article looks like. To do more
16899complicated things that cannot be dealt with a simple regexp, you can
16900use @code{article-begin-function} instead of this.
16895 16901
16896@item head-begin-function 16902@item article-begin-function
16897If present, this should be a function that moves point to the head of 16903If present, this should be a function that moves point to the beginning
16898the article. 16904of each article. This setting overrides @code{article-begin}.
16899 16905
16900@item nndoc-head-begin 16906@item head-begin
16901If present, this should be a regexp that matches the head of the 16907If present, this should be a regexp that matches the head of the
16902article. 16908article. To do more complicated things that cannot be dealt with a
16909simple regexp, you can use @code{head-begin-function} instead of this.
16903 16910
16904@item nndoc-head-end 16911@item head-begin-function
16912If present, this should be a function that moves point to the head of
16913the article. This setting overrides @code{head-begin}.
16914
16915@item head-end
16905This should match the end of the head of the article. It defaults to 16916This should match the end of the head of the article. It defaults to
16906@samp{^$}---the empty line. 16917@samp{^$}---the empty line.
16907 16918
16919@item body-begin
16920This should match the beginning of the body of the article. It defaults
16921to @samp{^\n}. To do more complicated things that cannot be dealt with
16922a simple regexp, you can use @code{body-begin-function} instead of this.
16923
16908@item body-begin-function 16924@item body-begin-function
16909If present, this function should move point to the beginning of the body 16925If present, this function should move point to the beginning of the body
16910of the article. 16926of the article. This setting overrides @code{body-begin}.
16911 16927
16912@item body-begin 16928@item body-end
16913This should match the beginning of the body of the article. It defaults 16929If present, this should match the end of the body of the article. To do
16914to @samp{^\n}. 16930more complicated things that cannot be dealt with a simple regexp, you
16931can use @code{body-end-function} instead of this.
16915 16932
16916@item body-end-function 16933@item body-end-function
16917If present, this function should move point to the end of the body of 16934If present, this function should move point to the end of the body of
16918the article. 16935the article. This setting overrides @code{body-end}.
16919 16936
16920@item body-end 16937@item file-begin
16921If present, this should match the end of the body of the article. 16938If present, this should match the beginning of the file. All text
16939before this regexp will be totally ignored.
16922 16940
16923@item file-end 16941@item file-end
16924If present, this should match the end of the file. All text after this 16942If present, this should match the end of the file. All text after this
@@ -16949,6 +16967,19 @@ understand. It is called with the article number as a parameter, and is
16949expected to generate a nice head for the article in question. It is 16967expected to generate a nice head for the article in question. It is
16950called when requesting the headers of all articles. 16968called when requesting the headers of all articles.
16951 16969
16970@item generate-article-function
16971If present, this function is called to generate an entire article that
16972Gnus can understand. It is called with the article number as a
16973parameter when requesting all articles.
16974
16975@item dissection-function
16976If present, this function is called to dissect a document by itself,
16977overriding @code{first-article}, @code{article-begin},
16978@code{article-begin-function}, @code{head-begin},
16979@code{head-begin-function}, @code{head-end}, @code{body-begin},
16980@code{body-begin-function}, @code{body-end}, @code{body-end-function},
16981@code{file-begin}, and @code{file-end}.
16982
16952@end table 16983@end table
16953 16984
16954Let's look at the most complicated example I can come up with---standard 16985Let's look at the most complicated example I can come up with---standard
@@ -24388,7 +24419,7 @@ XEmacs is distributed as a collection of packages. You should install
24388whatever packages the Gnus XEmacs package requires. The current 24419whatever packages the Gnus XEmacs package requires. The current
24389requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base}, 24420requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
24390@samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils}, 24421@samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
24391@samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{w3}, 24422@samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{W3},
24392@samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}. 24423@samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
24393 24424
24394 24425
diff --git a/man/info.texi b/man/info.texi
index 95e736ab246..532478ca521 100644
--- a/man/info.texi
+++ b/man/info.texi
@@ -72,28 +72,28 @@ If you are new to the Info reader and want to learn how to use it,
72type the command @kbd{h} now. It brings you to a programmed 72type the command @kbd{h} now. It brings you to a programmed
73instruction sequence. 73instruction sequence.
74 74
75To read about expert-level Info commands, type @kbd{n} twice. This 75To read about advanced Info commands, type @kbd{n} twice. This
76brings you to @cite{Info for Experts}, skipping over the `Getting 76brings you to @cite{Advanced Info Commands}, skipping over the `Getting
77Started' chapter. 77Started' chapter.
78@end ifinfo 78@end ifinfo
79@end ifnottex 79@end ifnottex
80 80
81@menu 81@menu
82* Getting Started:: Getting started using an Info reader. 82* Getting Started:: Getting started using an Info reader.
83* Advanced:: Advanced Info commands.
83* Expert Info:: Info commands for experts. 84* Expert Info:: Info commands for experts.
84* Creating an Info File:: How to make your own Info file.
85* Index:: An index of topics, commands, and variables. 85* Index:: An index of topics, commands, and variables.
86@end menu 86@end menu
87 87
88@node Getting Started, Expert Info, Top, Top 88@node Getting Started, Advanced, Top, Top
89@comment node-name, next, previous, up 89@comment node-name, next, previous, up
90@chapter Getting Started 90@chapter Getting Started
91 91
92This first part of this Info manual describes how to get around inside 92This first part of this Info manual describes how to get around inside
93of Info. The second part of the manual describes various advanced 93of Info. The second part of the manual describes various advanced
94Info commands, and how to write an Info as distinct from a Texinfo 94Info commands. The third part briefly explains how to generate Info
95file. The third part briefly explains how to generate Info files from 95files from Texinfo files, and describes how to write an Info as
96Texinfo files. 96distinct from a Texinfo file.
97 97
98@ifnotinfo 98@ifnotinfo
99This manual is primarily designed for browsing with an Info reader 99This manual is primarily designed for browsing with an Info reader
@@ -847,7 +847,7 @@ describes the topic you want.
847 There is also a short-cut Info command, @kbd{i}, which does all of 847 There is also a short-cut Info command, @kbd{i}, which does all of
848that for you. It searches the index for a given topic (a string) and 848that for you. It searches the index for a given topic (a string) and
849goes to the node which is listed in the index for that topic. 849goes to the node which is listed in the index for that topic.
850@xref{Info Search}, for a full explanation. 850@xref{Search Index}, for a full explanation.
851 851
852@kindex l @r{(Info mode)} 852@kindex l @r{(Info mode)}
853@findex Info-history-back 853@findex Info-history-back
@@ -905,45 +905,129 @@ is @code{Info-top-node}.
905>> Now type @kbd{n} to see the last node of the course. 905>> Now type @kbd{n} to see the last node of the course.
906@end format 906@end format
907 907
908 @xref{Expert Info}, for more advanced Info features. 908 @xref{Advanced}, for more advanced Info features.
909 909
910@c If a menu appears at the end of this node, remove it. 910@c If a menu appears at the end of this node, remove it.
911@c It is an accident of the menu updating command. 911@c It is an accident of the menu updating command.
912 912
913@node Expert Info 913@node Advanced
914@chapter Info for Experts 914@chapter Advanced Info Commands
915 915
916 This chapter describes various Info commands for experts. (If you 916 This chapter describes various advanced Info commands. (If you
917are using a stand-alone Info reader, there are additional commands 917are using a stand-alone Info reader, there are additional commands
918specific to it, which are documented in several chapters of @ref{Top,, 918specific to it, which are documented in several chapters of @ref{Top,,
919GNU Info, info-stnd, GNU Info}.) 919GNU Info, info-stnd, GNU Info}.)
920 920
921 This chapter also explains how to write an Info as distinct from a
922Texinfo file. (However, in most cases, writing a Texinfo file is
923better, since you can use it to make a printed manual or produce other
924formats, such as HTML and DocBook, as well as for generating Info
925files.) @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU
926Documentation Format}.
927
928@menu 921@menu
929* Advanced:: Advanced Info commands: g, e, and 1 - 9. 922* Search Text:: How to search Info documents.
930* Info Search:: How to search Info documents for specific subjects. 923* Search Index:: How to search the indices for specific subjects.
931* Add:: Describes how to add new nodes to the hierarchy. 924* Go to node:: How to go to a node by name.
932 Also tells what nodes look like. 925* Choose menu subtopic:: How to choose a menu subtopic by its number.
933* Menus:: How to add to or create menus in Info nodes. 926* Create Info buffer:: How to create a new Info buffer in Emacs.
934* Cross-refs:: How to add cross-references to Info nodes.
935* Tags:: How to make tags tables for Info files.
936* Checking:: Checking an Info File.
937* Emacs Info Variables:: Variables modifying the behavior of Emacs Info. 927* Emacs Info Variables:: Variables modifying the behavior of Emacs Info.
938@end menu 928@end menu
939 929
940@node Advanced, Info Search, , Expert Info 930@node Search Text, Search Index, , Advanced
931@comment node-name, next, previous, up
932@section How to search Info documents
933
934@cindex searching Info documents
935@cindex Info document as a reference
936 The commands which move between and inside nodes allow you to read
937the entire manual or its large portions. But what if you need to find
938some information in the manual as fast as you can, and you don't know
939or don't remember in what node to look for it? This need arises when
940you use a manual as a @dfn{reference}, or when it is impractical to
941read the entire manual before you start using the programs it
942describes.
943
944 Info has powerful searching facilities that let you find things
945quickly. You can search either the manual text or its indices.
946
947@kindex s @r{(Info mode)}
948@findex Info-search
949 The @kbd{s} command allows you to search a whole Info file for a string.
950It switches to the next node if and when that is necessary. You
951type @kbd{s} followed by the string to search for, terminated by
952@key{RET}. To search for the same string again, just @kbd{s} followed
953by @key{RET} will do. The file's nodes are scanned in the order
954they are in the file, which has no necessary relationship to the
955order that they may be in the tree structure of menus and @samp{next}
956pointers. But normally the two orders are not very different. In any
957case, you can always look at the echo area to find out what node you have
958reached, if the header is not visible (this can happen, because @kbd{s}
959puts your cursor at the occurrence of the string, not at the beginning
960of the node).
961
962@kindex M-s @r{(Info mode)}
963 In Emacs, @kbd{Meta-s} is equivalent to @kbd{s}. That is for
964compatibility with other GNU packages that use @kbd{M-s} for a similar
965kind of search command. Both @kbd{s} and @kbd{M-s} run in Emacs the
966command @code{Info-search}.
967
968@kindex C-s @r{(Info mode)}
969@kindex C-r @r{(Info mode)}
970@findex isearch
971 Instead of using @kbd{s} in Emacs Info and in the stand-alone Info,
972you can use an incremental search started with @kbd{C-s} or @kbd{C-r}.
973It can search through multiple Info nodes. @xref{Incremental Search,,,
974emacs, The GNU Emacs Manual}. In Emacs, this behavior is enabled only
975if the variable @code{Info-isearch-search} is non-@code{nil}
976(@pxref{Emacs Info Variables}).
977
978@node Search Index, Go to node, Search Text, Advanced
941@comment node-name, next, previous, up 979@comment node-name, next, previous, up
942@section Advanced Info Commands 980@section How to search the indices for specific subjects
981
982@cindex searching Info indices
983@kindex i @r{(Info mode)}
984@findex Info-index
985 Since most subjects related to what the manual describes should be
986indexed, you should try the index search first. The @kbd{i} command
987prompts you for a subject and then looks up that subject in the
988indices. If it finds an index entry with the subject you typed, it
989goes to the node to which that index entry points. You should browse
990through that node to see whether the issue you are looking for is
991described there. If it isn't, type @kbd{,} one or more times to go
992through additional index entries which match your subject.
943 993
944Here are some more Info commands that make it easier to move around. 994 The @kbd{i} command finds all index entries which include the string
995you typed @emph{as a substring}. For each match, Info shows in the
996echo area the full index entry it found. Often, the text of the full
997index entry already gives you enough information to decide whether it
998is relevant to what you are looking for, so we recommend that you read
999what Info shows in the echo area before looking at the node it
1000displays.
945 1001
946@subheading @kbd{g} goes to a node by name 1002 Since @kbd{i} looks for a substring, you can search for subjects even
1003if you are not sure how they are spelled in the index. For example,
1004suppose you want to find something that is pertinent to commands which
1005complete partial input (e.g., when you type @key{TAB}). If you want
1006to catch index entries that refer to ``complete'', ``completion'', and
1007``completing'', you could type @kbd{icomplet@key{RET}}.
1008
1009 Info documents which describe programs should index the commands,
1010options, and key sequences that the program provides. If you are
1011looking for a description of a command, an option, or a key, just type
1012their names when @kbd{i} prompts you for a topic. For example, if you
1013want to read the description of what the @kbd{C-f} key does, type
1014@kbd{i C - f @key{RET}}. Here @kbd{C-f} are 3 literal characters
1015@samp{C}, @samp{-}, and @samp{f}, not the ``Control-f'' command key
1016you type inside Emacs to run the command bound to @kbd{C-f}.
1017
1018 In Emacs, @kbd{i} runs the command @code{Info-index}.
1019
1020@findex info-apropos
1021@findex index-apropos
1022If you don't know what manual documents something, try the @kbd{M-x
1023info-apropos} command in Emacs, or the @kbd{M-x index-apropos} command
1024in the stand-alone reader. It prompts for a string and then looks up
1025that string in all the indices of all the Info documents installed on
1026your system.
1027
1028@node Go to node, Choose menu subtopic, Search Index, Advanced
1029@comment node-name, next, previous, up
1030@section @kbd{g} goes to a node by name
947 1031
948@kindex g @r{(Info mode)} 1032@kindex g @r{(Info mode)}
949@findex Info-goto-node 1033@findex Info-goto-node
@@ -951,7 +1035,7 @@ Here are some more Info commands that make it easier to move around.
951 If you know a node's name, you can go there by typing @kbd{g}, the 1035 If you know a node's name, you can go there by typing @kbd{g}, the
952name, and @key{RET}. Thus, @kbd{gTop@key{RET}} would go to the node 1036name, and @key{RET}. Thus, @kbd{gTop@key{RET}} would go to the node
953called @samp{Top} in this file. (This is equivalent to @kbd{t}, see 1037called @samp{Top} in this file. (This is equivalent to @kbd{t}, see
954@ref{Help-Int}.) @kbd{gAdvanced@key{RET}} would come back here. 1038@ref{Help-Int}.) @kbd{gGo to node@key{RET}} would come back here.
955@kbd{g} in Emacs runs the command @code{Info-goto-node}. 1039@kbd{g} in Emacs runs the command @code{Info-goto-node}.
956 1040
957 Unlike @kbd{m}, @kbd{g} does not allow the use of abbreviations. 1041 Unlike @kbd{m}, @kbd{g} does not allow the use of abbreviations.
@@ -969,7 +1053,9 @@ the node @samp{Top} in the Info file @file{dir}. Likewise,
969all of the current file by typing @kbd{g*@key{RET}} or all of any 1053all of the current file by typing @kbd{g*@key{RET}} or all of any
970other file with @kbd{g(@var{filename})*@key{RET}}. 1054other file with @kbd{g(@var{filename})*@key{RET}}.
971 1055
972@subheading @kbd{1}--@kbd{9} choose a menu subtopic by its number 1056@node Choose menu subtopic, Create Info buffer, Go to node, Advanced
1057@comment node-name, next, previous, up
1058@section @kbd{1}--@kbd{9} choose a menu subtopic by its number
973 1059
974@kindex 1 @r{through} 9 @r{(Info mode)} 1060@kindex 1 @r{through} 9 @r{(Info mode)}
975@findex Info-nth-menu-item 1061@findex Info-nth-menu-item
@@ -994,22 +1080,9 @@ underlining. If you need to actually count items, it is better to use
994@kbd{m} instead, and specify the name, or use @key{TAB} to quickly 1080@kbd{m} instead, and specify the name, or use @key{TAB} to quickly
995move between menu items. 1081move between menu items.
996 1082
997@subheading @kbd{e} makes Info document editable 1083@node Create Info buffer, Emacs Info Variables, Choose menu subtopic, Advanced
998 1084@comment node-name, next, previous, up
999@kindex e @r{(Info mode)} 1085@section @kbd{M-n} creates a new independent Info buffer in Emacs
1000@findex Info-edit
1001@cindex edit Info document
1002 The Info command @kbd{e} changes from Info mode to an ordinary
1003Emacs editing mode, so that you can edit the text of the current node.
1004Type @kbd{C-c C-c} to switch back to Info. The @kbd{e} command is allowed
1005only if the variable @code{Info-enable-edit} is non-@code{nil}.
1006
1007 The @kbd{e} command only works in Emacs, where it runs the command
1008@code{Info-edit}. The stand-alone Info reader doesn't allow you to
1009edit the Info file, so typing @kbd{e} there goes to the end of the
1010current node.
1011
1012@subheading @kbd{M-n} creates a new independent Info buffer in Emacs
1013 1086
1014@kindex M-n @r{(Info mode)} 1087@kindex M-n @r{(Info mode)}
1015@findex clone-buffer 1088@findex clone-buffer
@@ -1031,100 +1104,128 @@ prefix argument for the @kbd{C-h i} command (@code{info}) which
1031switches to the Info buffer with that number. Thus, @kbd{C-u 2 C-h i} 1104switches to the Info buffer with that number. Thus, @kbd{C-u 2 C-h i}
1032switches to the buffer @samp{*info*<2>}, creating it if necessary. 1105switches to the buffer @samp{*info*<2>}, creating it if necessary.
1033 1106
1034@node Info Search, Add, Advanced, Expert Info 1107@node Emacs Info Variables, , Create Info buffer, Advanced
1035@comment node-name, next, previous, up 1108@comment node-name, next, previous, up
1036@section How to search Info documents for specific subjects 1109@section Emacs Info-mode Variables
1037 1110
1038@cindex searching Info documents 1111The following variables may modify the behavior of Info-mode in Emacs;
1039@cindex Info document as a reference 1112you may wish to set one or several of these variables interactively, or
1040 The commands which move between and inside nodes allow you to read 1113in your @file{~/.emacs} init file. @xref{Examining, Examining and Setting
1041the entire manual or its large portions. But what if you need to find 1114Variables, Examining and Setting Variables, emacs, The GNU Emacs
1042some information in the manual as fast as you can, and you don't know 1115Manual}. The stand-alone Info reader program has its own set of
1043or don't remember in what node to look for it? This need arises when 1116variables, described in @ref{Variables,, Manipulating Variables,
1044you use a manual as a @dfn{reference}, or when it is impractical to 1117info-stnd, GNU Info}.
1045read the entire manual before you start using the programs it
1046describes.
1047 1118
1048 Info has powerful searching facilities that let you find things 1119@vtable @code
1049quickly. You can search either the manual indices or its text. 1120@item Info-directory-list
1121The list of directories to search for Info files. Each element is a
1122string (directory name) or @code{nil} (try default directory). If not
1123initialized Info uses the environment variable @env{INFOPATH} to
1124initialize it, or @code{Info-default-directory-list} if there is no
1125@env{INFOPATH} variable in the environment.
1050 1126
1051@kindex i @r{(Info mode)} 1127If you wish to customize the Info directory search list for both Emacs
1052@findex Info-index 1128Info and stand-alone Info, it is best to set the @env{INFOPATH}
1053 Since most subjects related to what the manual describes should be 1129environment variable, since that applies to both programs.
1054indexed, you should try the index search first. The @kbd{i} command
1055prompts you for a subject and then looks up that subject in the
1056indices. If it finds an index entry with the subject you typed, it
1057goes to the node to which that index entry points. You should browse
1058through that node to see whether the issue you are looking for is
1059described there. If it isn't, type @kbd{,} one or more times to go
1060through additional index entries which match your subject.
1061 1130
1062 The @kbd{i} command finds all index entries which include the string 1131@item Info-additional-directory-list
1063you typed @emph{as a substring}. For each match, Info shows in the 1132A list of additional directories to search for Info documentation files.
1064echo area the full index entry it found. Often, the text of the full 1133These directories are not searched for merging the @file{dir} file.
1065index entry already gives you enough information to decide whether it
1066is relevant to what you are looking for, so we recommend that you read
1067what Info shows in the echo area before looking at the node it
1068displays.
1069 1134
1070 Since @kbd{i} looks for a substring, you can search for subjects even 1135@item Info-mode-hook
1071if you are not sure how they are spelled in the index. For example, 1136Hooks run when @code{Info-mode} is called. By default, it contains
1072suppose you want to find something that is pertinent to commands which 1137the hook @code{turn-on-font-lock} which enables highlighting of Info
1073complete partial input (e.g., when you type @key{TAB}). If you want 1138files. You can change how the highlighting looks by customizing the
1074to catch index entries that refer to ``complete'', ``completion'', and 1139faces @code{info-node}, @code{info-xref}, @code{info-xref-visited},
1075``completing'', you could type @kbd{icomplet@key{RET}}. 1140@code{info-header-xref}, @code{info-header-node}, @code{info-menu-header},
1141@code{info-menu-star}, and @code{info-title-@var{n}} (where @var{n}
1142is the level of the section, a number between 1 and 4). To customize
1143a face, type @kbd{M-x customize-face @key{RET} @var{face} @key{RET}},
1144where @var{face} is one of the face names listed here.
1076 1145
1077 Info documents which describe programs should index the commands, 1146@item Info-fontify-maximum-menu-size
1078options, and key sequences that the program provides. If you are 1147Maximum size of menu to fontify if @code{font-lock-mode} is non-@code{nil}.
1079looking for a description of a command, an option, or a key, just type
1080their names when @kbd{i} prompts you for a topic. For example, if you
1081want to read the description of what the @kbd{C-f} key does, type
1082@kbd{i C - f @key{RET}}. Here @kbd{C-f} are 3 literal characters
1083@samp{C}, @samp{-}, and @samp{f}, not the ``Control-f'' command key
1084you type inside Emacs to run the command bound to @kbd{C-f}.
1085 1148
1086 In Emacs, @kbd{i} runs the command @code{Info-index}. 1149@item Info-fontify-visited-nodes
1150If non-@code{nil}, menu items and cross-references pointing to visited
1151nodes are displayed in the @code{info-xref-visited} face.
1087 1152
1088@findex info-apropos 1153@item Info-use-header-line
1089@findex index-apropos 1154If non-@code{nil}, Emacs puts in the Info buffer a header line showing
1090If you don't know what manual documents something, try the @kbd{M-x 1155the @samp{Next}, @samp{Prev}, and @samp{Up} links. A header line does
1091info-apropos} command in Emacs, or the @kbd{M-x index-apropos} command 1156not scroll with the rest of the buffer, making these links always
1092in the stand-alone reader. It prompts for a string and then looks up 1157visible.
1093that string in all the indices of all the Info documents installed on
1094your system.
1095 1158
1096@kindex s @r{(Info mode)} 1159@item Info-hide-note-references
1097@findex Info-search 1160As explained in earlier nodes, the Emacs version of Info normally
1098 The @kbd{s} command allows you to search a whole file for a string. 1161hides some text in menus and cross-references. You can completely
1099It switches to the next node if and when that is necessary. You 1162disable this feature, by setting this option to @code{nil}. Setting
1100type @kbd{s} followed by the string to search for, terminated by 1163it to a value that is neither @code{nil} nor @code{t} produces an
1101@key{RET}. To search for the same string again, just @kbd{s} followed 1164intermediate behavior, hiding a limited amount of text, but showing
1102by @key{RET} will do. The file's nodes are scanned in the order 1165all text that could potentially be useful.
1103they are in the file, which has no necessary relationship to the
1104order that they may be in the tree structure of menus and @samp{next}
1105pointers. But normally the two orders are not very different. In any
1106case, you can always look at the echo area to find out what node you have
1107reached, if the header is not visible (this can happen, because @kbd{s}
1108puts your cursor at the occurrence of the string, not at the beginning
1109of the node).
1110 1166
1111@kindex M-s @r{(Info mode)} 1167@item Info-scroll-prefer-subnodes
1112 In Emacs, @kbd{Meta-s} is equivalent to @kbd{s}. That is for 1168If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or
1113compatibility with other GNU packages that use @kbd{M-s} for a similar 1169@key{DEL}) keys in a menu visit subnodes of the current node before
1114kind of search command. Both @kbd{s} and @kbd{M-s} run in Emacs the 1170scrolling to its end or beginning, respectively. For example, if the
1115command @code{Info-search}. 1171node's menu appears on the screen, the next @key{SPC} moves to a
1172subnode indicated by the following menu item. Setting this option to
1173@code{nil} results in behavior similar to the stand-alone Info reader
1174program, which visits the first subnode from the menu only when you
1175hit the end of the current node. The default is @code{nil}.
1116 1176
1117@kindex C-s @r{(Info mode)} 1177@item Info-isearch-search
1118@kindex C-r @r{(Info mode)} 1178If non-@code{nil}, isearch in Info searches through multiple nodes.
1119@findex isearch
1120 Instead of using @kbd{s} in Emacs Info and in the stand-alone Info,
1121you can use an incremental search started with @kbd{C-s} or @kbd{C-r}.
1122It can search through multiple Info nodes. @xref{Incremental Search,,,
1123emacs, The GNU Emacs Manual}. In Emacs, this behavior is enabled only
1124if the variable @code{Info-isearch-search} is non-@code{nil}
1125(@pxref{Emacs Info Variables}).
1126 1179
1127@node Add, Menus, Info Search, Expert Info 1180@item Info-enable-active-nodes
1181When set to a non-@code{nil} value, allows Info to execute Lisp code
1182associated with nodes. The Lisp code is executed when the node is
1183selected. The Lisp code to be executed should follow the node
1184delimiter (the @samp{DEL} character) and an @samp{execute: } tag, like
1185this:
1186
1187@example
1188^_execute: (message "This is an active node!")
1189@end example
1190@end vtable
1191
1192
1193@node Expert Info
1194@chapter Info for Experts
1195
1196 This chapter explains how to write an Info as distinct from a
1197Texinfo file. However, in most cases, writing a Texinfo file is
1198better, since you can use it to make a printed manual or produce other
1199formats, such as HTML and DocBook, as well as for generating Info
1200files.
1201
1202@code{makeinfo} is a utility that converts a Texinfo file into an Info
1203file; @code{texinfo-format-region} and @code{texinfo-format-buffer} are
1204GNU Emacs functions that do the same.
1205
1206@xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU
1207Documentation Format}, to learn how to write a Texinfo file.
1208
1209@xref{Creating an Info File,,, texinfo, Texinfo: The GNU Documentation
1210Format}, to learn how to create an Info file from a Texinfo file.
1211
1212@xref{Installing an Info File,,, texinfo, Texinfo: The GNU
1213Documentation Format}, to learn how to install an Info file after you
1214have created one.
1215
1216However, if you want to edit an Info file manually and install it manually,
1217here is how.
1218
1219@menu
1220* Add:: Describes how to add new nodes to the hierarchy.
1221 Also tells what nodes look like.
1222* Menus:: How to add to or create menus in Info nodes.
1223* Cross-refs:: How to add cross-references to Info nodes.
1224* Tags:: How to make tags tables for Info files.
1225* Checking:: Checking an Info File.
1226@end menu
1227
1228@node Add, Menus, , Expert Info
1128@comment node-name, next, previous, up 1229@comment node-name, next, previous, up
1129@section Adding a new node to Info 1230@section Adding a new node to Info
1130 1231
@@ -1137,14 +1238,6 @@ Create some nodes, in some file, to document that topic.
1137Put that topic in the menu in the directory. @xref{Menus, Menu}. 1238Put that topic in the menu in the directory. @xref{Menus, Menu}.
1138@end enumerate 1239@end enumerate
1139 1240
1140 Usually, the way to create the nodes is with Texinfo (@pxref{Top,,
1141Overview of Texinfo, texinfo, Texinfo: The GNU Documentation Format});
1142this has the advantage that you can also make a printed manual or HTML
1143from them. You would use the @samp{@@dircategory} and
1144@samp{@@direntry} commands to put the manual into the Info directory.
1145However, if you want to edit an Info file manually and install it
1146manually, here is how.
1147
1148@cindex node delimiters 1241@cindex node delimiters
1149 The new node can live in an existing documentation file, or in a new 1242 The new node can live in an existing documentation file, or in a new
1150one. It must have a @samp{^_} character before it (invisible to the 1243one. It must have a @samp{^_} character before it (invisible to the
@@ -1324,7 +1417,7 @@ as new users should do when they learn a new package.
1324something quickly in a manual---that is, when you need to use a manual 1417something quickly in a manual---that is, when you need to use a manual
1325as a reference rather than as a tutorial. We urge you to learn 1418as a reference rather than as a tutorial. We urge you to learn
1326these search commands as well. If you want to do that now, follow this 1419these search commands as well. If you want to do that now, follow this
1327cross reference to @ref{Info Search}. 1420cross reference to @ref{Advanced}.
1328 1421
1329Yet another set of commands are meant for experienced users; you can 1422Yet another set of commands are meant for experienced users; you can
1330find them by looking in the Directory node for documentation on Info. 1423find them by looking in the Directory node for documentation on Info.
@@ -1382,8 +1475,7 @@ the beginning of the node's header (ending just after the node name),
1382a @samp{DEL} character, and the character position in the file of the 1475a @samp{DEL} character, and the character position in the file of the
1383beginning of the node. 1476beginning of the node.
1384 1477
1385 1478@node Checking, , Tags, Expert Info
1386@node Checking, Emacs Info Variables, Tags, Expert Info
1387@section Checking an Info File 1479@section Checking an Info File
1388 1480
1389When creating an Info file, it is easy to forget the name of a node when 1481When creating an Info file, it is easy to forget the name of a node when
@@ -1402,112 +1494,6 @@ usually few.
1402To check an Info file, do @kbd{M-x Info-validate} while looking at any 1494To check an Info file, do @kbd{M-x Info-validate} while looking at any
1403node of the file with Emacs Info mode. 1495node of the file with Emacs Info mode.
1404 1496
1405@node Emacs Info Variables, , Checking, Expert Info
1406@section Emacs Info-mode Variables
1407
1408The following variables may modify the behavior of Info-mode in Emacs;
1409you may wish to set one or several of these variables interactively, or
1410in your @file{~/.emacs} init file. @xref{Examining, Examining and Setting
1411Variables, Examining and Setting Variables, emacs, The GNU Emacs
1412Manual}. The stand-alone Info reader program has its own set of
1413variables, described in @ref{Variables,, Manipulating Variables,
1414info-stnd, GNU Info}.
1415
1416@vtable @code
1417@item Info-directory-list
1418The list of directories to search for Info files. Each element is a
1419string (directory name) or @code{nil} (try default directory). If not
1420initialized Info uses the environment variable @env{INFOPATH} to
1421initialize it, or @code{Info-default-directory-list} if there is no
1422@env{INFOPATH} variable in the environment.
1423
1424If you wish to customize the Info directory search list for both Emacs
1425Info and stand-alone Info, it is best to set the @env{INFOPATH}
1426environment variable, since that applies to both programs.
1427
1428@item Info-additional-directory-list
1429A list of additional directories to search for Info documentation files.
1430These directories are not searched for merging the @file{dir} file.
1431
1432@item Info-mode-hook
1433Hooks run when @code{Info-mode} is called. By default, it contains
1434the hook @code{turn-on-font-lock} which enables highlighting of Info
1435files. You can change how the highlighting looks by customizing the
1436faces @code{info-node}, @code{info-xref}, @code{info-xref-visited},
1437@code{info-header-xref}, @code{info-header-node}, @code{info-menu-header},
1438@code{info-menu-star}, and @code{info-title-@var{n}} (where @var{n}
1439is the level of the section, a number between 1 and 4). To customize
1440a face, type @kbd{M-x customize-face @key{RET} @var{face} @key{RET}},
1441where @var{face} is one of the face names listed here.
1442
1443@item Info-fontify-maximum-menu-size
1444Maximum size of menu to fontify if @code{font-lock-mode} is non-@code{nil}.
1445
1446@item Info-fontify-visited-nodes
1447If non-@code{nil}, menu items and cross-references pointing to visited
1448nodes are displayed in the @code{info-xref-visited} face.
1449
1450@item Info-use-header-line
1451If non-@code{nil}, Emacs puts in the Info buffer a header line showing
1452the @samp{Next}, @samp{Prev}, and @samp{Up} links. A header line does
1453not scroll with the rest of the buffer, making these links always
1454visible.
1455
1456@item Info-hide-note-references
1457As explained in earlier nodes, the Emacs version of Info normally
1458hides some text in menus and cross-references. You can completely
1459disable this feature, by setting this option to @code{nil}. Setting
1460it to a value that is neither @code{nil} nor @code{t} produces an
1461intermediate behavior, hiding a limited amount of text, but showing
1462all text that could potentially be useful.
1463
1464@item Info-scroll-prefer-subnodes
1465If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or
1466@key{DEL}) keys in a menu visit subnodes of the current node before
1467scrolling to its end or beginning, respectively. For example, if the
1468node's menu appears on the screen, the next @key{SPC} moves to a
1469subnode indicated by the following menu item. Setting this option to
1470@code{nil} results in behavior similar to the stand-alone Info reader
1471program, which visits the first subnode from the menu only when you
1472hit the end of the current node. The default is @code{nil}.
1473
1474@item Info-isearch-search
1475If non-@code{nil}, isearch in Info searches through multiple nodes.
1476
1477@item Info-enable-active-nodes
1478When set to a non-@code{nil} value, allows Info to execute Lisp code
1479associated with nodes. The Lisp code is executed when the node is
1480selected. The Lisp code to be executed should follow the node
1481delimiter (the @samp{DEL} character) and an @samp{execute: } tag, like
1482this:
1483
1484@example
1485^_execute: (message "This is an active node!")
1486@end example
1487
1488@item Info-enable-edit
1489Set to @code{nil}, disables the @samp{e} (@code{Info-edit}) command. A
1490non-@code{nil} value enables it. @xref{Add, Edit}.
1491@end vtable
1492
1493
1494@node Creating an Info File
1495@chapter Creating an Info File from a Texinfo File
1496
1497@code{makeinfo} is a utility that converts a Texinfo file into an Info
1498file; @code{texinfo-format-region} and @code{texinfo-format-buffer} are
1499GNU Emacs functions that do the same.
1500
1501@xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU
1502Documentation Format}, to learn how to write a Texinfo file.
1503
1504@xref{Creating an Info File,,, texinfo, Texinfo: The GNU Documentation
1505Format}, to learn how to create an Info file from a Texinfo file.
1506
1507@xref{Installing an Info File,,, texinfo, Texinfo: The GNU
1508Documentation Format}, to learn how to install an Info file after you
1509have created one.
1510
1511@node Index 1497@node Index
1512@unnumbered Index 1498@unnumbered Index
1513 1499
diff --git a/man/org.texi b/man/org.texi
index 92248c91e87..b38181c0c22 100644
--- a/man/org.texi
+++ b/man/org.texi
@@ -4,8 +4,8 @@
4@setfilename ../info/org 4@setfilename ../info/org
5@settitle Org Mode Manual 5@settitle Org Mode Manual
6 6
7@set VERSION 3.16 7@set VERSION 3.17
8@set DATE September 2005 8@set DATE October 2005
9 9
10@dircategory Emacs 10@dircategory Emacs
11@direntry 11@direntry
diff --git a/man/speedbar.texi b/man/speedbar.texi
index 469de905a24..4dc2bcea7d2 100644
--- a/man/speedbar.texi
+++ b/man/speedbar.texi
@@ -90,13 +90,13 @@ on. @xref{Basic Navigation}.
90@chapter Introduction 90@chapter Introduction
91@cindex introduction 91@cindex introduction
92 92
93To start using speedbar use the command @kbd{M-x speedbar RET} or select 93To start using speedbar use the command @kbd{M-x speedbar RET} or
94it from the Tools menu in versions of Emacs with speedbar installed by 94select it from the @samp{Options->Show/Hide} sub-menu. This command
95default. This command will open a new frame to summarize the local 95will open a new frame to summarize the local files. On X Window
96files. On X Window systems or on MS-Windows, speedbar's frame is twenty 96systems or on MS-Windows, speedbar's frame is twenty characters wide,
97characters wide, and will mimic the height of the frame from which it 97and will mimic the height of the frame from which it was started. It
98was started. It positions itself to the left or right of the frame you 98positions itself to the left or right of the frame you started it
99started it from. 99from.
100 100
101To use speedbar effectively, it is important to understand its 101To use speedbar effectively, it is important to understand its
102relationship with the frame you started it from. This frame is the 102relationship with the frame you started it from. This frame is the
@@ -141,9 +141,6 @@ to use.
141These key bindings are common across all modes: 141These key bindings are common across all modes:
142 142
143@table @kbd 143@table @kbd
144@item delete, SPC
145@cindex scrolling in speedbar
146Scroll up and down one page.
147@item Q 144@item Q
148@cindex quitting speedbar 145@cindex quitting speedbar
149Quit speedbar, and kill the frame. 146Quit speedbar, and kill the frame.
diff --git a/man/trampver.texi b/man/trampver.texi
index a77ae82d49b..9f2bb8737f7 100644
--- a/man/trampver.texi
+++ b/man/trampver.texi
@@ -4,7 +4,7 @@
4@c In the Tramp CVS, the version number is auto-frobbed from 4@c In the Tramp CVS, the version number is auto-frobbed from
5@c configure.ac, so you should edit that file and run 5@c configure.ac, so you should edit that file and run
6@c "autoconf && ./configure" to change the version number. 6@c "autoconf && ./configure" to change the version number.
7@set trampver 2.0.50 7@set trampver 2.0.51
8 8
9@c Other flags from configuration 9@c Other flags from configuration
10@set prefix /usr/local 10@set prefix /usr/local