diff options
| author | Glenn Morris | 2012-12-05 22:17:10 -0800 |
|---|---|---|
| committer | Glenn Morris | 2012-12-05 22:17:10 -0800 |
| commit | d8ad4d3ff9dcea9c581d72e1e9ec292ea18673b1 (patch) | |
| tree | 511f16e150fca1ed64ec71800eb0e62a9d95578a /doc/misc | |
| parent | b7f3003fdd2e6baacddcd7657708e887a6580785 (diff) | |
| parent | e1d51545ced3cf6f58c44891563dfaf62c34b411 (diff) | |
| download | emacs-d8ad4d3ff9dcea9c581d72e1e9ec292ea18673b1.tar.gz emacs-d8ad4d3ff9dcea9c581d72e1e9ec292ea18673b1.zip | |
Merge from emacs-24; up to 2012-11-24T16:58:43Z!cyd@gnu.org
Diffstat (limited to 'doc/misc')
45 files changed, 614 insertions, 614 deletions
diff --git a/doc/misc/auth.texi b/doc/misc/auth.texi index 3a1e4155e97..d18a802d600 100644 --- a/doc/misc/auth.texi +++ b/doc/misc/auth.texi | |||
| @@ -89,7 +89,7 @@ password (known as the secret). | |||
| 89 | 89 | ||
| 90 | Similarly, the auth-source library supports multiple storage backend, | 90 | Similarly, the auth-source library supports multiple storage backend, |
| 91 | currently either the classic ``netrc'' backend, examples of which you | 91 | currently either the classic ``netrc'' backend, examples of which you |
| 92 | can see later in this document, or the Secret Service API. This is | 92 | can see later in this document, or the Secret Service API@. This is |
| 93 | done with EIEIO-based backends and you can write your own if you want. | 93 | done with EIEIO-based backends and you can write your own if you want. |
| 94 | 94 | ||
| 95 | @node Help for users | 95 | @node Help for users |
| @@ -213,7 +213,7 @@ machine yourmachine.com:80 port http login testuser password testpass | |||
| 213 | @end example | 213 | @end example |
| 214 | 214 | ||
| 215 | This will match any realm and authentication method (basic or digest) | 215 | This will match any realm and authentication method (basic or digest) |
| 216 | over HTTP. HTTPS is set up similarly. If you want finer controls, | 216 | over HTTP@. HTTPS is set up similarly. If you want finer controls, |
| 217 | explore the url-auth source code and variables. | 217 | explore the url-auth source code and variables. |
| 218 | 218 | ||
| 219 | For Tramp authentication, use: | 219 | For Tramp authentication, use: |
| @@ -238,7 +238,7 @@ KDE Wallet (these are GNOME and KDE packages respectively and should | |||
| 238 | be available on most modern GNU/Linux systems). | 238 | be available on most modern GNU/Linux systems). |
| 239 | 239 | ||
| 240 | The auth-source library uses the @file{secrets.el} library to connect | 240 | The auth-source library uses the @file{secrets.el} library to connect |
| 241 | through the Secret Service API. You can also use that library in | 241 | through the Secret Service API@. You can also use that library in |
| 242 | other packages, it's not exclusive to auth-source. | 242 | other packages, it's not exclusive to auth-source. |
| 243 | 243 | ||
| 244 | @defvar secrets-enabled | 244 | @defvar secrets-enabled |
diff --git a/doc/misc/autotype.texi b/doc/misc/autotype.texi index 9d7a51233ff..aa99b41f204 100644 --- a/doc/misc/autotype.texi +++ b/doc/misc/autotype.texi | |||
| @@ -130,7 +130,7 @@ recognize this situation by a prompt ending in @key{RET}, @kbd{C-g} | |||
| 130 | or @kbd{C-h}. This | 130 | or @kbd{C-h}. This |
| 131 | means that entering an empty string will simply assume that you are finished. | 131 | means that entering an empty string will simply assume that you are finished. |
| 132 | Typing quit on the other hand terminates the loop but also the rest of the | 132 | Typing quit on the other hand terminates the loop but also the rest of the |
| 133 | skeleton, e.g. an ``else'' clause is skipped. Only a syntactically necessary | 133 | skeleton, e.g., an ``else'' clause is skipped. Only a syntactically necessary |
| 134 | termination still gets inserted. | 134 | termination still gets inserted. |
| 135 | 135 | ||
| 136 | 136 | ||
| @@ -147,8 +147,8 @@ reindent the wrapped code for you. | |||
| 147 | 147 | ||
| 148 | Skeleton commands take an optional numeric prefix argument | 148 | Skeleton commands take an optional numeric prefix argument |
| 149 | (@pxref{(emacs)Arguments}). This is interpreted in two different ways depending | 149 | (@pxref{(emacs)Arguments}). This is interpreted in two different ways depending |
| 150 | on whether the prefix is positive, i.e. forwards oriented or negative, | 150 | on whether the prefix is positive, i.e., forwards oriented, or negative, |
| 151 | i.e. backwards oriented. | 151 | i.e., backwards oriented. |
| 152 | 152 | ||
| 153 | A positive prefix means to wrap the skeleton around that many | 153 | A positive prefix means to wrap the skeleton around that many |
| 154 | following words. This is accomplished by putting the words there where | 154 | following words. This is accomplished by putting the words there where |
| @@ -178,7 +178,7 @@ ignored. | |||
| 178 | 178 | ||
| 179 | If, on the other hand, you marked in alphabetical order the points [] A C B, | 179 | If, on the other hand, you marked in alphabetical order the points [] A C B, |
| 180 | and call a skeleton command with @kbd{M-- 3}, you will wrap the text from | 180 | and call a skeleton command with @kbd{M-- 3}, you will wrap the text from |
| 181 | point to A, then the text from A to C and finally the text from C to B. This | 181 | point to A, then the text from A to C and finally the text from C to B@. This |
| 182 | is done because the regions overlap and Emacs would be helplessly lost if it | 182 | is done because the regions overlap and Emacs would be helplessly lost if it |
| 183 | tried to follow the order in which you marked these points. | 183 | tried to follow the order in which you marked these points. |
| 184 | 184 | ||
| @@ -241,10 +241,10 @@ put at these places. Point is left at first @code{_} where nothing is wrapped. | |||
| 241 | Indent line according to major mode. When following element is @code{_}, and | 241 | Indent line according to major mode. When following element is @code{_}, and |
| 242 | there is a interregion that will be wrapped here, indent that interregion. | 242 | there is a interregion that will be wrapped here, indent that interregion. |
| 243 | @item @code{&} | 243 | @item @code{&} |
| 244 | Logical and. Iff preceding element moved point, i.e. usually inserted | 244 | Logical and. Iff preceding element moved point, i.e., usually inserted |
| 245 | something, do following element. | 245 | something, do following element. |
| 246 | @item @code{|} | 246 | @item @code{|} |
| 247 | Logical xor. Iff preceding element didn't move point, i.e. usually inserted | 247 | Logical xor. Iff preceding element didn't move point, i.e., usually inserted |
| 248 | nothing, do following element. | 248 | nothing, do following element. |
| 249 | @item @code{-@var{number}} | 249 | @item @code{-@var{number}} |
| 250 | Delete preceding number characters. Depends on value of | 250 | Delete preceding number characters. Depends on value of |
| @@ -376,7 +376,7 @@ be inserted. | |||
| 376 | can simply insert some text, indeed, it can be skeleton command (@pxref{Using | 376 | can simply insert some text, indeed, it can be skeleton command (@pxref{Using |
| 377 | Skeletons}). It can be a lambda function which will for example conditionally | 377 | Skeletons}). It can be a lambda function which will for example conditionally |
| 378 | call another function. Or it can even reset the mode for the buffer. If you | 378 | call another function. Or it can even reset the mode for the buffer. If you |
| 379 | want to perform several such actions in order, you use a vector, i.e. several | 379 | want to perform several such actions in order, you use a vector, i.e., several |
| 380 | of the above elements between square brackets (@samp{[@r{@dots{}}]}). | 380 | of the above elements between square brackets (@samp{[@r{@dots{}}]}). |
| 381 | 381 | ||
| 382 | By default C and C++ headers insert a definition of a symbol derived from | 382 | By default C and C++ headers insert a definition of a symbol derived from |
| @@ -402,12 +402,12 @@ define-auto-insert}. | |||
| 402 | 402 | ||
| 403 | @vindex auto-insert | 403 | @vindex auto-insert |
| 404 | The variable @code{auto-insert} says what to do when @code{auto-insert} is | 404 | The variable @code{auto-insert} says what to do when @code{auto-insert} is |
| 405 | called non-interactively, e.g. when a newly found file is empty (see above): | 405 | called non-interactively, e.g., when a newly found file is empty (see above): |
| 406 | @table @asis | 406 | @table @asis |
| 407 | @item @code{nil} | 407 | @item @code{nil} |
| 408 | Do nothing. | 408 | Do nothing. |
| 409 | @item @code{t} | 409 | @item @code{t} |
| 410 | Insert something if possible, i.e. there is a matching entry in | 410 | Insert something if possible, i.e., there is a matching entry in |
| 411 | @code{auto-insert-alist}. | 411 | @code{auto-insert-alist}. |
| 412 | @item other | 412 | @item other |
| 413 | Insert something if possible, but mark as unmodified. | 413 | Insert something if possible, but mark as unmodified. |
| @@ -446,7 +446,7 @@ buffer has a comment syntax (@pxref{(emacs)Comments}), this is inserted as a com | |||
| 446 | @kbd{M-x copyright-update} looks for a copyright notice in the first | 446 | @kbd{M-x copyright-update} looks for a copyright notice in the first |
| 447 | @code{copyright-limit} characters of the buffer and updates it when necessary. | 447 | @code{copyright-limit} characters of the buffer and updates it when necessary. |
| 448 | The current year (variable @code{copyright-current-year}) is added to the | 448 | The current year (variable @code{copyright-current-year}) is added to the |
| 449 | existing ones, in the same format as the preceding year, i.e. 1994, '94 or 94. | 449 | existing ones, in the same format as the preceding year, i.e., 1994, '94 or 94. |
| 450 | If a dash-separated year list up to last year is found, that is extended to | 450 | If a dash-separated year list up to last year is found, that is extended to |
| 451 | current year, else the year is added separated by a comma. Or it replaces | 451 | current year, else the year is added separated by a comma. Or it replaces |
| 452 | them when this is called with a prefix argument. If a header referring to a | 452 | them when this is called with a prefix argument. If a header referring to a |
| @@ -492,7 +492,7 @@ intended for resource files, which are only meant to be read in. | |||
| 492 | 492 | ||
| 493 | @vindex executable-insert | 493 | @vindex executable-insert |
| 494 | The variable @code{executable-insert} says what to do when | 494 | The variable @code{executable-insert} says what to do when |
| 495 | @code{executable-set-magic} is called non-interactively, e.g. when file has no | 495 | @code{executable-set-magic} is called non-interactively, e.g., when file has no |
| 496 | or the wrong magic number: | 496 | or the wrong magic number: |
| 497 | @table @asis | 497 | @table @asis |
| 498 | @item @code{nil} | 498 | @item @code{nil} |
diff --git a/doc/misc/calc.texi b/doc/misc/calc.texi index 7e60f4b190f..5ed5212ad25 100644 --- a/doc/misc/calc.texi +++ b/doc/misc/calc.texi | |||
| @@ -293,7 +293,7 @@ experience with GNU Emacs in order to get the most out of Calc, | |||
| 293 | this manual ought to be readable even if you don't know or use Emacs | 293 | this manual ought to be readable even if you don't know or use Emacs |
| 294 | regularly. | 294 | regularly. |
| 295 | 295 | ||
| 296 | This manual is divided into three major parts:@: the ``Getting | 296 | This manual is divided into three major parts: the ``Getting |
| 297 | Started'' chapter you are reading now, the Calc tutorial, and the Calc | 297 | Started'' chapter you are reading now, the Calc tutorial, and the Calc |
| 298 | reference manual. | 298 | reference manual. |
| 299 | @c [when-split] | 299 | @c [when-split] |
| @@ -10518,7 +10518,7 @@ Integers, fractions, and floats are various ways of describing real | |||
| 10518 | numbers. HMS forms also for many purposes act as real numbers. These | 10518 | numbers. HMS forms also for many purposes act as real numbers. These |
| 10519 | types can be combined to form complex numbers, modulo forms, error forms, | 10519 | types can be combined to form complex numbers, modulo forms, error forms, |
| 10520 | or interval forms. (But these last four types cannot be combined | 10520 | or interval forms. (But these last four types cannot be combined |
| 10521 | arbitrarily:@: error forms may not contain modulo forms, for example.) | 10521 | arbitrarily: error forms may not contain modulo forms, for example.) |
| 10522 | Finally, all these types of numbers may be combined into vectors, | 10522 | Finally, all these types of numbers may be combined into vectors, |
| 10523 | matrices, or algebraic formulas. | 10523 | matrices, or algebraic formulas. |
| 10524 | 10524 | ||
| @@ -13472,7 +13472,7 @@ Year: ``ad '' or blank. (Note trailing space.) | |||
| 13472 | @item AAA | 13472 | @item AAA |
| 13473 | Year: ``AD '' or blank. | 13473 | Year: ``AD '' or blank. |
| 13474 | @item aaaa | 13474 | @item aaaa |
| 13475 | Year: ``a.d.'' or blank. | 13475 | Year: ``a.d.@:'' or blank. |
| 13476 | @item AAAA | 13476 | @item AAAA |
| 13477 | Year: ``A.D.'' or blank. | 13477 | Year: ``A.D.'' or blank. |
| 13478 | @item bb | 13478 | @item bb |
| @@ -13484,7 +13484,7 @@ Year: `` bc'' or blank. (Note leading space.) | |||
| 13484 | @item BBB | 13484 | @item BBB |
| 13485 | Year: `` BC'' or blank. | 13485 | Year: `` BC'' or blank. |
| 13486 | @item bbbb | 13486 | @item bbbb |
| 13487 | Year: ``b.c.'' or blank. | 13487 | Year: ``b.c.@:'' or blank. |
| 13488 | @item BBBB | 13488 | @item BBBB |
| 13489 | Year: ``B.C.'' or blank. | 13489 | Year: ``B.C.'' or blank. |
| 13490 | @item M | 13490 | @item M |
| @@ -13548,7 +13548,7 @@ AM/PM: ``am'' or ``pm''. | |||
| 13548 | @item PP | 13548 | @item PP |
| 13549 | AM/PM: ``AM'' or ``PM''. | 13549 | AM/PM: ``AM'' or ``PM''. |
| 13550 | @item pppp | 13550 | @item pppp |
| 13551 | AM/PM: ``a.m.'' or ``p.m.''. | 13551 | AM/PM: ``a.m.@:'' or ``p.m.''. |
| 13552 | @item PPPP | 13552 | @item PPPP |
| 13553 | AM/PM: ``A.M.'' or ``P.M.''. | 13553 | AM/PM: ``A.M.'' or ``P.M.''. |
| 13554 | @item m | 13554 | @item m |
| @@ -16997,7 +16997,7 @@ this formula will return the Wednesday one week in the future. An | |||
| 16997 | exercise for the reader is to modify this formula to yield the same day | 16997 | exercise for the reader is to modify this formula to yield the same day |
| 16998 | if the input is already a Wednesday. Another interesting exercise is | 16998 | if the input is already a Wednesday. Another interesting exercise is |
| 16999 | to preserve the time-of-day portion of the input (@code{newweek} resets | 16999 | to preserve the time-of-day portion of the input (@code{newweek} resets |
| 17000 | the time to midnight; hint:@: how can @code{newweek} be defined in terms | 17000 | the time to midnight; hint: how can @code{newweek} be defined in terms |
| 17001 | of the @code{weekday} function?). | 17001 | of the @code{weekday} function?). |
| 17002 | 17002 | ||
| 17003 | @ignore | 17003 | @ignore |
| @@ -34455,7 +34455,7 @@ traversed in this way, it is compared with the original formula (from | |||
| 34455 | before the call to @code{normalize}) and, if it has changed, | 34455 | before the call to @code{normalize}) and, if it has changed, |
| 34456 | the entire procedure is repeated (starting with @code{normalize}) | 34456 | the entire procedure is repeated (starting with @code{normalize}) |
| 34457 | until no further changes occur. Usually only two iterations are | 34457 | until no further changes occur. Usually only two iterations are |
| 34458 | needed:@: one to simplify the formula, and another to verify that no | 34458 | needed: one to simplify the formula, and another to verify that no |
| 34459 | further simplifications were possible. | 34459 | further simplifications were possible. |
| 34460 | @end defun | 34460 | @end defun |
| 34461 | 34461 | ||
diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi index 8c574be8f2a..76d9eb42883 100644 --- a/doc/misc/cc-mode.texi +++ b/doc/misc/cc-mode.texi | |||
| @@ -88,7 +88,7 @@ the second with them pointing to the XEmacs manuals. | |||
| 88 | @c The following four macros generate the filenames and titles of the | 88 | @c The following four macros generate the filenames and titles of the |
| 89 | @c main (X)Emacs manual and the Elisp/Lispref manual. Leave the | 89 | @c main (X)Emacs manual and the Elisp/Lispref manual. Leave the |
| 90 | @c Texinfo variable `XEMACS' unset to generate a GNU Emacs version, set it | 90 | @c Texinfo variable `XEMACS' unset to generate a GNU Emacs version, set it |
| 91 | @c to generate an XEmacs version, e.g. with | 91 | @c to generate an XEmacs version, e.g., with |
| 92 | @c "makeinfo -DXEMACS cc-mode.texi". | 92 | @c "makeinfo -DXEMACS cc-mode.texi". |
| 93 | @ifset XEMACS | 93 | @ifset XEMACS |
| 94 | @macro emacsman | 94 | @macro emacsman |
| @@ -646,13 +646,13 @@ you're better off getting an external program like GNU @code{indent}, | |||
| 646 | which will rearrange brace location, amongst other things. | 646 | which will rearrange brace location, amongst other things. |
| 647 | 647 | ||
| 648 | Preprocessor directives are handled as syntactic whitespace from other | 648 | Preprocessor directives are handled as syntactic whitespace from other |
| 649 | code, i.e. they can be interspersed anywhere without affecting the | 649 | code, i.e., they can be interspersed anywhere without affecting the |
| 650 | indentation of the surrounding code, just like comments. | 650 | indentation of the surrounding code, just like comments. |
| 651 | 651 | ||
| 652 | The code inside macro definitions is, by default, still analyzed | 652 | The code inside macro definitions is, by default, still analyzed |
| 653 | syntactically so that you get relative indentation there just as you'd | 653 | syntactically so that you get relative indentation there just as you'd |
| 654 | get if the same code was outside a macro. However, since there is no | 654 | get if the same code was outside a macro. However, since there is no |
| 655 | hint about the syntactic context, i.e. whether the macro expands to an | 655 | hint about the syntactic context, i.e., whether the macro expands to an |
| 656 | expression, to some statements, or perhaps to whole functions, the | 656 | expression, to some statements, or perhaps to whole functions, the |
| 657 | syntactic recognition can be wrong. @ccmode{} manages to figure it | 657 | syntactic recognition can be wrong. @ccmode{} manages to figure it |
| 658 | out correctly most of the time, though. | 658 | out correctly most of the time, though. |
| @@ -773,7 +773,7 @@ Indents the entire top-level function, class or macro definition | |||
| 773 | encompassing point. It leaves point unchanged. This function can't be | 773 | encompassing point. It leaves point unchanged. This function can't be |
| 774 | used to reindent a nested brace construct, such as a nested class or | 774 | used to reindent a nested brace construct, such as a nested class or |
| 775 | function, or a Java method. The top-level construct being reindented | 775 | function, or a Java method. The top-level construct being reindented |
| 776 | must be complete, i.e. it must have both a beginning brace and an ending | 776 | must be complete, i.e., it must have both a beginning brace and an ending |
| 777 | brace. | 777 | brace. |
| 778 | 778 | ||
| 779 | @item @kbd{C-M-\} (@code{indent-region}) | 779 | @item @kbd{C-M-\} (@code{indent-region}) |
| @@ -1021,7 +1021,7 @@ preprocessor statements. | |||
| 1021 | A popular programming style, especially for object-oriented languages | 1021 | A popular programming style, especially for object-oriented languages |
| 1022 | such as C++ is to write symbols in a mixed case format, where the | 1022 | such as C++ is to write symbols in a mixed case format, where the |
| 1023 | first letter of each word is capitalized, and not separated by | 1023 | first letter of each word is capitalized, and not separated by |
| 1024 | underscores. E.g. @samp{SymbolsWithMixedCaseAndNoUnderlines}. | 1024 | underscores. E.g., @samp{SymbolsWithMixedCaseAndNoUnderlines}. |
| 1025 | 1025 | ||
| 1026 | These commands move backward or forward to the beginning of the next | 1026 | These commands move backward or forward to the beginning of the next |
| 1027 | capitalized word. With prefix argument @var{n}, move @var{n} times. | 1027 | capitalized word. With prefix argument @var{n}, move @var{n} times. |
| @@ -1043,7 +1043,7 @@ Movement}. They might be removed from a future release of @ccmode{}. | |||
| 1043 | 1043 | ||
| 1044 | Since there's a lot of normal text in comments and string literals, | 1044 | Since there's a lot of normal text in comments and string literals, |
| 1045 | @ccmode{} provides features to edit these like in text mode. The goal | 1045 | @ccmode{} provides features to edit these like in text mode. The goal |
| 1046 | is to do it seamlessly, i.e. you can use auto fill mode, sentence and | 1046 | is to do it seamlessly, i.e., you can use auto fill mode, sentence and |
| 1047 | paragraph movement, paragraph filling, adaptive filling etc. wherever | 1047 | paragraph movement, paragraph filling, adaptive filling etc. wherever |
| 1048 | there's a piece of normal text without having to think much about it. | 1048 | there's a piece of normal text without having to think much about it. |
| 1049 | @ccmode{} keeps the indentation, fixes suitable comment line prefixes, | 1049 | @ccmode{} keeps the indentation, fixes suitable comment line prefixes, |
| @@ -1059,7 +1059,7 @@ set this up for you, so you probably won't have to bother. | |||
| 1059 | @cindex paragraph filling | 1059 | @cindex paragraph filling |
| 1060 | Line breaks are by default handled (almost) the same regardless of | 1060 | Line breaks are by default handled (almost) the same regardless of |
| 1061 | whether they are made by auto fill mode (@pxref{Auto | 1061 | whether they are made by auto fill mode (@pxref{Auto |
| 1062 | Fill,,,@emacsman{}, @emacsmantitle{}}), by paragraph filling (e.g. with | 1062 | Fill,,,@emacsman{}, @emacsmantitle{}}), by paragraph filling (e.g., with |
| 1063 | @kbd{M-q}), or explicitly with @kbd{M-j} or similar methods. In | 1063 | @kbd{M-q}), or explicitly with @kbd{M-j} or similar methods. In |
| 1064 | string literals, the new line gets the same indentation as the | 1064 | string literals, the new line gets the same indentation as the |
| 1065 | previous nonempty line.@footnote{You can change this default by | 1065 | previous nonempty line.@footnote{You can change this default by |
| @@ -1120,7 +1120,7 @@ this function. @xref{Sample .emacs File}. | |||
| 1120 | @findex c-context-open-line | 1120 | @findex c-context-open-line |
| 1121 | @findex context-open-line (c-) | 1121 | @findex context-open-line (c-) |
| 1122 | This is to @kbd{C-o} (@kbd{M-x open-line}) as | 1122 | This is to @kbd{C-o} (@kbd{M-x open-line}) as |
| 1123 | @code{c-context-line-break} is to @kbd{RET}. I.e. it works just like | 1123 | @code{c-context-line-break} is to @kbd{RET}. I.e., it works just like |
| 1124 | @code{c-context-line-break} but leaves the point before the inserted | 1124 | @code{c-context-line-break} but leaves the point before the inserted |
| 1125 | line break. | 1125 | line break. |
| 1126 | @end table | 1126 | @end table |
| @@ -1144,7 +1144,7 @@ editing chaotically formatted code. It can also be disconcerting, | |||
| 1144 | especially for users who are new to @ccmode{}. | 1144 | especially for users who are new to @ccmode{}. |
| 1145 | @item auto-newline mode | 1145 | @item auto-newline mode |
| 1146 | This automatically inserts newlines where you'd probably want to type | 1146 | This automatically inserts newlines where you'd probably want to type |
| 1147 | them yourself, e.g. after typing @samp{@}}s. Its action is suppressed | 1147 | them yourself, e.g., after typing @samp{@}}s. Its action is suppressed |
| 1148 | when electric mode is disabled. | 1148 | when electric mode is disabled. |
| 1149 | @item hungry-delete mode | 1149 | @item hungry-delete mode |
| 1150 | This lets you delete a contiguous block of whitespace with a single | 1150 | This lets you delete a contiguous block of whitespace with a single |
| @@ -1155,7 +1155,7 @@ last statement. | |||
| 1155 | This mode makes basic word movement commands like @kbd{M-f} | 1155 | This mode makes basic word movement commands like @kbd{M-f} |
| 1156 | (@code{forward-word}) and @kbd{M-b} (@code{backward-word}) treat the | 1156 | (@code{forward-word}) and @kbd{M-b} (@code{backward-word}) treat the |
| 1157 | parts of sillycapsed symbols as different words. | 1157 | parts of sillycapsed symbols as different words. |
| 1158 | E.g. @samp{NSGraphicsContext} is treated as three words @samp{NS}, | 1158 | E.g., @samp{NSGraphicsContext} is treated as three words @samp{NS}, |
| 1159 | @samp{Graphics}, and @samp{Context}. | 1159 | @samp{Graphics}, and @samp{Context}. |
| 1160 | @item syntactic-indentation mode | 1160 | @item syntactic-indentation mode |
| 1161 | When this is enabled (which it normally is), indentation commands such | 1161 | When this is enabled (which it normally is), indentation commands such |
| @@ -1288,7 +1288,7 @@ A star (bound to @code{c-electric-star}) or a slash | |||
| 1288 | (@code{c-electric-slash}) causes reindentation when you type it as the | 1288 | (@code{c-electric-slash}) causes reindentation when you type it as the |
| 1289 | second component of a C style block comment opener (@samp{/*}) or a | 1289 | second component of a C style block comment opener (@samp{/*}) or a |
| 1290 | C++ line comment opener (@samp{//}) respectively, but only if the | 1290 | C++ line comment opener (@samp{//}) respectively, but only if the |
| 1291 | comment opener is the first thing on the line (i.e. there's only | 1291 | comment opener is the first thing on the line (i.e., there's only |
| 1292 | whitespace before it). | 1292 | whitespace before it). |
| 1293 | 1293 | ||
| 1294 | Additionally, you can configure @ccmode{} so that typing a slash at | 1294 | Additionally, you can configure @ccmode{} so that typing a slash at |
| @@ -1426,7 +1426,7 @@ Auto-newline only triggers when the following conditions hold: | |||
| 1426 | @itemize @bullet | 1426 | @itemize @bullet |
| 1427 | @item | 1427 | @item |
| 1428 | Auto-newline minor mode is enabled, as evidenced by the indicator | 1428 | Auto-newline minor mode is enabled, as evidenced by the indicator |
| 1429 | @samp{a} after the mode name on the modeline (e.g. @samp{C/a} or | 1429 | @samp{a} after the mode name on the modeline (e.g., @samp{C/a} or |
| 1430 | @samp{C/la}). | 1430 | @samp{C/la}). |
| 1431 | 1431 | ||
| 1432 | @item | 1432 | @item |
| @@ -1446,7 +1446,7 @@ definition. These constructs are also known as @dfn{syntactic | |||
| 1446 | whitespace} since they are usually ignored when scanning C code.}. | 1446 | whitespace} since they are usually ignored when scanning C code.}. |
| 1447 | 1447 | ||
| 1448 | @item | 1448 | @item |
| 1449 | No numeric argument was supplied to the command (i.e. it was typed as | 1449 | No numeric argument was supplied to the command (i.e., it was typed as |
| 1450 | normal, with no @kbd{C-u} prefix). | 1450 | normal, with no @kbd{C-u} prefix). |
| 1451 | @end itemize | 1451 | @end itemize |
| 1452 | 1452 | ||
| @@ -1631,7 +1631,7 @@ trouble with this in GNU Emacs. | |||
| 1631 | @cindex nomenclature | 1631 | @cindex nomenclature |
| 1632 | @cindex subword | 1632 | @cindex subword |
| 1633 | In spite of the GNU Coding Standards, it is popular to name a symbol | 1633 | In spite of the GNU Coding Standards, it is popular to name a symbol |
| 1634 | by mixing uppercase and lowercase letters, e.g. @samp{GtkWidget}, | 1634 | by mixing uppercase and lowercase letters, e.g., @samp{GtkWidget}, |
| 1635 | @samp{EmacsFrameClass}, or @samp{NSGraphicsContext}. Here we call | 1635 | @samp{EmacsFrameClass}, or @samp{NSGraphicsContext}. Here we call |
| 1636 | these mixed case symbols @dfn{nomenclatures}. Also, each capitalized | 1636 | these mixed case symbols @dfn{nomenclatures}. Also, each capitalized |
| 1637 | (or completely uppercase) part of a nomenclature is called a | 1637 | (or completely uppercase) part of a nomenclature is called a |
| @@ -1819,7 +1819,7 @@ Lock,,, emacs, GNU Emacs Manual}, for ways to enable font locking in | |||
| 1819 | 1819 | ||
| 1820 | @strong{Please note:} The font locking in AWK mode is currently not | 1820 | @strong{Please note:} The font locking in AWK mode is currently not |
| 1821 | integrated with the rest of @ccmode{}. Only the last section of this | 1821 | integrated with the rest of @ccmode{}. Only the last section of this |
| 1822 | chapter, @ref{AWK Mode Font Locking}, applies to AWK. The other | 1822 | chapter, @ref{AWK Mode Font Locking}, applies to AWK@. The other |
| 1823 | sections apply to the other languages. | 1823 | sections apply to the other languages. |
| 1824 | 1824 | ||
| 1825 | @menu | 1825 | @menu |
| @@ -1912,7 +1912,7 @@ additional regexps to match those you use: | |||
| 1912 | For each language there's a variable @code{*-font-lock-extra-types}, | 1912 | For each language there's a variable @code{*-font-lock-extra-types}, |
| 1913 | where @samp{*} stands for the language in question. It contains a list | 1913 | where @samp{*} stands for the language in question. It contains a list |
| 1914 | of regexps that matches identifiers that should be recognized as types, | 1914 | of regexps that matches identifiers that should be recognized as types, |
| 1915 | e.g. @samp{\\sw+_t} to recognize all identifiers ending with @samp{_t} | 1915 | e.g., @samp{\\sw+_t} to recognize all identifiers ending with @samp{_t} |
| 1916 | as is customary in C code. Each regexp should not match more than a | 1916 | as is customary in C code. Each regexp should not match more than a |
| 1917 | single identifier. | 1917 | single identifier. |
| 1918 | 1918 | ||
| @@ -2009,7 +2009,7 @@ labels. | |||
| 2009 | @vindex font-lock-builtin-face | 2009 | @vindex font-lock-builtin-face |
| 2010 | @vindex font-lock-reference-face | 2010 | @vindex font-lock-reference-face |
| 2011 | Preprocessor directives get @code{font-lock-preprocessor-face} if it | 2011 | Preprocessor directives get @code{font-lock-preprocessor-face} if it |
| 2012 | exists (i.e. XEmacs). In Emacs they get @code{font-lock-builtin-face} | 2012 | exists (i.e., XEmacs). In Emacs they get @code{font-lock-builtin-face} |
| 2013 | or @code{font-lock-reference-face}, for lack of a closer equivalent. | 2013 | or @code{font-lock-reference-face}, for lack of a closer equivalent. |
| 2014 | 2014 | ||
| 2015 | @item | 2015 | @item |
| @@ -2035,14 +2035,14 @@ since those aren't syntactic errors in themselves. | |||
| 2035 | @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | 2035 | @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 2036 | 2036 | ||
| 2037 | There are various tools to supply documentation in the source as | 2037 | There are various tools to supply documentation in the source as |
| 2038 | specially structured comments, e.g. the standard Javadoc tool in Java. | 2038 | specially structured comments, e.g., the standard Javadoc tool in Java. |
| 2039 | @ccmode{} provides an extensible mechanism to fontify such comments and | 2039 | @ccmode{} provides an extensible mechanism to fontify such comments and |
| 2040 | the special markup inside them. | 2040 | the special markup inside them. |
| 2041 | 2041 | ||
| 2042 | @defopt c-doc-comment-style | 2042 | @defopt c-doc-comment-style |
| 2043 | @vindex doc-comment-style (c-) | 2043 | @vindex doc-comment-style (c-) |
| 2044 | This is a style variable that specifies which documentation comment | 2044 | This is a style variable that specifies which documentation comment |
| 2045 | style to recognize, e.g. @code{javadoc} for Javadoc comments. | 2045 | style to recognize, e.g., @code{javadoc} for Javadoc comments. |
| 2046 | 2046 | ||
| 2047 | The value may also be a list of styles, in which case all of them are | 2047 | The value may also be a list of styles, in which case all of them are |
| 2048 | recognized simultaneously (presumably with markup cues that don't | 2048 | recognized simultaneously (presumably with markup cues that don't |
| @@ -2060,7 +2060,7 @@ The default value for @code{c-doc-comment-style} is | |||
| 2060 | Note that @ccmode{} uses this variable to set other variables that | 2060 | Note that @ccmode{} uses this variable to set other variables that |
| 2061 | handle fontification etc. That's done at mode initialization or when | 2061 | handle fontification etc. That's done at mode initialization or when |
| 2062 | you switch to a style which sets this variable. Thus, if you change it | 2062 | you switch to a style which sets this variable. Thus, if you change it |
| 2063 | in some other way, e.g. interactively in a CC Mode buffer, you will need | 2063 | in some other way, e.g., interactively in a CC Mode buffer, you will need |
| 2064 | to do @kbd{M-x java-mode} (or whatever mode you're currently using) to | 2064 | to do @kbd{M-x java-mode} (or whatever mode you're currently using) to |
| 2065 | reinitialize. | 2065 | reinitialize. |
| 2066 | 2066 | ||
| @@ -2351,7 +2351,7 @@ have it enabled by default by placing the following in your | |||
| 2351 | @cindex mode hooks | 2351 | @cindex mode hooks |
| 2352 | @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | 2352 | @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 2353 | @c The node name is "CC Hooks" rather than "Hooks" because of a bug in | 2353 | @c The node name is "CC Hooks" rather than "Hooks" because of a bug in |
| 2354 | @c some older versions of Info, e.g. the info.el in GNU Emacs 21.3. | 2354 | @c some older versions of Info, e.g., the info.el in GNU Emacs 21.3. |
| 2355 | @c If you go to "Config Basics" and hit <CR> on the xref to "CC | 2355 | @c If you go to "Config Basics" and hit <CR> on the xref to "CC |
| 2356 | @c Hooks" the function Info-follow-reference searches for "*Note: CC | 2356 | @c Hooks" the function Info-follow-reference searches for "*Note: CC |
| 2357 | @c Hooks" from the beginning of the page. If this node were instead | 2357 | @c Hooks" from the beginning of the page. If this node were instead |
| @@ -2429,7 +2429,7 @@ file. | |||
| 2429 | The variables that @ccmode{}'s style system control are called | 2429 | The variables that @ccmode{}'s style system control are called |
| 2430 | @dfn{style variables}. Note that style variables are ordinary Lisp | 2430 | @dfn{style variables}. Note that style variables are ordinary Lisp |
| 2431 | variables, which the style system initializes; you can change their | 2431 | variables, which the style system initializes; you can change their |
| 2432 | values at any time (e.g. in a hook function). The style system can | 2432 | values at any time (e.g., in a hook function). The style system can |
| 2433 | also set other variables, to some extent. @xref{Styles}. | 2433 | also set other variables, to some extent. @xref{Styles}. |
| 2434 | 2434 | ||
| 2435 | @dfn{Style variables} are handled specially in several ways: | 2435 | @dfn{Style variables} are handled specially in several ways: |
| @@ -2921,9 +2921,9 @@ visit the file, @ccmode{} will automatically institute these offsets | |||
| 2921 | using @code{c-set-offset}. | 2921 | using @code{c-set-offset}. |
| 2922 | @end defvar | 2922 | @end defvar |
| 2923 | 2923 | ||
| 2924 | Note that file style settings (i.e. @code{c-file-style}) are applied | 2924 | Note that file style settings (i.e., @code{c-file-style}) are applied |
| 2925 | before file offset settings | 2925 | before file offset settings |
| 2926 | (i.e. @code{c-file-offsets})@footnote{Also, if either of these are set | 2926 | (i.e., @code{c-file-offsets})@footnote{Also, if either of these are set |
| 2927 | in a file's local variable section, all the style variable values are | 2927 | in a file's local variable section, all the style variable values are |
| 2928 | made local to that buffer, even if | 2928 | made local to that buffer, even if |
| 2929 | @code{c-style-variables-are-local-p} is @code{nil}. Since this | 2929 | @code{c-style-variables-are-local-p} is @code{nil}. Since this |
| @@ -3001,7 +3001,7 @@ subsequent lines of C style block comments like | |||
| 3001 | @noindent | 3001 | @noindent |
| 3002 | with zero or more stars at the beginning of every line. If you change | 3002 | with zero or more stars at the beginning of every line. If you change |
| 3003 | this variable, please make sure it still matches the comment starter | 3003 | this variable, please make sure it still matches the comment starter |
| 3004 | (i.e. @code{//}) of line comments @emph{and} the line prefix inside | 3004 | (i.e., @code{//}) of line comments @emph{and} the line prefix inside |
| 3005 | block comments. | 3005 | block comments. |
| 3006 | 3006 | ||
| 3007 | @findex c-setup-paragraph-variables | 3007 | @findex c-setup-paragraph-variables |
| @@ -3024,7 +3024,7 @@ the line prefix from the other lines in the comment. | |||
| 3024 | @ccmode{} uses adaptive fill mode (@pxref{Adaptive Fill,,, emacs, GNU | 3024 | @ccmode{} uses adaptive fill mode (@pxref{Adaptive Fill,,, emacs, GNU |
| 3025 | Emacs Manual}) to make Emacs correctly keep the line prefix when | 3025 | Emacs Manual}) to make Emacs correctly keep the line prefix when |
| 3026 | filling paragraphs. That also makes Emacs preserve the text | 3026 | filling paragraphs. That also makes Emacs preserve the text |
| 3027 | indentation @emph{inside} the comment line prefix. E.g. in the | 3027 | indentation @emph{inside} the comment line prefix. E.g., in the |
| 3028 | following comment, both paragraphs will be filled with the left | 3028 | following comment, both paragraphs will be filled with the left |
| 3029 | margins of the texts kept intact: | 3029 | margins of the texts kept intact: |
| 3030 | 3030 | ||
| @@ -3055,7 +3055,7 @@ by default). A patch for that is available from | |||
| 3055 | @c 2005/11/22: The above is still believed to be the case. | 3055 | @c 2005/11/22: The above is still believed to be the case. |
| 3056 | which handles things like bulleted lists nicely. There's a convenience | 3056 | which handles things like bulleted lists nicely. There's a convenience |
| 3057 | function @code{c-setup-filladapt} that tunes the relevant variables in | 3057 | function @code{c-setup-filladapt} that tunes the relevant variables in |
| 3058 | Filladapt for use in @ccmode{}. Call it from a mode hook, e.g. with | 3058 | Filladapt for use in @ccmode{}. Call it from a mode hook, e.g., with |
| 3059 | something like this in your @file{.emacs}: | 3059 | something like this in your @file{.emacs}: |
| 3060 | 3060 | ||
| 3061 | @example | 3061 | @example |
| @@ -3081,7 +3081,7 @@ then as the comment prefix. It defaults to @samp{* | |||
| 3081 | @code{c-block-comment-prefix} typically gets overridden by the default | 3081 | @code{c-block-comment-prefix} typically gets overridden by the default |
| 3082 | style @code{gnu}, which sets it to blank. You can see the line | 3082 | style @code{gnu}, which sets it to blank. You can see the line |
| 3083 | splitting effect described here by setting a different style, | 3083 | splitting effect described here by setting a different style, |
| 3084 | e.g. @code{k&r} @xref{Choosing a Style}.}, which makes a comment | 3084 | e.g., @code{k&r} @xref{Choosing a Style}.}, which makes a comment |
| 3085 | 3085 | ||
| 3086 | @example | 3086 | @example |
| 3087 | /* Got O(n^2) here, which is a Bad Thing. */ | 3087 | /* Got O(n^2) here, which is a Bad Thing. */ |
| @@ -3108,7 +3108,7 @@ most common comment styles, see @ref{Line-Up Functions}. | |||
| 3108 | @defopt c-ignore-auto-fill | 3108 | @defopt c-ignore-auto-fill |
| 3109 | @vindex ignore-auto-fill (c-) | 3109 | @vindex ignore-auto-fill (c-) |
| 3110 | When auto fill mode is enabled, @ccmode{} can selectively ignore it | 3110 | When auto fill mode is enabled, @ccmode{} can selectively ignore it |
| 3111 | depending on the context the line break would occur in, e.g. to never | 3111 | depending on the context the line break would occur in, e.g., to never |
| 3112 | break a line automatically inside a string literal. This variable | 3112 | break a line automatically inside a string literal. This variable |
| 3113 | takes a list of symbols for the different contexts where auto-filling | 3113 | takes a list of symbols for the different contexts where auto-filling |
| 3114 | never should occur: | 3114 | never should occur: |
| @@ -3123,7 +3123,7 @@ Inside a C++ style line comment. | |||
| 3123 | @item cpp | 3123 | @item cpp |
| 3124 | Inside a preprocessor directive. | 3124 | Inside a preprocessor directive. |
| 3125 | @item code | 3125 | @item code |
| 3126 | Anywhere else, i.e. in normal code. | 3126 | Anywhere else, i.e., in normal code. |
| 3127 | @end table | 3127 | @end table |
| 3128 | 3128 | ||
| 3129 | By default, @code{c-ignore-auto-fill} is set to @code{(string cpp | 3129 | By default, @code{c-ignore-auto-fill} is set to @code{(string cpp |
| @@ -3151,7 +3151,7 @@ Note that @ccmode{} sets @code{comment-multi-line} to @code{t} at | |||
| 3151 | startup. The reason is that @kbd{M-j} could otherwise produce sequences | 3151 | startup. The reason is that @kbd{M-j} could otherwise produce sequences |
| 3152 | of single line block comments for texts that should logically be treated | 3152 | of single line block comments for texts that should logically be treated |
| 3153 | as one comment, and the rest of the paragraph handling code | 3153 | as one comment, and the rest of the paragraph handling code |
| 3154 | (e.g. @kbd{M-q} and @kbd{M-a}) can't cope with that, which would lead to | 3154 | (e.g., @kbd{M-q} and @kbd{M-a}) can't cope with that, which would lead to |
| 3155 | inconsistent behavior. | 3155 | inconsistent behavior. |
| 3156 | 3156 | ||
| 3157 | @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | 3157 | @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| @@ -3380,12 +3380,12 @@ giving a syntactic symbol an @dfn{action function} in | |||
| 3380 | 3380 | ||
| 3381 | @cindex customization, brace hanging | 3381 | @cindex customization, brace hanging |
| 3382 | An action function is called with two arguments: the syntactic symbol | 3382 | An action function is called with two arguments: the syntactic symbol |
| 3383 | for the brace (e.g. @code{substatement-open}), and the buffer position | 3383 | for the brace (e.g., @code{substatement-open}), and the buffer position |
| 3384 | where the brace has been inserted. Point is undefined on entry to an | 3384 | where the brace has been inserted. Point is undefined on entry to an |
| 3385 | action function, but the function must preserve it (e.g. by using | 3385 | action function, but the function must preserve it (e.g., by using |
| 3386 | @code{save-excursion}). The return value should be a list containing | 3386 | @code{save-excursion}). The return value should be a list containing |
| 3387 | some combination of @code{before} and @code{after}, including neither | 3387 | some combination of @code{before} and @code{after}, including neither |
| 3388 | of them (i.e. @code{nil}). | 3388 | of them (i.e., @code{nil}). |
| 3389 | 3389 | ||
| 3390 | @defvar c-syntactic-context | 3390 | @defvar c-syntactic-context |
| 3391 | @vindex syntactic-context (c-) | 3391 | @vindex syntactic-context (c-) |
| @@ -3566,7 +3566,7 @@ statements. In addition to | |||
| 3566 | @ccmode{} also comes with the criteria function | 3566 | @ccmode{} also comes with the criteria function |
| 3567 | @code{c-semi&comma-no-newlines-for-oneline-inliners}, which suppresses | 3567 | @code{c-semi&comma-no-newlines-for-oneline-inliners}, which suppresses |
| 3568 | newlines after semicolons inside one-line inline method definitions | 3568 | newlines after semicolons inside one-line inline method definitions |
| 3569 | (e.g. in C++ or Java). | 3569 | (e.g., in C++ or Java). |
| 3570 | @end defun | 3570 | @end defun |
| 3571 | 3571 | ||
| 3572 | 3572 | ||
| @@ -3580,7 +3580,7 @@ newlines after semicolons inside one-line inline method definitions | |||
| 3580 | @dfn{Clean-ups} are mechanisms which remove (or exceptionally, add) | 3580 | @dfn{Clean-ups} are mechanisms which remove (or exceptionally, add) |
| 3581 | whitespace in specific circumstances and are complementary to colon | 3581 | whitespace in specific circumstances and are complementary to colon |
| 3582 | and brace hanging. You enable a clean-up by adding its symbol into | 3582 | and brace hanging. You enable a clean-up by adding its symbol into |
| 3583 | @code{c-cleanup-list}, e.g. like this: | 3583 | @code{c-cleanup-list}, e.g., like this: |
| 3584 | 3584 | ||
| 3585 | @example | 3585 | @example |
| 3586 | (add-to-list 'c-cleanup-list 'space-before-funcall) | 3586 | (add-to-list 'c-cleanup-list 'space-before-funcall) |
| @@ -3588,7 +3588,7 @@ and brace hanging. You enable a clean-up by adding its symbol into | |||
| 3588 | 3588 | ||
| 3589 | On the surface, it would seem that clean-ups overlap the functionality | 3589 | On the surface, it would seem that clean-ups overlap the functionality |
| 3590 | provided by the @code{c-hanging-*-alist} variables. Clean-ups, | 3590 | provided by the @code{c-hanging-*-alist} variables. Clean-ups, |
| 3591 | however, are used to adjust code ``after-the-fact'', i.e. to adjust | 3591 | however, are used to adjust code ``after-the-fact'', i.e., to adjust |
| 3592 | the whitespace in constructs later than when they were typed. | 3592 | the whitespace in constructs later than when they were typed. |
| 3593 | 3593 | ||
| 3594 | Most of the clean-ups remove automatically inserted newlines, and are | 3594 | Most of the clean-ups remove automatically inserted newlines, and are |
| @@ -3799,7 +3799,7 @@ Auto-newline minor mode are enabled: | |||
| 3799 | @item space-before-funcall | 3799 | @item space-before-funcall |
| 3800 | Insert a space between the function name and the opening parenthesis | 3800 | Insert a space between the function name and the opening parenthesis |
| 3801 | of a function call. This produces function calls in the style | 3801 | of a function call. This produces function calls in the style |
| 3802 | mandated by the GNU coding standards, e.g. @samp{signal@w{ }(SIGINT, | 3802 | mandated by the GNU coding standards, e.g., @samp{signal@w{ }(SIGINT, |
| 3803 | SIG_IGN)} and @samp{abort@w{ }()}. Clean up occurs when the opening | 3803 | SIG_IGN)} and @samp{abort@w{ }()}. Clean up occurs when the opening |
| 3804 | parenthesis is typed. This clean-up should never be active in AWK | 3804 | parenthesis is typed. This clean-up should never be active in AWK |
| 3805 | Mode, since such a space is syntactically invalid for user defined | 3805 | Mode, since such a space is syntactically invalid for user defined |
| @@ -3810,13 +3810,13 @@ Clean up any space between the function name and the opening parenthesis | |||
| 3810 | of a function call that has no arguments. This is typically used | 3810 | of a function call that has no arguments. This is typically used |
| 3811 | together with @code{space-before-funcall} if you prefer the GNU function | 3811 | together with @code{space-before-funcall} if you prefer the GNU function |
| 3812 | call style for functions with arguments but think it looks ugly when | 3812 | call style for functions with arguments but think it looks ugly when |
| 3813 | it's only an empty parenthesis pair. I.e. you will get @samp{signal | 3813 | it's only an empty parenthesis pair. I.e., you will get @samp{signal |
| 3814 | (SIGINT, SIG_IGN)}, but @samp{abort()}. Clean up occurs when the | 3814 | (SIGINT, SIG_IGN)}, but @samp{abort()}. Clean up occurs when the |
| 3815 | closing parenthesis is typed. | 3815 | closing parenthesis is typed. |
| 3816 | 3816 | ||
| 3817 | @item comment-close-slash | 3817 | @item comment-close-slash |
| 3818 | When inside a block comment, terminate the comment when you type a slash | 3818 | When inside a block comment, terminate the comment when you type a slash |
| 3819 | at the beginning of a line (i.e. immediately after the comment prefix). | 3819 | at the beginning of a line (i.e., immediately after the comment prefix). |
| 3820 | This clean-up removes whitespace preceding the slash and if needed, | 3820 | This clean-up removes whitespace preceding the slash and if needed, |
| 3821 | inserts a star to complete the token @samp{*/}. Type @kbd{C-q /} in this | 3821 | inserts a star to complete the token @samp{*/}. Type @kbd{C-q /} in this |
| 3822 | situation if you just want a literal @samp{/} inserted. | 3822 | situation if you just want a literal @samp{/} inserted. |
| @@ -3910,7 +3910,7 @@ brief and typical example: | |||
| 3910 | @noindent | 3910 | @noindent |
| 3911 | The first thing inside each syntactic element is always a | 3911 | The first thing inside each syntactic element is always a |
| 3912 | @dfn{syntactic symbol}. It describes the kind of construct that was | 3912 | @dfn{syntactic symbol}. It describes the kind of construct that was |
| 3913 | recognized, e.g. @code{statement}, @code{substatement}, | 3913 | recognized, e.g., @code{statement}, @code{substatement}, |
| 3914 | @code{class-open}, @code{class-close}, etc. @xref{Syntactic Symbols}, | 3914 | @code{class-open}, @code{class-close}, etc. @xref{Syntactic Symbols}, |
| 3915 | for a complete list of currently recognized syntactic symbols and | 3915 | for a complete list of currently recognized syntactic symbols and |
| 3916 | their semantics. The remaining entries are various data associated | 3916 | their semantics. The remaining entries are various data associated |
| @@ -3951,7 +3951,7 @@ position(s). | |||
| 3951 | @end table | 3951 | @end table |
| 3952 | 3952 | ||
| 3953 | Running this command on line 4 of this example, we'd see in the echo | 3953 | Running this command on line 4 of this example, we'd see in the echo |
| 3954 | area@footnote{With a universal argument (i.e. @kbd{C-u C-c C-s}) the | 3954 | area@footnote{With a universal argument (i.e., @kbd{C-u C-c C-s}) the |
| 3955 | analysis is inserted into the buffer as a comment on the current | 3955 | analysis is inserted into the buffer as a comment on the current |
| 3956 | line.}: | 3956 | line.}: |
| 3957 | 3957 | ||
| @@ -4219,7 +4219,7 @@ Method Symbols}. | |||
| 4219 | Lines continuing an Objective-C method call. @ref{Objective-C Method | 4219 | Lines continuing an Objective-C method call. @ref{Objective-C Method |
| 4220 | Symbols}. | 4220 | Symbols}. |
| 4221 | @item extern-lang-open | 4221 | @item extern-lang-open |
| 4222 | Brace that opens an @code{extern} block (e.g. @code{extern "C" | 4222 | Brace that opens an @code{extern} block (e.g., @code{extern "C" |
| 4223 | @{...@}}). @ref{External Scope Symbols}. | 4223 | @{...@}}). @ref{External Scope Symbols}. |
| 4224 | @item extern-lang-close | 4224 | @item extern-lang-close |
| 4225 | Brace that closes an @code{extern} block. @ref{External Scope | 4225 | Brace that closes an @code{extern} block. @ref{External Scope |
| @@ -4246,10 +4246,10 @@ Analogous to the above, but for CORBA CIDL @code{composition} blocks. | |||
| 4246 | C++ template argument list continuations. @ref{Class Symbols}. | 4246 | C++ template argument list continuations. @ref{Class Symbols}. |
| 4247 | @item inlambda | 4247 | @item inlambda |
| 4248 | Analogous to @code{inclass} syntactic symbol, but used inside lambda | 4248 | Analogous to @code{inclass} syntactic symbol, but used inside lambda |
| 4249 | (i.e. anonymous) functions. Only used in Pike mode. @ref{Statement | 4249 | (i.e., anonymous) functions. Only used in Pike mode. @ref{Statement |
| 4250 | Block Symbols}. | 4250 | Block Symbols}. |
| 4251 | @item lambda-intro-cont | 4251 | @item lambda-intro-cont |
| 4252 | Lines continuing the header of a lambda function, i.e. between the | 4252 | Lines continuing the header of a lambda function, i.e., between the |
| 4253 | @code{lambda} keyword and the function body. Only used in Pike mode. | 4253 | @code{lambda} keyword and the function body. Only used in Pike mode. |
| 4254 | @ref{Statement Block Symbols}. | 4254 | @ref{Statement Block Symbols}. |
| 4255 | @item inexpr-statement | 4255 | @item inexpr-statement |
| @@ -4311,7 +4311,7 @@ top-level construct introduction so it has the syntax | |||
| 4311 | the brace that opens a top-level function definition. Line 9 is the | 4311 | the brace that opens a top-level function definition. Line 9 is the |
| 4312 | corresponding | 4312 | corresponding |
| 4313 | @code{defun-close} since it contains the brace that closes the top-level | 4313 | @code{defun-close} since it contains the brace that closes the top-level |
| 4314 | function definition. Line 4 is a @code{defun-block-intro}, i.e. it is | 4314 | function definition. Line 4 is a @code{defun-block-intro}, i.e., it is |
| 4315 | the first line of a brace-block, enclosed in a | 4315 | the first line of a brace-block, enclosed in a |
| 4316 | top-level function definition. | 4316 | top-level function definition. |
| 4317 | 4317 | ||
| @@ -4360,7 +4360,7 @@ structs, and unions are essentially equivalent syntactically (and are | |||
| 4360 | very similar semantically), so replacing the @code{class} keyword in the | 4360 | very similar semantically), so replacing the @code{class} keyword in the |
| 4361 | example above with @code{struct} or @code{union} would still result in a | 4361 | example above with @code{struct} or @code{union} would still result in a |
| 4362 | syntax of @code{class-open} for line 4 @footnote{This is the case even | 4362 | syntax of @code{class-open} for line 4 @footnote{This is the case even |
| 4363 | for C and Objective-C. For consistency, structs in all supported | 4363 | for C and Objective-C@. For consistency, structs in all supported |
| 4364 | languages are syntactically equivalent to classes. Note however that | 4364 | languages are syntactically equivalent to classes. Note however that |
| 4365 | the keyword @code{class} is meaningless in C and Objective-C.}. | 4365 | the keyword @code{class} is meaningless in C and Objective-C.}. |
| 4366 | Similarly, line 18 is assigned @code{class-close} syntax. | 4366 | Similarly, line 18 is assigned @code{class-close} syntax. |
| @@ -4668,7 +4668,7 @@ where @code{inextern-lang} is a modifier similar in purpose to | |||
| 4668 | 4668 | ||
| 4669 | There are various other top level blocks like @code{extern}, and they | 4669 | There are various other top level blocks like @code{extern}, and they |
| 4670 | are all treated in the same way except that the symbols are named after | 4670 | are all treated in the same way except that the symbols are named after |
| 4671 | the keyword that introduces the block. E.g. C++ namespace blocks get | 4671 | the keyword that introduces the block. E.g., C++ namespace blocks get |
| 4672 | the three symbols @code{namespace-open}, @code{namespace-close} and | 4672 | the three symbols @code{namespace-open}, @code{namespace-close} and |
| 4673 | @code{innamespace}. The currently recognized top level blocks are: | 4673 | @code{innamespace}. The currently recognized top level blocks are: |
| 4674 | 4674 | ||
| @@ -4857,9 +4857,9 @@ Line 17 is assigned @code{stream-op} syntax. | |||
| 4857 | @ssindex cpp-define-intro | 4857 | @ssindex cpp-define-intro |
| 4858 | @ssindex cpp-macro-cont | 4858 | @ssindex cpp-macro-cont |
| 4859 | Multiline preprocessor macro definitions are normally handled just like | 4859 | Multiline preprocessor macro definitions are normally handled just like |
| 4860 | other code, i.e. the lines inside them are indented according to the | 4860 | other code, i.e., the lines inside them are indented according to the |
| 4861 | syntactic analysis of the preceding lines inside the macro. The first | 4861 | syntactic analysis of the preceding lines inside the macro. The first |
| 4862 | line inside a macro definition (i.e. the line after the starting line of | 4862 | line inside a macro definition (i.e., the line after the starting line of |
| 4863 | the cpp directive itself) gets @code{cpp-define-intro}. In this example: | 4863 | the cpp directive itself) gets @code{cpp-define-intro}. In this example: |
| 4864 | 4864 | ||
| 4865 | @example | 4865 | @example |
| @@ -4875,7 +4875,7 @@ line 1 is given the syntactic symbol @code{cpp-macro}. The first line | |||
| 4875 | of a cpp directive is always given that symbol. Line 2 is given | 4875 | of a cpp directive is always given that symbol. Line 2 is given |
| 4876 | @code{cpp-define-intro}, so that you can give the macro body as a whole | 4876 | @code{cpp-define-intro}, so that you can give the macro body as a whole |
| 4877 | some extra indentation. Lines 3 through 5 are then analyzed as normal | 4877 | some extra indentation. Lines 3 through 5 are then analyzed as normal |
| 4878 | code, i.e. @code{substatement} on lines 3 and 4, and @code{else-clause} | 4878 | code, i.e., @code{substatement} on lines 3 and 4, and @code{else-clause} |
| 4879 | on line 5. | 4879 | on line 5. |
| 4880 | 4880 | ||
| 4881 | The syntactic analysis inside macros can be turned off with | 4881 | The syntactic analysis inside macros can be turned off with |
| @@ -5025,7 +5025,7 @@ handled like this too. | |||
| 5025 | @ssindex knr-argdecl-intro | 5025 | @ssindex knr-argdecl-intro |
| 5026 | @ssindex knr-argdecl | 5026 | @ssindex knr-argdecl |
| 5027 | Two other syntactic symbols can appear in old style, non-prototyped C | 5027 | Two other syntactic symbols can appear in old style, non-prototyped C |
| 5028 | code @footnote{a.k.a. K&R C, or Kernighan & Ritchie C}: | 5028 | code @footnote{a.k.a.@: K&R C, or Kernighan & Ritchie C}: |
| 5029 | 5029 | ||
| 5030 | @example | 5030 | @example |
| 5031 | 1: int add_three_integers(a, b, c) | 5031 | 1: int add_three_integers(a, b, c) |
| @@ -5039,7 +5039,7 @@ code @footnote{a.k.a. K&R C, or Kernighan & Ritchie C}: | |||
| 5039 | 5039 | ||
| 5040 | Here, line 2 is the first line in an argument declaration list and so is | 5040 | Here, line 2 is the first line in an argument declaration list and so is |
| 5041 | given the @code{knr-argdecl-intro} syntactic symbol. Subsequent lines | 5041 | given the @code{knr-argdecl-intro} syntactic symbol. Subsequent lines |
| 5042 | (i.e. lines 3 and 4 in this example), are given @code{knr-argdecl} | 5042 | (i.e., lines 3 and 4 in this example), are given @code{knr-argdecl} |
| 5043 | syntax. | 5043 | syntax. |
| 5044 | 5044 | ||
| 5045 | 5045 | ||
| @@ -5703,7 +5703,7 @@ expressions. | |||
| 5703 | @defun c-lineup-inexpr-block | 5703 | @defun c-lineup-inexpr-block |
| 5704 | @findex lineup-inexpr-block (c-) | 5704 | @findex lineup-inexpr-block (c-) |
| 5705 | This can be used with the in-expression block symbols to indent the | 5705 | This can be used with the in-expression block symbols to indent the |
| 5706 | whole block to the column where the construct is started. E.g. for Java | 5706 | whole block to the column where the construct is started. E.g., for Java |
| 5707 | anonymous classes, this lines up the class under the @samp{new} keyword, | 5707 | anonymous classes, this lines up the class under the @samp{new} keyword, |
| 5708 | and in Pike it lines up the lambda function body under the @samp{lambda} | 5708 | and in Pike it lines up the lambda function body under the @samp{lambda} |
| 5709 | keyword. Returns @code{nil} if the block isn't part of such a | 5709 | keyword. Returns @code{nil} if the block isn't part of such a |
| @@ -5793,7 +5793,7 @@ In the first case the indentation is kept unchanged, in the second | |||
| 5793 | @code{inline-close}, @code{block-close}, @code{brace-list-close}, | 5793 | @code{inline-close}, @code{block-close}, @code{brace-list-close}, |
| 5794 | @code{brace-list-intro}, @code{statement-block-intro}, | 5794 | @code{brace-list-intro}, @code{statement-block-intro}, |
| 5795 | @code{arglist-intro}, @code{arglist-cont-nonempty}, | 5795 | @code{arglist-intro}, @code{arglist-cont-nonempty}, |
| 5796 | @code{arglist-close}, and all @code{in*} symbols, e.g. @code{inclass} | 5796 | @code{arglist-close}, and all @code{in*} symbols, e.g., @code{inclass} |
| 5797 | and @code{inextern-lang}. | 5797 | and @code{inextern-lang}. |
| 5798 | @end defun | 5798 | @end defun |
| 5799 | 5799 | ||
| @@ -6053,7 +6053,7 @@ if ( x < 10 | |||
| 6053 | 6053 | ||
| 6054 | Since this function doesn't do anything for lines without an infix | 6054 | Since this function doesn't do anything for lines without an infix |
| 6055 | operator you typically want to use it together with some other lineup | 6055 | operator you typically want to use it together with some other lineup |
| 6056 | settings, e.g. as follows (the @code{arglist-close} setting is just a | 6056 | settings, e.g., as follows (the @code{arglist-close} setting is just a |
| 6057 | suggestion to get a consistent style): | 6057 | suggestion to get a consistent style): |
| 6058 | 6058 | ||
| 6059 | @example | 6059 | @example |
| @@ -6087,7 +6087,7 @@ operator too, try to align it with the first one. | |||
| 6087 | @defun c-lineup-math | 6087 | @defun c-lineup-math |
| 6088 | @findex lineup-math (c-) | 6088 | @findex lineup-math (c-) |
| 6089 | Like @code{c-lineup-assignments} but indent with @code{c-basic-offset} | 6089 | Like @code{c-lineup-assignments} but indent with @code{c-basic-offset} |
| 6090 | if no assignment operator was found on the first line. I.e. this | 6090 | if no assignment operator was found on the first line. I.e., this |
| 6091 | function is the same as specifying a list @code{(c-lineup-assignments | 6091 | function is the same as specifying a list @code{(c-lineup-assignments |
| 6092 | +)}. It's provided for compatibility with old configurations. | 6092 | +)}. It's provided for compatibility with old configurations. |
| 6093 | 6093 | ||
| @@ -6123,7 +6123,7 @@ expressions. | |||
| 6123 | 6123 | ||
| 6124 | @defun c-lineup-streamop | 6124 | @defun c-lineup-streamop |
| 6125 | @findex lineup-streamop (c-) | 6125 | @findex lineup-streamop (c-) |
| 6126 | Line up C++ stream operators (i.e. @samp{<<} and @samp{>>}). | 6126 | Line up C++ stream operators (i.e., @samp{<<} and @samp{>>}). |
| 6127 | 6127 | ||
| 6128 | @workswith @code{stream-op}. | 6128 | @workswith @code{stream-op}. |
| 6129 | @end defun | 6129 | @end defun |
| @@ -6204,7 +6204,7 @@ to handle most of the common comment styles. Some examples: | |||
| 6204 | @end example | 6204 | @end example |
| 6205 | 6205 | ||
| 6206 | The style variable @code{c-comment-prefix-regexp} is used to recognize | 6206 | The style variable @code{c-comment-prefix-regexp} is used to recognize |
| 6207 | the comment line prefix, e.g. the @samp{*} that usually starts every | 6207 | the comment line prefix, e.g., the @samp{*} that usually starts every |
| 6208 | line inside a comment. | 6208 | line inside a comment. |
| 6209 | 6209 | ||
| 6210 | @workswith The @code{c} syntactic symbol. | 6210 | @workswith The @code{c} syntactic symbol. |
| @@ -6315,7 +6315,7 @@ int dribble() @{ | |||
| 6315 | 6315 | ||
| 6316 | If @code{c-syntactic-indentation-in-macros} is non-@code{nil}, the | 6316 | If @code{c-syntactic-indentation-in-macros} is non-@code{nil}, the |
| 6317 | function returns the relative indentation to the macro start line to | 6317 | function returns the relative indentation to the macro start line to |
| 6318 | allow accumulation with other offsets. E.g. in the following cases, | 6318 | allow accumulation with other offsets. E.g., in the following cases, |
| 6319 | @code{cpp-define-intro} is combined with the | 6319 | @code{cpp-define-intro} is combined with the |
| 6320 | @code{statement-block-intro} that comes from the @samp{do @{} that hangs | 6320 | @code{statement-block-intro} that comes from the @samp{do @{} that hangs |
| 6321 | on the @samp{#define} line: | 6321 | on the @samp{#define} line: |
| @@ -6390,7 +6390,7 @@ The @samp{x} line is aligned to the text after the @samp{:} on the | |||
| 6390 | This is done only in an @samp{asm} or @samp{__asm__} block, and only to | 6390 | This is done only in an @samp{asm} or @samp{__asm__} block, and only to |
| 6391 | those lines mentioned. Anywhere else @code{nil} is returned. The usual | 6391 | those lines mentioned. Anywhere else @code{nil} is returned. The usual |
| 6392 | arrangement is to have this routine as an extra feature at the start of | 6392 | arrangement is to have this routine as an extra feature at the start of |
| 6393 | arglist lineups, e.g. | 6393 | arglist lineups, e.g.: |
| 6394 | 6394 | ||
| 6395 | @example | 6395 | @example |
| 6396 | (c-lineup-gcc-asm-reg c-lineup-arglist) | 6396 | (c-lineup-gcc-asm-reg c-lineup-arglist) |
| @@ -6486,7 +6486,7 @@ another line-up function. Full details of these are in | |||
| 6486 | 6486 | ||
| 6487 | Line-up functions must not move point or change the content of the | 6487 | Line-up functions must not move point or change the content of the |
| 6488 | buffer (except temporarily). They are however allowed to do | 6488 | buffer (except temporarily). They are however allowed to do |
| 6489 | @dfn{hidden buffer changes}, i.e. setting text properties for caching | 6489 | @dfn{hidden buffer changes}, i.e., setting text properties for caching |
| 6490 | purposes etc. Buffer undo recording is disabled while they run. | 6490 | purposes etc. Buffer undo recording is disabled while they run. |
| 6491 | 6491 | ||
| 6492 | The syntactic element passed as the parameter to a line-up function is | 6492 | The syntactic element passed as the parameter to a line-up function is |
| @@ -6514,7 +6514,7 @@ your setup for this by using the access functions | |||
| 6514 | @vindex syntactic-element (c-) | 6514 | @vindex syntactic-element (c-) |
| 6515 | @vindex c-syntactic-context | 6515 | @vindex c-syntactic-context |
| 6516 | @vindex syntactic-context (c-) | 6516 | @vindex syntactic-context (c-) |
| 6517 | Some syntactic symbols, e.g. @code{arglist-cont-nonempty}, have more | 6517 | Some syntactic symbols, e.g., @code{arglist-cont-nonempty}, have more |
| 6518 | info in the syntactic element - typically other positions that can be | 6518 | info in the syntactic element - typically other positions that can be |
| 6519 | interesting besides the anchor position. That info can't be accessed | 6519 | interesting besides the anchor position. That info can't be accessed |
| 6520 | through the passed argument, which is a cons cell. Instead, you can | 6520 | through the passed argument, which is a cons cell. Instead, you can |
| @@ -6600,9 +6600,9 @@ Line-Up}). | |||
| 6600 | 6600 | ||
| 6601 | When the indentation engine calls this hook, the variable | 6601 | When the indentation engine calls this hook, the variable |
| 6602 | @code{c-syntactic-context} is bound to the current syntactic context | 6602 | @code{c-syntactic-context} is bound to the current syntactic context |
| 6603 | (i.e. what you would get by typing @kbd{C-c C-s} on the source line. | 6603 | (i.e., what you would get by typing @kbd{C-c C-s} on the source line. |
| 6604 | @xref{Custom Braces}.). Note that you should not change point or mark | 6604 | @xref{Custom Braces}.). Note that you should not change point or mark |
| 6605 | inside a @code{c-special-indent-hook} function, i.e. you'll probably | 6605 | inside a @code{c-special-indent-hook} function, i.e., you'll probably |
| 6606 | want to wrap your function in a @code{save-excursion}@footnote{The | 6606 | want to wrap your function in a @code{save-excursion}@footnote{The |
| 6607 | numerical value returned by @code{point} will change if you change the | 6607 | numerical value returned by @code{point} will change if you change the |
| 6608 | indentation of the line within a @code{save-excursion} form, but point | 6608 | indentation of the line within a @code{save-excursion} form, but point |
| @@ -6673,11 +6673,11 @@ customized with these variables: | |||
| 6673 | These variables control the alignment columns for line continuation | 6673 | These variables control the alignment columns for line continuation |
| 6674 | backslashes in multiline macros. They are used by the functions that | 6674 | backslashes in multiline macros. They are used by the functions that |
| 6675 | automatically insert or align such backslashes, | 6675 | automatically insert or align such backslashes, |
| 6676 | e.g. @code{c-backslash-region} and @code{c-context-line-break}. | 6676 | e.g., @code{c-backslash-region} and @code{c-context-line-break}. |
| 6677 | 6677 | ||
| 6678 | @code{c-backslash-column} specifies the minimum column for the | 6678 | @code{c-backslash-column} specifies the minimum column for the |
| 6679 | backslashes. If any line in the macro goes past this column, then the | 6679 | backslashes. If any line in the macro goes past this column, then the |
| 6680 | next tab stop (i.e. next multiple of @code{tab-width}) in that line is | 6680 | next tab stop (i.e., next multiple of @code{tab-width}) in that line is |
| 6681 | used as the alignment column for all the backslashes, so that they | 6681 | used as the alignment column for all the backslashes, so that they |
| 6682 | remain in a single column. However, if any lines go past | 6682 | remain in a single column. However, if any lines go past |
| 6683 | @code{c-backslash-max-column} then the backslashes in the rest of the | 6683 | @code{c-backslash-max-column} then the backslashes in the rest of the |
| @@ -6693,7 +6693,7 @@ the automatic alignment of backslashes, use | |||
| 6693 | @vindex auto-align-backslashes (c-) | 6693 | @vindex auto-align-backslashes (c-) |
| 6694 | Align automatically inserted line continuation backslashes if | 6694 | Align automatically inserted line continuation backslashes if |
| 6695 | non-@code{nil}. When line continuation backslashes are inserted | 6695 | non-@code{nil}. When line continuation backslashes are inserted |
| 6696 | automatically for line breaks in multiline macros, e.g. by | 6696 | automatically for line breaks in multiline macros, e.g., by |
| 6697 | @code{c-context-line-break}, they are aligned with the other | 6697 | @code{c-context-line-break}, they are aligned with the other |
| 6698 | backslashes in the same macro if this flag is set. | 6698 | backslashes in the same macro if this flag is set. |
| 6699 | 6699 | ||
| @@ -6878,9 +6878,9 @@ pathological code can cause @ccmode{} to perform fairly badly. This | |||
| 6878 | section gives some insight in how @ccmode{} operates, how that interacts | 6878 | section gives some insight in how @ccmode{} operates, how that interacts |
| 6879 | with some coding styles, and what you can use to improve performance. | 6879 | with some coding styles, and what you can use to improve performance. |
| 6880 | 6880 | ||
| 6881 | The overall goal is that @ccmode{} shouldn't be overly slow (i.e. take | 6881 | The overall goal is that @ccmode{} shouldn't be overly slow (i.e., take |
| 6882 | more than a fraction of a second) in any interactive operation. | 6882 | more than a fraction of a second) in any interactive operation. |
| 6883 | I.e. it's tuned to limit the maximum response time in single operations, | 6883 | I.e., it's tuned to limit the maximum response time in single operations, |
| 6884 | which is sometimes at the expense of batch-like operations like | 6884 | which is sometimes at the expense of batch-like operations like |
| 6885 | reindenting whole blocks. If you find that @ccmode{} gradually gets | 6885 | reindenting whole blocks. If you find that @ccmode{} gradually gets |
| 6886 | slower and slower in certain situations, perhaps as the file grows in | 6886 | slower and slower in certain situations, perhaps as the file grows in |
| @@ -6898,7 +6898,7 @@ gets. | |||
| 6898 | 6898 | ||
| 6899 | @findex beginning-of-defun | 6899 | @findex beginning-of-defun |
| 6900 | In earlier versions of @ccmode{}, we used to recommend putting the | 6900 | In earlier versions of @ccmode{}, we used to recommend putting the |
| 6901 | opening brace of a top-level construct@footnote{E.g. a function in C, | 6901 | opening brace of a top-level construct@footnote{E.g., a function in C, |
| 6902 | or outermost class definition in C++ or Java.} into the leftmost | 6902 | or outermost class definition in C++ or Java.} into the leftmost |
| 6903 | column. Earlier still, this used to be a rigid Emacs constraint, as | 6903 | column. Earlier still, this used to be a rigid Emacs constraint, as |
| 6904 | embodied in the @code{beginning-of-defun} function. @ccmode now | 6904 | embodied in the @code{beginning-of-defun} function. @ccmode now |
| @@ -6940,7 +6940,7 @@ XEmacs users can set the variable | |||
| 6940 | tells @ccmode{} to use XEmacs-specific built-in functions which, in some | 6940 | tells @ccmode{} to use XEmacs-specific built-in functions which, in some |
| 6941 | circumstances, can locate the top-most opening brace much more quickly than | 6941 | circumstances, can locate the top-most opening brace much more quickly than |
| 6942 | @code{beginning-of-defun}. Preliminary testing has shown that for | 6942 | @code{beginning-of-defun}. Preliminary testing has shown that for |
| 6943 | styles where these braces are hung (e.g. most JDK-derived Java styles), | 6943 | styles where these braces are hung (e.g., most JDK-derived Java styles), |
| 6944 | this hack can improve performance of the core syntax parsing routines | 6944 | this hack can improve performance of the core syntax parsing routines |
| 6945 | from 3 to 60 times. However, for styles which @emph{do} conform to | 6945 | from 3 to 60 times. However, for styles which @emph{do} conform to |
| 6946 | Emacs's recommended style of putting top-level braces in column zero, | 6946 | Emacs's recommended style of putting top-level braces in column zero, |
| @@ -6951,7 +6951,7 @@ in Emacs since the necessary built-in functions don't exist (in Emacs | |||
| 6951 | 22.1 as of this writing in February 2007). | 6951 | 22.1 as of this writing in February 2007). |
| 6952 | 6952 | ||
| 6953 | Text properties are used to speed up skipping over syntactic whitespace, | 6953 | Text properties are used to speed up skipping over syntactic whitespace, |
| 6954 | i.e. comments and preprocessor directives. Indenting a line after a | 6954 | i.e., comments and preprocessor directives. Indenting a line after a |
| 6955 | huge macro definition can be slow the first time, but after that the | 6955 | huge macro definition can be slow the first time, but after that the |
| 6956 | text properties are in place and it should be fast (even after you've | 6956 | text properties are in place and it should be fast (even after you've |
| 6957 | edited other parts of the file and then moved back). | 6957 | edited other parts of the file and then moved back). |
| @@ -6959,7 +6959,7 @@ edited other parts of the file and then moved back). | |||
| 6959 | Font locking can be a CPU hog, especially the font locking done on | 6959 | Font locking can be a CPU hog, especially the font locking done on |
| 6960 | decoration level 3 which tries to be very accurate. Note that that | 6960 | decoration level 3 which tries to be very accurate. Note that that |
| 6961 | level is designed to be used with a font lock support mode that only | 6961 | level is designed to be used with a font lock support mode that only |
| 6962 | fontifies the text that's actually shown, i.e. Lazy Lock or Just-in-time | 6962 | fontifies the text that's actually shown, i.e., Lazy Lock or Just-in-time |
| 6963 | Lock mode, so make sure you use one of them. Fontification of a whole | 6963 | Lock mode, so make sure you use one of them. Fontification of a whole |
| 6964 | buffer with some thousand lines can often take over a minute. That is | 6964 | buffer with some thousand lines can often take over a minute. That is |
| 6965 | a known weakness; the idea is that it never should happen. | 6965 | a known weakness; the idea is that it never should happen. |
| @@ -6998,14 +6998,14 @@ geared to be used interactively to edit new code. There's currently no | |||
| 6998 | intention to change this goal. | 6998 | intention to change this goal. |
| 6999 | 6999 | ||
| 7000 | If you want to reformat old code, you're probably better off using some | 7000 | If you want to reformat old code, you're probably better off using some |
| 7001 | other tool instead, e.g. @ref{Top, , GNU indent, indent, The `indent' | 7001 | other tool instead, e.g., @ref{Top, , GNU indent, indent, The `indent' |
| 7002 | Manual}, which has more powerful reformatting capabilities than | 7002 | Manual}, which has more powerful reformatting capabilities than |
| 7003 | @ccmode{}. | 7003 | @ccmode{}. |
| 7004 | 7004 | ||
| 7005 | @item | 7005 | @item |
| 7006 | The support for C++ templates (in angle brackets) is not yet complete. | 7006 | The support for C++ templates (in angle brackets) is not yet complete. |
| 7007 | When a non-nested template is used in a declaration, @ccmode{} indents | 7007 | When a non-nested template is used in a declaration, @ccmode{} indents |
| 7008 | it and font-locks it OK. Templates used in expressions, and nested | 7008 | it and font-locks it OK@. Templates used in expressions, and nested |
| 7009 | templates do not fare so well. Sometimes a workaround is to refontify | 7009 | templates do not fare so well. Sometimes a workaround is to refontify |
| 7010 | the expression after typing the closing @samp{>}. | 7010 | the expression after typing the closing @samp{>}. |
| 7011 | 7011 | ||
| @@ -7063,7 +7063,7 @@ too by adding this to your @code{c-initialization-hook}: | |||
| 7063 | @end example | 7063 | @end example |
| 7064 | 7064 | ||
| 7065 | @xref{Getting Started}. This is a very common question. If you want | 7065 | @xref{Getting Started}. This is a very common question. If you want |
| 7066 | this to be the default behavior, don't lobby us, lobby RMS! @t{:-)} | 7066 | this to be the default behavior, don't lobby us, lobby RMS@! @t{:-)} |
| 7067 | 7067 | ||
| 7068 | @item | 7068 | @item |
| 7069 | @emph{How do I stop my code jumping all over the place when I type?} | 7069 | @emph{How do I stop my code jumping all over the place when I type?} |
| @@ -7169,7 +7169,7 @@ to include any code that appears @emph{before} your bug example, if | |||
| 7169 | you think it might affect our ability to reproduce it. | 7169 | you think it might affect our ability to reproduce it. |
| 7170 | 7170 | ||
| 7171 | Please try to produce the problem in an Emacs instance without any | 7171 | Please try to produce the problem in an Emacs instance without any |
| 7172 | customizations loaded (i.e. start it with the @samp{-q --no-site-file} | 7172 | customizations loaded (i.e., start it with the @samp{-q --no-site-file} |
| 7173 | arguments). If it works correctly there, the problem might be caused | 7173 | arguments). If it works correctly there, the problem might be caused |
| 7174 | by faulty customizations in either your own or your site | 7174 | by faulty customizations in either your own or your site |
| 7175 | configuration. In that case, we'd appreciate it if you isolate the | 7175 | configuration. In that case, we'd appreciate it if you isolate the |
diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi index beefa3e9c40..67d99153951 100644 --- a/doc/misc/cl.texi +++ b/doc/misc/cl.texi | |||
| @@ -191,11 +191,11 @@ but use different function names (in fact, @file{cl.el} mainly just | |||
| 191 | defines aliases to the @file{cl-lib.el} definitions). Where | 191 | defines aliases to the @file{cl-lib.el} definitions). Where |
| 192 | @file{cl-lib.el} defines a function called, for example, | 192 | @file{cl-lib.el} defines a function called, for example, |
| 193 | @code{cl-incf}, @file{cl.el} uses the same name but without the | 193 | @code{cl-incf}, @file{cl.el} uses the same name but without the |
| 194 | @samp{cl-} prefix, e.g.@: @code{incf} in this example. There are a few | 194 | @samp{cl-} prefix, e.g., @code{incf} in this example. There are a few |
| 195 | exceptions to this. First, functions such as @code{cl-defun} where | 195 | exceptions to this. First, functions such as @code{cl-defun} where |
| 196 | the unprefixed version was already used for a standard Emacs Lisp | 196 | the unprefixed version was already used for a standard Emacs Lisp |
| 197 | function. In such cases, the @file{cl.el} version adds a @samp{*} | 197 | function. In such cases, the @file{cl.el} version adds a @samp{*} |
| 198 | suffix, e.g.@: @code{defun*}. Second, there are some obsolete features | 198 | suffix, e.g., @code{defun*}. Second, there are some obsolete features |
| 199 | that are only implemented in @file{cl.el}, not in @file{cl-lib.el}, | 199 | that are only implemented in @file{cl.el}, not in @file{cl-lib.el}, |
| 200 | because they are replaced by other standard Emacs Lisp features. | 200 | because they are replaced by other standard Emacs Lisp features. |
| 201 | Finally, in a very few cases the old @file{cl.el} versions do not | 201 | Finally, in a very few cases the old @file{cl.el} versions do not |
| @@ -898,8 +898,8 @@ generalized variables. | |||
| 898 | @node Setf Extensions | 898 | @node Setf Extensions |
| 899 | @subsection Setf Extensions | 899 | @subsection Setf Extensions |
| 900 | 900 | ||
| 901 | Several standard (e.g.@: @code{car}) and Emacs-specific | 901 | Several standard (e.g., @code{car}) and Emacs-specific |
| 902 | (e.g.@: @code{window-point}) Lisp functions are @code{setf}-able by default. | 902 | (e.g., @code{window-point}) Lisp functions are @code{setf}-able by default. |
| 903 | This package defines @code{setf} handlers for several additional functions: | 903 | This package defines @code{setf} handlers for several additional functions: |
| 904 | 904 | ||
| 905 | @itemize | 905 | @itemize |
| @@ -4870,7 +4870,7 @@ direct C-language calls to the message routines rather than going | |||
| 4870 | through the Lisp @code{message} function. | 4870 | through the Lisp @code{message} function. |
| 4871 | 4871 | ||
| 4872 | @c Bug#411. | 4872 | @c Bug#411. |
| 4873 | Note that many primitives (e.g.@: @code{+}) have special byte-compile | 4873 | Note that many primitives (e.g., @code{+}) have special byte-compile |
| 4874 | handling. Attempts to redefine such functions using @code{flet} will | 4874 | handling. Attempts to redefine such functions using @code{flet} will |
| 4875 | fail if byte-compiled. | 4875 | fail if byte-compiled. |
| 4876 | @c Or cl-flet. | 4876 | @c Or cl-flet. |
diff --git a/doc/misc/ebrowse.texi b/doc/misc/ebrowse.texi index 6db27a38808..e13ca4714a7 100644 --- a/doc/misc/ebrowse.texi +++ b/doc/misc/ebrowse.texi | |||
| @@ -445,7 +445,7 @@ where no highlight is displayed. | |||
| 445 | 445 | ||
| 446 | Class trees are displayed in @dfn{tree buffers} which install their own | 446 | Class trees are displayed in @dfn{tree buffers} which install their own |
| 447 | major mode. Most Emacs keys work in tree buffers in the usual way, | 447 | major mode. Most Emacs keys work in tree buffers in the usual way, |
| 448 | e.g.@: you can move around in the buffer with the usual @kbd{C-f}, | 448 | e.g., you can move around in the buffer with the usual @kbd{C-f}, |
| 449 | @kbd{C-v} etc., or you can search with @kbd{C-s}. | 449 | @kbd{C-v} etc., or you can search with @kbd{C-s}. |
| 450 | 450 | ||
| 451 | Tree-specific commands are bound to simple keystrokes, similar to | 451 | Tree-specific commands are bound to simple keystrokes, similar to |
| @@ -953,7 +953,7 @@ the completion list. If necessary, the current member list is switched | |||
| 953 | to the one containing the member. | 953 | to the one containing the member. |
| 954 | 954 | ||
| 955 | With a prefix argument (@kbd{C-u}), all members in the class tree, | 955 | With a prefix argument (@kbd{C-u}), all members in the class tree, |
| 956 | i.e.@: all members the browser knows about appear in the completion | 956 | i.e., all members the browser knows about appear in the completion |
| 957 | list. The member display will be switched to the class and member list | 957 | list. The member display will be switched to the class and member list |
| 958 | containing the member. | 958 | containing the member. |
| 959 | 959 | ||
| @@ -1333,7 +1333,7 @@ This command sets point to the previous position in the position stack. | |||
| 1333 | Directly after you performed a jump, this will put you back to the | 1333 | Directly after you performed a jump, this will put you back to the |
| 1334 | position where you came from. | 1334 | position where you came from. |
| 1335 | 1335 | ||
| 1336 | The stack is not popped, i.e.@: you can always switch back and forth | 1336 | The stack is not popped, i.e., you can always switch back and forth |
| 1337 | between positions in the stack. To avoid letting the stack grow to | 1337 | between positions in the stack. To avoid letting the stack grow to |
| 1338 | infinite size there is a maximum number of positions defined. When this | 1338 | infinite size there is a maximum number of positions defined. When this |
| 1339 | number is reached, older positions are discarded when new positions are | 1339 | number is reached, older positions are discarded when new positions are |
| @@ -1415,7 +1415,7 @@ given regular expression. This command can be very useful if you | |||
| 1415 | remember only part of a member name, and not its beginning. | 1415 | remember only part of a member name, and not its beginning. |
| 1416 | 1416 | ||
| 1417 | A special buffer is popped up containing all identifiers matching the | 1417 | A special buffer is popped up containing all identifiers matching the |
| 1418 | regular expression, and what kind of symbol it is (e.g.@: a member | 1418 | regular expression, and what kind of symbol it is (e.g., a member |
| 1419 | function, or a type). You can then switch to this buffer, and use the | 1419 | function, or a type). You can then switch to this buffer, and use the |
| 1420 | command @kbd{C-c C-m f}, for example, to jump to a specific member. | 1420 | command @kbd{C-c C-m f}, for example, to jump to a specific member. |
| 1421 | 1421 | ||
diff --git a/doc/misc/ede.texi b/doc/misc/ede.texi index 1299f2ff062..34ec72fc193 100644 --- a/doc/misc/ede.texi +++ b/doc/misc/ede.texi | |||
| @@ -1057,7 +1057,7 @@ and has an optimized include file identification function. | |||
| 1057 | @subsection Custom Locate | 1057 | @subsection Custom Locate |
| 1058 | 1058 | ||
| 1059 | The various simple project styles all have one major drawback, which | 1059 | The various simple project styles all have one major drawback, which |
| 1060 | is that the files in the project are not completely known to EDE. | 1060 | is that the files in the project are not completely known to EDE@. |
| 1061 | When the EDE API is used to try and file files by some reference name | 1061 | When the EDE API is used to try and file files by some reference name |
| 1062 | in the project, then that could fail. | 1062 | in the project, then that could fail. |
| 1063 | 1063 | ||
| @@ -1074,7 +1074,7 @@ To enable one of these tools, set the variable | |||
| 1074 | @code{ede-locate-setup-options} with the names of different locate | 1074 | @code{ede-locate-setup-options} with the names of different locate |
| 1075 | objects. @ref{Miscellaneous commands}. | 1075 | objects. @ref{Miscellaneous commands}. |
| 1076 | 1076 | ||
| 1077 | Configure this in your @file{.emacs} before loading in CEDET or EDE. | 1077 | Configure this in your @file{.emacs} before loading in CEDET or EDE@. |
| 1078 | If you want to add support for GNU Global, your configuration would | 1078 | If you want to add support for GNU Global, your configuration would |
| 1079 | look like this: | 1079 | look like this: |
| 1080 | 1080 | ||
| @@ -1083,7 +1083,7 @@ look like this: | |||
| 1083 | @end example | 1083 | @end example |
| 1084 | 1084 | ||
| 1085 | That way, when a search needs to be done, it will first try using | 1085 | That way, when a search needs to be done, it will first try using |
| 1086 | GLOBAL. If global is not available for that directory, then it will | 1086 | GLOBAL@. If global is not available for that directory, then it will |
| 1087 | revert to the base locate object. The base object always fails to | 1087 | revert to the base locate object. The base object always fails to |
| 1088 | find a file. | 1088 | find a file. |
| 1089 | 1089 | ||
| @@ -1100,7 +1100,7 @@ bugs in @ede{}. A knowledge of Emacs Lisp, and some @eieio{}(CLOS) is | |||
| 1100 | required. | 1100 | required. |
| 1101 | 1101 | ||
| 1102 | @ede{} uses @eieio{}, the CLOS package for Emacs, to define two object | 1102 | @ede{} uses @eieio{}, the CLOS package for Emacs, to define two object |
| 1103 | superclasses, specifically the PROJECT and TARGET. All commands in | 1103 | superclasses, specifically the PROJECT and TARGET@. All commands in |
| 1104 | @ede{} are usually meant to address the current project, or current | 1104 | @ede{} are usually meant to address the current project, or current |
| 1105 | target. | 1105 | target. |
| 1106 | 1106 | ||
| @@ -1273,7 +1273,7 @@ The function @code{ede-directory-project-p} will call | |||
| 1273 | @code{ede-dir-to-projectfile} on every @code{ede-project-autoload} | 1273 | @code{ede-dir-to-projectfile} on every @code{ede-project-autoload} |
| 1274 | until one of them returns true. The method | 1274 | until one of them returns true. The method |
| 1275 | @code{ede-dir-to-projectfile} in turn gets the @code{:proj-file} slot | 1275 | @code{ede-dir-to-projectfile} in turn gets the @code{:proj-file} slot |
| 1276 | from the autoload. If it is a string (ie, a project file name), it | 1276 | from the autoload. If it is a string (i.e., a project file name), it |
| 1277 | checks to see if that exists in BUFFER's directory. If it is a | 1277 | checks to see if that exists in BUFFER's directory. If it is a |
| 1278 | function, then it calls that function and expects it to return a file | 1278 | function, then it calls that function and expects it to return a file |
| 1279 | name or nil. If the file exists, then this directory is assumed to be | 1279 | name or nil. If the file exists, then this directory is assumed to be |
| @@ -1379,7 +1379,7 @@ List all documentation a project or target is responsible for. | |||
| 1379 | @ede{} projects track source file / target associates via source code | 1379 | @ede{} projects track source file / target associates via source code |
| 1380 | objects. The definitions for this is in @file{ede-source.el}. A source | 1380 | objects. The definitions for this is in @file{ede-source.el}. A source |
| 1381 | code object contains methods that know how to identify a file as being | 1381 | code object contains methods that know how to identify a file as being |
| 1382 | of that class, (ie, a C file ends with @file{.c}). Some targets can | 1382 | of that class, (i.e., a C file ends with @file{.c}). Some targets can |
| 1383 | handle many different types of sources which must all be compiled | 1383 | handle many different types of sources which must all be compiled |
| 1384 | together. For example, a mixed C and C++ program would have | 1384 | together. For example, a mixed C and C++ program would have |
| 1385 | instantiations of both sourcecode types. | 1385 | instantiations of both sourcecode types. |
| @@ -1635,7 +1635,7 @@ This is a URL to be sent to a web site for documentation. | |||
| 1635 | @item :web-site-directory @* | 1635 | @item :web-site-directory @* |
| 1636 | 1636 | ||
| 1637 | A directory where web pages can be found by Emacs. | 1637 | A directory where web pages can be found by Emacs. |
| 1638 | For remote locations use a path compatible with ange-ftp or EFS. | 1638 | For remote locations use a path compatible with ange-ftp or EFS@. |
| 1639 | You can also use TRAMP for use with rcp & scp. | 1639 | You can also use TRAMP for use with rcp & scp. |
| 1640 | @refill | 1640 | @refill |
| 1641 | 1641 | ||
| @@ -1978,7 +1978,7 @@ The function symbol must take two arguments: | |||
| 1978 | NAME - The name of the file to find. | 1978 | NAME - The name of the file to find. |
| 1979 | DIR - The directory root for this cpp-root project. | 1979 | DIR - The directory root for this cpp-root project. |
| 1980 | 1980 | ||
| 1981 | It should return the fully qualified file name passed in from NAME. If that file does not | 1981 | It should return the fully qualified file name passed in from NAME@. If that file does not |
| 1982 | exist, it should return nil. | 1982 | exist, it should return nil. |
| 1983 | @refill | 1983 | @refill |
| 1984 | 1984 | ||
| @@ -2565,7 +2565,7 @@ Optional @var{DEPTH} is the depth we start at. | |||
| 2565 | @end deffn | 2565 | @end deffn |
| 2566 | 2566 | ||
| 2567 | @deffn Method ede-buffer-header-file :AFTER this buffer | 2567 | @deffn Method ede-buffer-header-file :AFTER this buffer |
| 2568 | There are no default header files in EDE. | 2568 | There are no default header files in EDE@. |
| 2569 | Do a quick check to see if there is a Header tag in this buffer. | 2569 | Do a quick check to see if there is a Header tag in this buffer. |
| 2570 | @end deffn | 2570 | @end deffn |
| 2571 | 2571 | ||
diff --git a/doc/misc/ediff.texi b/doc/misc/ediff.texi index 0afcdd923d6..55bfb9f6cb8 100644 --- a/doc/misc/ediff.texi +++ b/doc/misc/ediff.texi | |||
| @@ -409,7 +409,7 @@ Many Ediff commands take numeric prefix arguments. For instance, if you | |||
| 409 | type a number, say 3, and then @kbd{j} (@code{ediff-jump-to-difference}), | 409 | type a number, say 3, and then @kbd{j} (@code{ediff-jump-to-difference}), |
| 410 | Ediff moves to the third difference region. Typing 3 and then @kbd{a} | 410 | Ediff moves to the third difference region. Typing 3 and then @kbd{a} |
| 411 | (@code{ediff-diff-to-diff}) copies the 3rd difference region from variant A | 411 | (@code{ediff-diff-to-diff}) copies the 3rd difference region from variant A |
| 412 | to variant B. Likewise, 4 followed by @kbd{ra} restores the 4th difference | 412 | to variant B@. Likewise, 4 followed by @kbd{ra} restores the 4th difference |
| 413 | region in buffer A (if it was previously written over via the command | 413 | region in buffer A (if it was previously written over via the command |
| 414 | @kbd{a}). | 414 | @kbd{a}). |
| 415 | 415 | ||
| @@ -490,7 +490,7 @@ compares three files simultaneously). | |||
| 490 | @kindex a | 490 | @kindex a |
| 491 | @emph{In comparison sessions:} | 491 | @emph{In comparison sessions:} |
| 492 | Copies the current difference region (or the region specified as the prefix | 492 | Copies the current difference region (or the region specified as the prefix |
| 493 | to this command) from buffer A to buffer B. | 493 | to this command) from buffer A to buffer B@. |
| 494 | Ediff saves the old contents of buffer B's region; it can | 494 | Ediff saves the old contents of buffer B's region; it can |
| 495 | be restored via the command @kbd{rb}, which see. | 495 | be restored via the command @kbd{rb}, which see. |
| 496 | 496 | ||
| @@ -512,31 +512,31 @@ be reinstated via the command @kbd{ra} in comparison sessions and | |||
| 512 | @item ab | 512 | @item ab |
| 513 | @kindex ab | 513 | @kindex ab |
| 514 | Copies the current difference region (or the region specified as the prefix | 514 | Copies the current difference region (or the region specified as the prefix |
| 515 | to this command) from buffer A to buffer B. This (and the next five) | 515 | to this command) from buffer A to buffer B@. This (and the next five) |
| 516 | command is enabled only in sessions that compare three files | 516 | command is enabled only in sessions that compare three files |
| 517 | simultaneously. The old region in buffer B is saved and can be restored | 517 | simultaneously. The old region in buffer B is saved and can be restored |
| 518 | via the command @kbd{rb}. | 518 | via the command @kbd{rb}. |
| 519 | @item ac | 519 | @item ac |
| 520 | @kindex ac | 520 | @kindex ac |
| 521 | Copies the difference region from buffer A to buffer C. | 521 | Copies the difference region from buffer A to buffer C@. |
| 522 | The old region in buffer C is saved and can be restored via the command | 522 | The old region in buffer C is saved and can be restored via the command |
| 523 | @kbd{rc}. | 523 | @kbd{rc}. |
| 524 | @item ba | 524 | @item ba |
| 525 | @kindex ba | 525 | @kindex ba |
| 526 | Copies the difference region from buffer B to buffer A. | 526 | Copies the difference region from buffer B to buffer A@. |
| 527 | The old region in buffer A is saved and can be restored via the command | 527 | The old region in buffer A is saved and can be restored via the command |
| 528 | @kbd{ra}. | 528 | @kbd{ra}. |
| 529 | @item bc | 529 | @item bc |
| 530 | @kindex bc | 530 | @kindex bc |
| 531 | Copies the difference region from buffer B to buffer C. | 531 | Copies the difference region from buffer B to buffer C@. |
| 532 | The command @kbd{rc} undoes this. | 532 | The command @kbd{rc} undoes this. |
| 533 | @item ca | 533 | @item ca |
| 534 | @kindex ca | 534 | @kindex ca |
| 535 | Copies the difference region from buffer C to buffer A. | 535 | Copies the difference region from buffer C to buffer A@. |
| 536 | The command @kbd{ra} undoes this. | 536 | The command @kbd{ra} undoes this. |
| 537 | @item cb | 537 | @item cb |
| 538 | @kindex cb | 538 | @kindex cb |
| 539 | Copies the difference region from buffer C to buffer B. | 539 | Copies the difference region from buffer C to buffer B@. |
| 540 | The command @kbd{rb} undoes this. | 540 | The command @kbd{rb} undoes this. |
| 541 | 541 | ||
| 542 | @item p | 542 | @item p |
| @@ -713,12 +713,12 @@ over. @xref{Selective Browsing}, for more. | |||
| 713 | 713 | ||
| 714 | @item A | 714 | @item A |
| 715 | @kindex A | 715 | @kindex A |
| 716 | Toggles the read-only property in buffer A. | 716 | Toggles the read-only property in buffer A@. |
| 717 | If file A is under version control and is checked in, it is checked out | 717 | If file A is under version control and is checked in, it is checked out |
| 718 | (with your permission). | 718 | (with your permission). |
| 719 | @item B | 719 | @item B |
| 720 | @kindex B | 720 | @kindex B |
| 721 | Toggles the read-only property in buffer B. | 721 | Toggles the read-only property in buffer B@. |
| 722 | If file B is under version control and is checked in, it is checked out. | 722 | If file B is under version control and is checked in, it is checked out. |
| 723 | @item C | 723 | @item C |
| 724 | @kindex C | 724 | @kindex C |
| @@ -795,7 +795,7 @@ While merging with an ancestor file, Ediff is determined to reduce user's | |||
| 795 | wear and tear by saving him and her much of unproductive, repetitive | 795 | wear and tear by saving him and her much of unproductive, repetitive |
| 796 | typing. If it notices that, say, file A's difference region is identical to | 796 | typing. If it notices that, say, file A's difference region is identical to |
| 797 | the same difference region in the ancestor file, then the merge buffer will | 797 | the same difference region in the ancestor file, then the merge buffer will |
| 798 | automatically get the difference region taken from buffer B. The rationale | 798 | automatically get the difference region taken from buffer B@. The rationale |
| 799 | is that this difference region in buffer A is as old as that in the | 799 | is that this difference region in buffer A is as old as that in the |
| 800 | ancestor buffer, so the contents of that region in buffer B represents real | 800 | ancestor buffer, so the contents of that region in buffer B represents real |
| 801 | change. | 801 | change. |
| @@ -820,7 +820,7 @@ To be more precise, this toggles the check for whether the current merge is | |||
| 820 | identical to its default setting, as originally decided by Ediff. For | 820 | identical to its default setting, as originally decided by Ediff. For |
| 821 | instance, if Ediff is merging according to the `combined' policy, then the | 821 | instance, if Ediff is merging according to the `combined' policy, then the |
| 822 | merge region is skipped over if it is different from the combination of the | 822 | merge region is skipped over if it is different from the combination of the |
| 823 | regions in buffers A and B. (Warning: swapping buffers A and B will confuse | 823 | regions in buffers A and B@. (Warning: swapping buffers A and B will confuse |
| 824 | things in this respect.) If the merge region is marked as `prefer-A' then | 824 | things in this respect.) If the merge region is marked as `prefer-A' then |
| 825 | this region will be skipped if it differs from the current difference | 825 | this region will be skipped if it differs from the current difference |
| 826 | region in buffer A, etc. | 826 | region in buffer A, etc. |
| @@ -1238,7 +1238,7 @@ Keep in mind that hooks executing before @code{ediff-cleanup-mess} start | |||
| 1238 | in @code{ediff-control-buffer;} they should also leave | 1238 | in @code{ediff-control-buffer;} they should also leave |
| 1239 | @code{ediff-control-buffer} as the current buffer when they finish. | 1239 | @code{ediff-control-buffer} as the current buffer when they finish. |
| 1240 | Hooks that are executed after @code{ediff-cleanup-mess} should expect | 1240 | Hooks that are executed after @code{ediff-cleanup-mess} should expect |
| 1241 | the current buffer be either buffer A or buffer B. | 1241 | the current buffer be either buffer A or buffer B@. |
| 1242 | @code{ediff-cleanup-mess} doesn't kill the buffers being compared or | 1242 | @code{ediff-cleanup-mess} doesn't kill the buffers being compared or |
| 1243 | merged (see @code{ediff-cleanup-hook}, below). | 1243 | merged (see @code{ediff-cleanup-hook}, below). |
| 1244 | 1244 | ||
| @@ -1361,7 +1361,7 @@ the variable @code{ediff-help-message}, which is local to | |||
| 1361 | @section Window and Frame Configuration | 1361 | @section Window and Frame Configuration |
| 1362 | 1362 | ||
| 1363 | On a non-windowing display, Ediff sets things up in one frame, splitting | 1363 | On a non-windowing display, Ediff sets things up in one frame, splitting |
| 1364 | it between a small control window and the windows for buffers A, B, and C. | 1364 | it between a small control window and the windows for buffers A, B, and C@. |
| 1365 | The split between these windows can be horizontal or | 1365 | The split between these windows can be horizontal or |
| 1366 | vertical, which can be changed interactively by typing @kbd{|} while the | 1366 | vertical, which can be changed interactively by typing @kbd{|} while the |
| 1367 | cursor is in the control window. | 1367 | cursor is in the control window. |
| @@ -1999,7 +1999,7 @@ represented as a list of the form @code{(STRING1 Symbol1 STRING2 Symbol2 | |||
| 1999 | STRING3 Symbol3 STRING4)}. The symbols here must be atoms of the form | 1999 | STRING3 Symbol3 STRING4)}. The symbols here must be atoms of the form |
| 2000 | @code{A}, @code{B}, or @code{Ancestor}. They determine the order in which | 2000 | @code{A}, @code{B}, or @code{Ancestor}. They determine the order in which |
| 2001 | the corresponding difference regions (from buffers A, B, and the ancestor | 2001 | the corresponding difference regions (from buffers A, B, and the ancestor |
| 2002 | buffer) are displayed in the merged region of buffer C. The strings in the | 2002 | buffer) are displayed in the merged region of buffer C@. The strings in the |
| 2003 | template determine the text that separates the aforesaid regions. The | 2003 | template determine the text that separates the aforesaid regions. The |
| 2004 | default template is | 2004 | default template is |
| 2005 | 2005 | ||
| @@ -2062,7 +2062,7 @@ you copy a difference region from buffer A to buffer C then | |||
| 2062 | @samp{=diff(B)} will change to @samp{diff-A} and the mode line will | 2062 | @samp{=diff(B)} will change to @samp{diff-A} and the mode line will |
| 2063 | display @samp{=diff(A) prefer-B}. This indicates that the difference | 2063 | display @samp{=diff(A) prefer-B}. This indicates that the difference |
| 2064 | region in buffer C is identical to that in buffer A, but originally | 2064 | region in buffer C is identical to that in buffer A, but originally |
| 2065 | buffer C's region came from buffer B. This is useful to know because | 2065 | buffer C's region came from buffer B@. This is useful to know because |
| 2066 | you can recover the original difference region in buffer C by typing | 2066 | you can recover the original difference region in buffer C by typing |
| 2067 | @kbd{r}. | 2067 | @kbd{r}. |
| 2068 | 2068 | ||
| @@ -2090,7 +2090,7 @@ buffer A consists of the white space only (or if it is empty), Ediff will | |||
| 2090 | not take it into account for the purpose of computing fine differences. The | 2090 | not take it into account for the purpose of computing fine differences. The |
| 2091 | result is that Ediff can provide a better visual information regarding the | 2091 | result is that Ediff can provide a better visual information regarding the |
| 2092 | actual fine differences in the non-white regions in buffers B and | 2092 | actual fine differences in the non-white regions in buffers B and |
| 2093 | C. Moreover, if the regions in buffers B and C differ in the white space | 2093 | C@. Moreover, if the regions in buffers B and C differ in the white space |
| 2094 | only, then a message to this effect will be displayed. | 2094 | only, then a message to this effect will be displayed. |
| 2095 | 2095 | ||
| 2096 | @vindex ediff-merge-window-share | 2096 | @vindex ediff-merge-window-share |
| @@ -2388,7 +2388,7 @@ In merging, this is the merge buffer. | |||
| 2388 | In two-way comparison, this variable is @code{nil}. | 2388 | In two-way comparison, this variable is @code{nil}. |
| 2389 | 2389 | ||
| 2390 | @item ediff-window-A | 2390 | @item ediff-window-A |
| 2391 | The window displaying buffer A. If buffer A is not visible, this variable | 2391 | The window displaying buffer A@. If buffer A is not visible, this variable |
| 2392 | is @code{nil} or it may be a dead window. | 2392 | is @code{nil} or it may be a dead window. |
| 2393 | 2393 | ||
| 2394 | @item ediff-window-B | 2394 | @item ediff-window-B |
| @@ -2407,7 +2407,7 @@ the control buffer is in its own frame. | |||
| 2407 | @chapter Credits | 2407 | @chapter Credits |
| 2408 | 2408 | ||
| 2409 | Ediff was written by Michael Kifer <kifer@@cs.stonybrook.edu>. It was inspired | 2409 | Ediff was written by Michael Kifer <kifer@@cs.stonybrook.edu>. It was inspired |
| 2410 | by emerge.el written by Dale R.@: Worley <drw@@math.mit.edu>. An idea due to | 2410 | by emerge.el written by Dale R. Worley <drw@@math.mit.edu>. An idea due to |
| 2411 | Boris Goldowsky <boris@@cs.rochester.edu> made it possible to highlight | 2411 | Boris Goldowsky <boris@@cs.rochester.edu> made it possible to highlight |
| 2412 | fine differences in Ediff buffers. Alastair Burt <burt@@dfki.uni-kl.de> | 2412 | fine differences in Ediff buffers. Alastair Burt <burt@@dfki.uni-kl.de> |
| 2413 | ported Ediff to XEmacs, Eric Freudenthal <freudent@@jan.ultra.nyu.edu> | 2413 | ported Ediff to XEmacs, Eric Freudenthal <freudent@@jan.ultra.nyu.edu> |
| @@ -2424,15 +2424,15 @@ Adrian Aichner (aichner at ecf.teradyne.com), | |||
| 2424 | Drew Adams (drew.adams at oracle.com), | 2424 | Drew Adams (drew.adams at oracle.com), |
| 2425 | Steve Baur (steve at xemacs.org), | 2425 | Steve Baur (steve at xemacs.org), |
| 2426 | Neal Becker (neal at ctd.comsat.com), | 2426 | Neal Becker (neal at ctd.comsat.com), |
| 2427 | E.@: Jay Berkenbilt (ejb at ql.org), | 2427 | E. Jay Berkenbilt (ejb at ql.org), |
| 2428 | Lennart Borgman (ennart.borgman at gmail.com) | 2428 | Lennart Borgman (ennart.borgman at gmail.com) |
| 2429 | Alastair Burt (burt at dfki.uni-kl.de), | 2429 | Alastair Burt (burt at dfki.uni-kl.de), |
| 2430 | Paul Bibilo (peb at delcam.co.uk), | 2430 | Paul Bibilo (peb at delcam.co.uk), |
| 2431 | Kevin Broadey (KevinB at bartley.demon.co.uk), | 2431 | Kevin Broadey (KevinB at bartley.demon.co.uk), |
| 2432 | Harald Boegeholz (hwb at machnix.mathematik.uni-stuttgart.de), | 2432 | Harald Boegeholz (hwb at machnix.mathematik.uni-stuttgart.de), |
| 2433 | Bradley A.@: Bosch (brad at lachman.com), | 2433 | Bradley A. Bosch (brad at lachman.com), |
| 2434 | Michael D.@: Carney (carney at ltx-tr.com), | 2434 | Michael D. Carney (carney at ltx-tr.com), |
| 2435 | Jin S.@: Choi (jin at atype.com), | 2435 | Jin S. Choi (jin at atype.com), |
| 2436 | Scott Cummings (cummings at adc.com), | 2436 | Scott Cummings (cummings at adc.com), |
| 2437 | Albert Dvornik (bert at mit.edu), | 2437 | Albert Dvornik (bert at mit.edu), |
| 2438 | Eric Eide (eeide at asylum.cs.utah.edu), | 2438 | Eric Eide (eeide at asylum.cs.utah.edu), |
| @@ -2491,7 +2491,7 @@ Paul Raines (raines at slac.stanford.edu), | |||
| 2491 | Stefan Reicher (xsteve at riic.at), | 2491 | Stefan Reicher (xsteve at riic.at), |
| 2492 | Charles Rich (rich at merl.com), | 2492 | Charles Rich (rich at merl.com), |
| 2493 | Bill Richter (richter at math.nwu.edu), | 2493 | Bill Richter (richter at math.nwu.edu), |
| 2494 | C.S.@: Roberson (roberson at aur.alcatel.com), | 2494 | C.S. Roberson (roberson at aur.alcatel.com), |
| 2495 | Kevin Rodgers (kevin.rodgers at ihs.com), | 2495 | Kevin Rodgers (kevin.rodgers at ihs.com), |
| 2496 | Sandy Rutherford (sandy at ibm550.sissa.it), | 2496 | Sandy Rutherford (sandy at ibm550.sissa.it), |
| 2497 | Heribert Schuetz (schuetz at ecrc.de), | 2497 | Heribert Schuetz (schuetz at ecrc.de), |
diff --git a/doc/misc/edt.texi b/doc/misc/edt.texi index af0069fb1bc..12e65100e4e 100644 --- a/doc/misc/edt.texi +++ b/doc/misc/edt.texi | |||
| @@ -65,7 +65,7 @@ of DEC's EDT editor. | |||
| 65 | This manual describes version 4.0 of the EDT Emulation for Emacs. | 65 | This manual describes version 4.0 of the EDT Emulation for Emacs. |
| 66 | It comes with special functions which replicate nearly all of | 66 | It comes with special functions which replicate nearly all of |
| 67 | EDT's keypad mode behavior. It sets up default keypad and function key | 67 | EDT's keypad mode behavior. It sets up default keypad and function key |
| 68 | bindings which closely match those found in EDT. Support is provided so | 68 | bindings which closely match those found in EDT@. Support is provided so |
| 69 | that users may reconfigure most keypad and function key bindings to | 69 | that users may reconfigure most keypad and function key bindings to |
| 70 | their own liking. | 70 | their own liking. |
| 71 | 71 | ||
| @@ -321,7 +321,7 @@ restores the original key bindings in effect just prior to invoking the | |||
| 321 | emulation. | 321 | emulation. |
| 322 | 322 | ||
| 323 | Emacs binds keys to @acronym{ASCII} control characters and so does the | 323 | Emacs binds keys to @acronym{ASCII} control characters and so does the |
| 324 | real EDT. Where EDT key bindings and Emacs key bindings conflict, | 324 | real EDT@. Where EDT key bindings and Emacs key bindings conflict, |
| 325 | the default Emacs key bindings are retained by the EDT emulation by | 325 | the default Emacs key bindings are retained by the EDT emulation by |
| 326 | default. If you are a diehard EDT user you may not like this. The | 326 | default. If you are a diehard EDT user you may not like this. The |
| 327 | @ref{Control keys} section explains how to change this so that the EDT | 327 | @ref{Control keys} section explains how to change this so that the EDT |
| @@ -527,7 +527,7 @@ add mod2 = Num_Lock | |||
| 527 | @end example | 527 | @end example |
| 528 | 528 | ||
| 529 | So, after executing @samp{xmodmap .xmodmaprc}, a press of the physical | 529 | So, after executing @samp{xmodmap .xmodmaprc}, a press of the physical |
| 530 | @key{F12} key looks like a Num_Lock keypress to X. Also, a press of the | 530 | @key{F12} key looks like a Num_Lock keypress to X@. Also, a press of the |
| 531 | physical @key{NumLock} key looks like a press of the @key{F12} key to X. | 531 | physical @key{NumLock} key looks like a press of the @key{F12} key to X. |
| 532 | 532 | ||
| 533 | Now, @file{edt-mapper.el} will see @samp{f12} when the physical | 533 | Now, @file{edt-mapper.el} will see @samp{f12} when the physical |
| @@ -674,7 +674,7 @@ two-thirds of the current window. (There is also an | |||
| 674 | 674 | ||
| 675 | @item | 675 | @item |
| 676 | Cursor movement and deletion involving word entities is identical to | 676 | Cursor movement and deletion involving word entities is identical to |
| 677 | EDT. This, above all else, gives the die-hard EDT user a sense of being | 677 | EDT@. This, above all else, gives the die-hard EDT user a sense of being |
| 678 | at home. Also, an emulation of EDT's @samp{SET ENTITY WORD} command is | 678 | at home. Also, an emulation of EDT's @samp{SET ENTITY WORD} command is |
| 679 | provided, for those users who like to customize movement by a word at a | 679 | provided, for those users who like to customize movement by a word at a |
| 680 | time to their own liking. | 680 | time to their own liking. |
diff --git a/doc/misc/eieio.texi b/doc/misc/eieio.texi index 6b3a87f19fc..fc92a76ff36 100644 --- a/doc/misc/eieio.texi +++ b/doc/misc/eieio.texi | |||
| @@ -1921,7 +1921,7 @@ In @eieio{} tags are in lower case, not mixed case. | |||
| 1921 | @node Wish List | 1921 | @node Wish List |
| 1922 | @chapter Wish List | 1922 | @chapter Wish List |
| 1923 | 1923 | ||
| 1924 | @eieio{} is an incomplete implementation of CLOS. Finding ways to | 1924 | @eieio{} is an incomplete implementation of CLOS@. Finding ways to |
| 1925 | improve the compatibility would help make CLOS style programs run | 1925 | improve the compatibility would help make CLOS style programs run |
| 1926 | better in Emacs. | 1926 | better in Emacs. |
| 1927 | 1927 | ||
diff --git a/doc/misc/emacs-mime.texi b/doc/misc/emacs-mime.texi index e57fcc8adf1..966cace7f6e 100644 --- a/doc/misc/emacs-mime.texi +++ b/doc/misc/emacs-mime.texi | |||
| @@ -382,7 +382,7 @@ When displaying inline images that are larger than the window, Emacs | |||
| 382 | does not enable scrolling, which means that you cannot see the whole | 382 | does not enable scrolling, which means that you cannot see the whole |
| 383 | image. To prevent this, the library tries to determine the image size | 383 | image. To prevent this, the library tries to determine the image size |
| 384 | before displaying it inline, and if it doesn't fit the window, the | 384 | before displaying it inline, and if it doesn't fit the window, the |
| 385 | library will display it externally (e.g. with @samp{ImageMagick} or | 385 | library will display it externally (e.g., with @samp{ImageMagick} or |
| 386 | @samp{xv}). Setting this variable to @code{t} disables this check and | 386 | @samp{xv}). Setting this variable to @code{t} disables this check and |
| 387 | makes the library display all inline images as inline, regardless of | 387 | makes the library display all inline images as inline, regardless of |
| 388 | their size. If you set this variable to @code{resize}, the image will | 388 | their size. If you set this variable to @code{resize}, the image will |
| @@ -427,7 +427,7 @@ or @kbd{I} instead.} | |||
| 427 | 427 | ||
| 428 | @item mm-w3m-safe-url-regexp | 428 | @item mm-w3m-safe-url-regexp |
| 429 | @vindex mm-w3m-safe-url-regexp | 429 | @vindex mm-w3m-safe-url-regexp |
| 430 | A regular expression that matches safe URL names, i.e. URLs that are | 430 | A regular expression that matches safe URL names, i.e., URLs that are |
| 431 | unlikely to leak personal information when rendering @acronym{HTML} | 431 | unlikely to leak personal information when rendering @acronym{HTML} |
| 432 | email (the default value is @samp{\\`cid:}). If @code{nil} consider | 432 | email (the default value is @samp{\\`cid:}). If @code{nil} consider |
| 433 | all URLs safe. In Gnus, this will be overridden according to the value | 433 | all URLs safe. In Gnus, this will be overridden according to the value |
| @@ -489,7 +489,7 @@ Delete all control characters. | |||
| 489 | @item mm-file-name-delete-gotchas | 489 | @item mm-file-name-delete-gotchas |
| 490 | @findex mm-file-name-delete-gotchas | 490 | @findex mm-file-name-delete-gotchas |
| 491 | Delete characters that could have unintended consequences when used | 491 | Delete characters that could have unintended consequences when used |
| 492 | with flawed shell scripts, i.e. @samp{|}, @samp{>} and @samp{<}; and | 492 | with flawed shell scripts, i.e., @samp{|}, @samp{>} and @samp{<}; and |
| 493 | @samp{-}, @samp{.} as the first character. | 493 | @samp{-}, @samp{.} as the first character. |
| 494 | 494 | ||
| 495 | @item mm-file-name-delete-whitespace | 495 | @item mm-file-name-delete-whitespace |
| @@ -922,7 +922,7 @@ each case the most efficient of quoted-printable and base64 should be | |||
| 922 | used. | 922 | used. |
| 923 | 923 | ||
| 924 | @code{qp-or-base64} has another effect. It will fold long lines so that | 924 | @code{qp-or-base64} has another effect. It will fold long lines so that |
| 925 | MIME parts may not be broken by MTA. So do @code{quoted-printable} and | 925 | MIME parts may not be broken by MTA@. So do @code{quoted-printable} and |
| 926 | @code{base64}. | 926 | @code{base64}. |
| 927 | 927 | ||
| 928 | Note that it affects body encoding only when a part is a raw forwarded | 928 | Note that it affects body encoding only when a part is a raw forwarded |
| @@ -1443,13 +1443,13 @@ This is a version from which the regexp for the Q encoding pattern of | |||
| 1443 | @item rfc2047-encode-encoded-words | 1443 | @item rfc2047-encode-encoded-words |
| 1444 | @vindex rfc2047-encode-encoded-words | 1444 | @vindex rfc2047-encode-encoded-words |
| 1445 | The boolean variable specifies whether encoded words | 1445 | The boolean variable specifies whether encoded words |
| 1446 | (e.g. @samp{=?us-ascii?q?hello?=}) should be encoded again. | 1446 | (e.g., @samp{=?us-ascii?q?hello?=}) should be encoded again. |
| 1447 | @code{rfc2047-encoded-word-regexp} is used to look for such words. | 1447 | @code{rfc2047-encoded-word-regexp} is used to look for such words. |
| 1448 | 1448 | ||
| 1449 | @item rfc2047-allow-irregular-q-encoded-words | 1449 | @item rfc2047-allow-irregular-q-encoded-words |
| 1450 | @vindex rfc2047-allow-irregular-q-encoded-words | 1450 | @vindex rfc2047-allow-irregular-q-encoded-words |
| 1451 | The boolean variable specifies whether irregular Q encoded words | 1451 | The boolean variable specifies whether irregular Q encoded words |
| 1452 | (e.g. @samp{=?us-ascii?q?hello??=}) should be decoded. If it is | 1452 | (e.g., @samp{=?us-ascii?q?hello??=}) should be decoded. If it is |
| 1453 | non-@code{nil}, @code{rfc2047-encoded-word-regexp-loose} is used instead | 1453 | non-@code{nil}, @code{rfc2047-encoded-word-regexp-loose} is used instead |
| 1454 | of @code{rfc2047-encoded-word-regexp} to look for encoded words. | 1454 | of @code{rfc2047-encoded-word-regexp} to look for encoded words. |
| 1455 | 1455 | ||
| @@ -1608,14 +1608,14 @@ Take a date and return a time. If the date is not syntactically valid, | |||
| 1608 | return a ``zero'' time. | 1608 | return a ``zero'' time. |
| 1609 | 1609 | ||
| 1610 | @item time-less-p | 1610 | @item time-less-p |
| 1611 | Take two times and say whether the first time is less (i. e., earlier) | 1611 | Take two times and say whether the first time is less (i.e., earlier) |
| 1612 | than the second time. | 1612 | than the second time. |
| 1613 | 1613 | ||
| 1614 | @item time-since | 1614 | @item time-since |
| 1615 | Take a time and return a time saying how long it was since that time. | 1615 | Take a time and return a time saying how long it was since that time. |
| 1616 | 1616 | ||
| 1617 | @item subtract-time | 1617 | @item subtract-time |
| 1618 | Take two times and subtract the second from the first. I. e., return | 1618 | Take two times and subtract the second from the first. I.e., return |
| 1619 | the time between the two times. | 1619 | the time between the two times. |
| 1620 | 1620 | ||
| 1621 | @item days-between | 1621 | @item days-between |
diff --git a/doc/misc/epa.texi b/doc/misc/epa.texi index bb5e18f1c8b..9dfdf5ff0c3 100644 --- a/doc/misc/epa.texi +++ b/doc/misc/epa.texi | |||
| @@ -63,11 +63,11 @@ called EasyPG Library. | |||
| 63 | @end ifnottex | 63 | @end ifnottex |
| 64 | 64 | ||
| 65 | @menu | 65 | @menu |
| 66 | * Overview:: | 66 | * Overview:: |
| 67 | * Quick start:: | 67 | * Quick start:: |
| 68 | * Commands:: | 68 | * Commands:: |
| 69 | * Caching Passphrases:: | 69 | * Caching Passphrases:: |
| 70 | * Bug Reports:: | 70 | * Bug Reports:: |
| 71 | @end menu | 71 | @end menu |
| 72 | 72 | ||
| 73 | @node Overview | 73 | @node Overview |
| @@ -107,12 +107,12 @@ encryption/decryption of @samp{*.gpg} files. | |||
| 107 | This chapter introduces various commands for typical use cases. | 107 | This chapter introduces various commands for typical use cases. |
| 108 | 108 | ||
| 109 | @menu | 109 | @menu |
| 110 | * Key management:: | 110 | * Key management:: |
| 111 | * Cryptographic operations on regions:: | 111 | * Cryptographic operations on regions:: |
| 112 | * Cryptographic operations on files:: | 112 | * Cryptographic operations on files:: |
| 113 | * Dired integration:: | 113 | * Dired integration:: |
| 114 | * Mail-mode integration:: | 114 | * Mail-mode integration:: |
| 115 | * Encrypting/decrypting *.gpg files:: | 115 | * Encrypting/decrypting *.gpg files:: |
| 116 | @end menu | 116 | @end menu |
| 117 | 117 | ||
| 118 | @node Key management | 118 | @node Key management |
| @@ -311,7 +311,7 @@ style of sending signed/encrypted emails by embedding raw OpenPGP | |||
| 311 | blobs inside a message body, not using modern MIME format. | 311 | blobs inside a message body, not using modern MIME format. |
| 312 | 312 | ||
| 313 | NOTE: Inline OpenPGP is not recommended and you should consider to use | 313 | NOTE: Inline OpenPGP is not recommended and you should consider to use |
| 314 | PGP/MIME. See | 314 | PGP/MIME@. See |
| 315 | @uref{http://josefsson.org/inline-openpgp-considered-harmful.html, | 315 | @uref{http://josefsson.org/inline-openpgp-considered-harmful.html, |
| 316 | Inline OpenPGP in E-mail is bad@comma{} Mm'kay?}. | 316 | Inline OpenPGP in E-mail is bad@comma{} Mm'kay?}. |
| 317 | 317 | ||
diff --git a/doc/misc/erc.texi b/doc/misc/erc.texi index 834d2ea844d..7b8b9176848 100644 --- a/doc/misc/erc.texi +++ b/doc/misc/erc.texi | |||
| @@ -60,7 +60,7 @@ and modified without restriction. | |||
| 60 | * Keystroke Summary:: Keystrokes used in ERC buffers. | 60 | * Keystroke Summary:: Keystrokes used in ERC buffers. |
| 61 | * Modules:: Available modules for ERC. | 61 | * Modules:: Available modules for ERC. |
| 62 | * Advanced Usage:: Cool ways of using ERC. | 62 | * Advanced Usage:: Cool ways of using ERC. |
| 63 | * Getting Help and Reporting Bugs:: | 63 | * Getting Help and Reporting Bugs:: |
| 64 | * History:: The history of ERC. | 64 | * History:: The history of ERC. |
| 65 | * Copying:: The GNU General Public License gives you | 65 | * Copying:: The GNU General Public License gives you |
| 66 | permission to redistribute ERC on | 66 | permission to redistribute ERC on |
| @@ -246,7 +246,7 @@ translation effort. | |||
| 246 | 246 | ||
| 247 | @item user scripting | 247 | @item user scripting |
| 248 | 248 | ||
| 249 | Users can load scripts (e.g. auto greeting scripts) when ERC starts up. | 249 | Users can load scripts (e.g., auto greeting scripts) when ERC starts up. |
| 250 | 250 | ||
| 251 | It is also possible to make custom IRC commands, if you know a little | 251 | It is also possible to make custom IRC commands, if you know a little |
| 252 | Emacs Lisp. Just make an Emacs Lisp function and call it | 252 | Emacs Lisp. Just make an Emacs Lisp function and call it |
| @@ -503,7 +503,7 @@ If you want to assign this function to a keystroke, the following will | |||
| 503 | help you figure out its parameters. | 503 | help you figure out its parameters. |
| 504 | 504 | ||
| 505 | @defun erc | 505 | @defun erc |
| 506 | Select connection parameters and run ERC. | 506 | Select connection parameters and run ERC@. |
| 507 | Non-interactively, it takes the following keyword arguments. | 507 | Non-interactively, it takes the following keyword arguments. |
| 508 | 508 | ||
| 509 | @itemize @bullet | 509 | @itemize @bullet |
| @@ -655,7 +655,7 @@ This can be either a string or a function to call. | |||
| 655 | @section Sample Configuration | 655 | @section Sample Configuration |
| 656 | @cindex configuration, sample | 656 | @cindex configuration, sample |
| 657 | 657 | ||
| 658 | Here is an example of configuration settings for ERC. This can go into | 658 | Here is an example of configuration settings for ERC@. This can go into |
| 659 | your Emacs configuration file. Everything after the @code{(require | 659 | your Emacs configuration file. Everything after the @code{(require |
| 660 | 'erc)} command can optionally go into @file{~/.emacs.d/.ercrc.el}. | 660 | 'erc)} command can optionally go into @file{~/.emacs.d/.ercrc.el}. |
| 661 | 661 | ||
| @@ -706,7 +706,7 @@ stuff, to the current ERC buffer." | |||
| 706 | (erc :server "localhost" :port "6667" | 706 | (erc :server "localhost" :port "6667" |
| 707 | :nick "MYNICK"))) | 707 | :nick "MYNICK"))) |
| 708 | 708 | ||
| 709 | ;; Make C-c RET (or C-c C-RET) send messages instead of RET. This has | 709 | ;; Make C-c RET (or C-c C-RET) send messages instead of RET. This has |
| 710 | ;; been commented out to avoid confusing new users. | 710 | ;; been commented out to avoid confusing new users. |
| 711 | ;; (define-key erc-mode-map (kbd "RET") nil) | 711 | ;; (define-key erc-mode-map (kbd "RET") nil) |
| 712 | ;; (define-key erc-mode-map (kbd "C-c RET") 'erc-send-current-line) | 712 | ;; (define-key erc-mode-map (kbd "C-c RET") 'erc-send-current-line) |
| @@ -742,7 +742,7 @@ check out all the available options for ERC is to do | |||
| 742 | @kbd{M-x customize-group erc RET}. | 742 | @kbd{M-x customize-group erc RET}. |
| 743 | 743 | ||
| 744 | @defopt erc-hide-list | 744 | @defopt erc-hide-list |
| 745 | If non, @code{nil}, this is a list of IRC message types to hide, e.g. | 745 | If non, @code{nil}, this is a list of IRC message types to hide, e.g.: |
| 746 | 746 | ||
| 747 | @example | 747 | @example |
| 748 | (setq erc-hide-list '("JOIN" "PART" "QUIT")) | 748 | (setq erc-hide-list '("JOIN" "PART" "QUIT")) |
| @@ -768,7 +768,7 @@ or if you have bugs to report, there are several places you can go. | |||
| 768 | 768 | ||
| 769 | @item | 769 | @item |
| 770 | @uref{http://www.emacswiki.org/cgi-bin/wiki/ERC} is the | 770 | @uref{http://www.emacswiki.org/cgi-bin/wiki/ERC} is the |
| 771 | emacswiki.org page for ERC. Anyone may add tips, hints, etc. to it. | 771 | emacswiki.org page for ERC@. Anyone may add tips, hints, etc. to it. |
| 772 | 772 | ||
| 773 | @item | 773 | @item |
| 774 | You can ask questions about using ERC on the Emacs mailing list, | 774 | You can ask questions about using ERC on the Emacs mailing list, |
diff --git a/doc/misc/ert.texi b/doc/misc/ert.texi index b585b68daa8..146a6ccbc35 100644 --- a/doc/misc/ert.texi +++ b/doc/misc/ert.texi | |||
| @@ -838,7 +838,7 @@ solve this by allowing regexp matching on test names; e.g., the | |||
| 838 | selector "^ert-" selects ERT's self-tests. | 838 | selector "^ert-" selects ERT's self-tests. |
| 839 | 839 | ||
| 840 | Other uses include grouping tests by their expected execution time, | 840 | Other uses include grouping tests by their expected execution time, |
| 841 | e.g. to run quick tests during interactive development and slow tests less | 841 | e.g., to run quick tests during interactive development and slow tests less |
| 842 | often. This can be achieved with the @code{:tag} argument to | 842 | often. This can be achieved with the @code{:tag} argument to |
| 843 | @code{ert-deftest} and @code{tag} test selectors. | 843 | @code{ert-deftest} and @code{tag} test selectors. |
| 844 | 844 | ||
diff --git a/doc/misc/eshell.texi b/doc/misc/eshell.texi index d322ca7c3e1..81bc1edc169 100644 --- a/doc/misc/eshell.texi +++ b/doc/misc/eshell.texi | |||
| @@ -783,7 +783,7 @@ A special associate array, which can take references of the form | |||
| 783 | 783 | ||
| 784 | @item Eshell scripts can't execute in the background | 784 | @item Eshell scripts can't execute in the background |
| 785 | 785 | ||
| 786 | @item Support zsh's ``Parameter Expansion'' syntax, i.e. @samp{$@{@var{name}:-@var{val}@}} | 786 | @item Support zsh's ``Parameter Expansion'' syntax, i.e., @samp{$@{@var{name}:-@var{val}@}} |
| 787 | 787 | ||
| 788 | @item Write an @command{info} alias that can take arguments | 788 | @item Write an @command{info} alias that can take arguments |
| 789 | 789 | ||
| @@ -869,7 +869,7 @@ It would call subcommands with @option{--help}, or @option{-h} or | |||
| 869 | 869 | ||
| 870 | @item Implement @command{stty} in Lisp | 870 | @item Implement @command{stty} in Lisp |
| 871 | 871 | ||
| 872 | @item Support @command{rc}'s matching operator, e.g. @samp{~ (@var{list}) @var{regexp}} | 872 | @item Support @command{rc}'s matching operator, e.g., @samp{~ (@var{list}) @var{regexp}} |
| 873 | 873 | ||
| 874 | @item Implement @command{bg} and @command{fg} as editors of @code{eshell-process-list} | 874 | @item Implement @command{bg} and @command{fg} as editors of @code{eshell-process-list} |
| 875 | 875 | ||
diff --git a/doc/misc/eudc.texi b/doc/misc/eudc.texi index dec178c5258..a21e73019b9 100644 --- a/doc/misc/eudc.texi +++ b/doc/misc/eudc.texi | |||
| @@ -233,7 +233,7 @@ LDAP support is added by means of @file{ldap.el}, which is part of Emacs. | |||
| 233 | @comment node-name, next, previous, up | 233 | @comment node-name, next, previous, up |
| 234 | @chapter Usage | 234 | @chapter Usage |
| 235 | 235 | ||
| 236 | This chapter describes the usage of EUDC. Most functions and | 236 | This chapter describes the usage of EUDC@. Most functions and |
| 237 | customization options are available through the @samp{Directory Search} | 237 | customization options are available through the @samp{Directory Search} |
| 238 | submenu of the @samp{Tools} submenu. | 238 | submenu of the @samp{Tools} submenu. |
| 239 | 239 | ||
diff --git a/doc/misc/faq.texi b/doc/misc/faq.texi index 2983667c5cd..ec0d6bfe4cc 100644 --- a/doc/misc/faq.texi +++ b/doc/misc/faq.texi | |||
| @@ -20,7 +20,7 @@ Copyright @copyright{} 1990, 1991, 1992 Joseph Brian Wells@* | |||
| 20 | @quotation | 20 | @quotation |
| 21 | This list of frequently asked questions about GNU Emacs with answers | 21 | This list of frequently asked questions about GNU Emacs with answers |
| 22 | (``FAQ'') may be translated into other languages, transformed into other | 22 | (``FAQ'') may be translated into other languages, transformed into other |
| 23 | formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information. | 23 | formats (e.g., Texinfo, Info, WWW, WAIS), and updated with new information. |
| 24 | 24 | ||
| 25 | The same conditions apply to any derivative of the FAQ as apply to the FAQ | 25 | The same conditions apply to any derivative of the FAQ as apply to the FAQ |
| 26 | itself. Every copy of the FAQ must include this notice or an approved | 26 | itself. Every copy of the FAQ must include this notice or an approved |
| @@ -191,7 +191,7 @@ DOS and Windows terminals don't set bit 7 when the @key{Meta} key is | |||
| 191 | pressed.}. | 191 | pressed.}. |
| 192 | 192 | ||
| 193 | @kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127. It is a misnomer to call | 193 | @kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127. It is a misnomer to call |
| 194 | @kbd{C-?} a ``control'' key, since 127 has both bits 5 and 6 turned ON. | 194 | @kbd{C-?} a ``control'' key, since 127 has both bits 5 and 6 turned ON@. |
| 195 | Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127. | 195 | Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127. |
| 196 | @c FIXME I cannot understand the previous sentence. | 196 | @c FIXME I cannot understand the previous sentence. |
| 197 | 197 | ||
| @@ -257,9 +257,9 @@ Emacs manual. | |||
| 257 | @cindex Directories and files that come with Emacs | 257 | @cindex Directories and files that come with Emacs |
| 258 | 258 | ||
| 259 | These are files that come with Emacs. The Emacs distribution is divided | 259 | These are files that come with Emacs. The Emacs distribution is divided |
| 260 | into subdirectories; e.g. @file{etc}, @file{lisp}, and @file{src}. | 260 | into subdirectories; e.g., @file{etc}, @file{lisp}, and @file{src}. |
| 261 | Some of these (e.g. @file{etc} and @file{lisp}) are present both in | 261 | Some of these (e.g., @file{etc} and @file{lisp}) are present both in |
| 262 | an installed Emacs and in the sources, but some (e.g. @file{src}) are | 262 | an installed Emacs and in the sources, but some (e.g., @file{src}) are |
| 263 | only found in the sources. | 263 | only found in the sources. |
| 264 | 264 | ||
| 265 | If you use Emacs, but don't know where it is kept on your system, start | 265 | If you use Emacs, but don't know where it is kept on your system, start |
| @@ -314,7 +314,7 @@ GNU General Public License | |||
| 314 | 314 | ||
| 315 | @end table | 315 | @end table |
| 316 | 316 | ||
| 317 | Avoid confusing the FSF and the LPF. The LPF opposes | 317 | Avoid confusing the FSF and the LPF@. The LPF opposes |
| 318 | look-and-feel copyrights and software patents. The FSF aims to make | 318 | look-and-feel copyrights and software patents. The FSF aims to make |
| 319 | high quality free software available for everyone. | 319 | high quality free software available for everyone. |
| 320 | 320 | ||
| @@ -552,7 +552,7 @@ help-for-help} instead to invoke help. To discover what key (if any) | |||
| 552 | invokes help on your system, type @kbd{M-x where-is @key{RET} | 552 | invokes help on your system, type @kbd{M-x where-is @key{RET} |
| 553 | help-for-help @key{RET}}. This will print a comma-separated list of key | 553 | help-for-help @key{RET}}. This will print a comma-separated list of key |
| 554 | sequences in the echo area. Ignore the last character in each key | 554 | sequences in the echo area. Ignore the last character in each key |
| 555 | sequence listed. Each of the resulting key sequences (e.g. @key{F1} is | 555 | sequence listed. Each of the resulting key sequences (e.g., @key{F1} is |
| 556 | common) invokes help. | 556 | common) invokes help. |
| 557 | 557 | ||
| 558 | Emacs help works best if it is invoked by a single key whose value | 558 | Emacs help works best if it is invoked by a single key whose value |
| @@ -611,7 +611,7 @@ matches a regular expression or a string, using @kbd{M-x | |||
| 611 | apropos-documentation}. | 611 | apropos-documentation}. |
| 612 | 612 | ||
| 613 | @item | 613 | @item |
| 614 | You can order a hardcopy of the manual from the FSF. @xref{Getting a | 614 | You can order a hardcopy of the manual from the FSF@. @xref{Getting a |
| 615 | printed manual}. | 615 | printed manual}. |
| 616 | 616 | ||
| 617 | @cindex Reference cards, in other languages | 617 | @cindex Reference cards, in other languages |
| @@ -640,7 +640,7 @@ information. To get a list of these commands, type @samp{?} after | |||
| 640 | @cindex Manual, obtaining a printed or HTML copy of | 640 | @cindex Manual, obtaining a printed or HTML copy of |
| 641 | @cindex Emacs manual, obtaining a printed or HTML copy of | 641 | @cindex Emacs manual, obtaining a printed or HTML copy of |
| 642 | 642 | ||
| 643 | You can order a printed copy of the Emacs manual from the FSF. For | 643 | You can order a printed copy of the Emacs manual from the FSF@. For |
| 644 | details see the @uref{http://shop.fsf.org/, FSF on-line store}. | 644 | details see the @uref{http://shop.fsf.org/, FSF on-line store}. |
| 645 | 645 | ||
| 646 | The full Texinfo source for the manual also comes in the @file{doc/emacs} | 646 | The full Texinfo source for the manual also comes in the @file{doc/emacs} |
| @@ -954,7 +954,7 @@ status of its latest version. | |||
| 954 | @cindex TECO | 954 | @cindex TECO |
| 955 | @cindex Original version of Emacs | 955 | @cindex Original version of Emacs |
| 956 | 956 | ||
| 957 | Emacs originally was an acronym for Editor MACroS. RMS says he ``picked | 957 | Emacs originally was an acronym for Editor MACroS@. RMS says he ``picked |
| 958 | the name Emacs because @key{E} was not in use as an abbreviation on ITS at | 958 | the name Emacs because @key{E} was not in use as an abbreviation on ITS at |
| 959 | the time.'' The first Emacs was a set of macros written in 1976 at MIT | 959 | the time.'' The first Emacs was a set of macros written in 1976 at MIT |
| 960 | by RMS for the editor TECO (Text Editor and COrrector, originally Tape | 960 | by RMS for the editor TECO (Text Editor and COrrector, originally Tape |
| @@ -985,9 +985,9 @@ conventions}). | |||
| 985 | @cindex Bazaar repository, Emacs | 985 | @cindex Bazaar repository, Emacs |
| 986 | 986 | ||
| 987 | Emacs @value{EMACSVER} is the current version as of this writing. A version | 987 | Emacs @value{EMACSVER} is the current version as of this writing. A version |
| 988 | number with two components (e.g. @samp{22.1}) indicates a released | 988 | number with two components (e.g., @samp{22.1}) indicates a released |
| 989 | version; three components indicate a development | 989 | version; three components indicate a development |
| 990 | version (e.g. @samp{23.0.50} is what will eventually become @samp{23.1}). | 990 | version (e.g., @samp{23.0.50} is what will eventually become @samp{23.1}). |
| 991 | 991 | ||
| 992 | Emacs is under active development, hosted at | 992 | Emacs is under active development, hosted at |
| 993 | @uref{http://savannah.gnu.org/projects/emacs/, Savannah}. The source | 993 | @uref{http://savannah.gnu.org/projects/emacs/, Savannah}. The source |
| @@ -1371,7 +1371,7 @@ groups. From there, you can access all customizable options and faces, | |||
| 1371 | change their values, and save your changes to your init file. | 1371 | change their values, and save your changes to your init file. |
| 1372 | @xref{Easy Customization,,, emacs, The GNU Emacs Manual}. | 1372 | @xref{Easy Customization,,, emacs, The GNU Emacs Manual}. |
| 1373 | 1373 | ||
| 1374 | If you know the name of the group in advance (e.g. ``shell''), use | 1374 | If you know the name of the group in advance (e.g., ``shell''), use |
| 1375 | @kbd{M-x customize-group @key{RET}}. | 1375 | @kbd{M-x customize-group @key{RET}}. |
| 1376 | 1376 | ||
| 1377 | If you wish to customize a single option, use @kbd{M-x customize-option | 1377 | If you wish to customize a single option, use @kbd{M-x customize-option |
| @@ -1385,7 +1385,7 @@ customize, with completion. | |||
| 1385 | @cindex Console, colors | 1385 | @cindex Console, colors |
| 1386 | 1386 | ||
| 1387 | In Emacs 21.1 and later, colors and faces are supported in non-windowed mode, | 1387 | In Emacs 21.1 and later, colors and faces are supported in non-windowed mode, |
| 1388 | i.e.@: on Unix and GNU/Linux text-only terminals and consoles, and when | 1388 | i.e., on Unix and GNU/Linux text-only terminals and consoles, and when |
| 1389 | invoked as @samp{emacs -nw} on X, and MS-Windows. (Colors and faces were | 1389 | invoked as @samp{emacs -nw} on X, and MS-Windows. (Colors and faces were |
| 1390 | supported in the MS-DOS port since Emacs 19.29.) Emacs automatically | 1390 | supported in the MS-DOS port since Emacs 19.29.) Emacs automatically |
| 1391 | detects color support at startup and uses it if available. If you think | 1391 | detects color support at startup and uses it if available. If you think |
| @@ -1540,7 +1540,7 @@ with @samp{#!}): | |||
| 1540 | 1540 | ||
| 1541 | @cindex Major mode for shell scripts | 1541 | @cindex Major mode for shell scripts |
| 1542 | The variable @code{interpreter-mode-alist} specifies which mode to use | 1542 | The variable @code{interpreter-mode-alist} specifies which mode to use |
| 1543 | when loading an interpreted script (e.g. shell, python, etc.). Emacs | 1543 | when loading an interpreted script (e.g., shell, python, etc.). Emacs |
| 1544 | determines which interpreter you're using by examining the first line of | 1544 | determines which interpreter you're using by examining the first line of |
| 1545 | the script. Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on | 1545 | the script. Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on |
| 1546 | @code{interpreter-mode-alist} to learn more. | 1546 | @code{interpreter-mode-alist} to learn more. |
| @@ -3172,7 +3172,7 @@ the main GNU distribution site, sources are available as | |||
| 3172 | @c Don't include VER in the file name, because pretests are not there. | 3172 | @c Don't include VER in the file name, because pretests are not there. |
| 3173 | @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz} | 3173 | @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz} |
| 3174 | 3174 | ||
| 3175 | (Replace @samp{VERSION} with the relevant version number, e.g. @samp{23.1}.) | 3175 | (Replace @samp{VERSION} with the relevant version number, e.g., @samp{23.1}.) |
| 3176 | 3176 | ||
| 3177 | @item | 3177 | @item |
| 3178 | Next uncompress and extract the source files. This requires | 3178 | Next uncompress and extract the source files. This requires |
| @@ -3561,7 +3561,7 @@ can be bound to a key and thus treated as a macro. For example: | |||
| 3561 | @cindex Misspecified key sequences | 3561 | @cindex Misspecified key sequences |
| 3562 | 3562 | ||
| 3563 | Usually, one of two things has happened. In one case, the control | 3563 | Usually, one of two things has happened. In one case, the control |
| 3564 | character in the key sequence has been misspecified (e.g. @samp{C-f} | 3564 | character in the key sequence has been misspecified (e.g., @samp{C-f} |
| 3565 | used instead of @samp{\C-f} within a Lisp expression). In the other | 3565 | used instead of @samp{\C-f} within a Lisp expression). In the other |
| 3566 | case, a @dfn{prefix key} in the keystroke sequence you were trying to bind | 3566 | case, a @dfn{prefix key} in the keystroke sequence you were trying to bind |
| 3567 | was already bound as a @dfn{complete key}. Historically, the @samp{ESC [} | 3567 | was already bound as a @dfn{complete key}. Historically, the @samp{ESC [} |
| @@ -3882,7 +3882,7 @@ is how to make @kbd{H-M-RIGHT} move forward a word: | |||
| 3882 | @item | 3882 | @item |
| 3883 | Not all modifiers are permitted in all situations. @key{Hyper}, | 3883 | Not all modifiers are permitted in all situations. @key{Hyper}, |
| 3884 | @key{Super}, and @key{Alt} are not available on Unix character | 3884 | @key{Super}, and @key{Alt} are not available on Unix character |
| 3885 | terminals. Non-@acronym{ASCII} keys and mouse events (e.g. @kbd{C-=} and | 3885 | terminals. Non-@acronym{ASCII} keys and mouse events (e.g., @kbd{C-=} and |
| 3886 | @kbd{Mouse-1}) also fall under this category. | 3886 | @kbd{Mouse-1}) also fall under this category. |
| 3887 | 3887 | ||
| 3888 | @end itemize | 3888 | @end itemize |
| @@ -4275,7 +4275,7 @@ type them in. To enable this feature, execute the following: | |||
| 4275 | @end lisp | 4275 | @end lisp |
| 4276 | 4276 | ||
| 4277 | Note that the aliases are expanded automatically only after you type | 4277 | Note that the aliases are expanded automatically only after you type |
| 4278 | a word-separator character (e.g. @key{RET} or @kbd{,}). You can force their | 4278 | a word-separator character (e.g., @key{RET} or @kbd{,}). You can force their |
| 4279 | expansion by moving point to the end of the alias and typing @kbd{C-x a e} | 4279 | expansion by moving point to the end of the alias and typing @kbd{C-x a e} |
| 4280 | (@kbd{M-x expand-abbrev}). | 4280 | (@kbd{M-x expand-abbrev}). |
| 4281 | @end itemize | 4281 | @end itemize |
diff --git a/doc/misc/flymake.texi b/doc/misc/flymake.texi index 4a873490e86..98279c8dae3 100644 --- a/doc/misc/flymake.texi +++ b/doc/misc/flymake.texi | |||
| @@ -47,7 +47,7 @@ developing GNU and promoting software freedom.'' | |||
| 47 | @ifnottex | 47 | @ifnottex |
| 48 | @node Top | 48 | @node Top |
| 49 | @top GNU Flymake | 49 | @top GNU Flymake |
| 50 | @insertcopying | 50 | @insertcopying |
| 51 | @end ifnottex | 51 | @end ifnottex |
| 52 | 52 | ||
| 53 | @menu | 53 | @menu |
| @@ -69,7 +69,7 @@ Emacs minor mode. Flymake runs the pre-configured syntax check tool | |||
| 69 | (compiler for C++ files, @code{perl} for perl files, etc.) in the | 69 | (compiler for C++ files, @code{perl} for perl files, etc.) in the |
| 70 | background, passing it a temporary copy of the current buffer, and | 70 | background, passing it a temporary copy of the current buffer, and |
| 71 | parses the output for known error/warning message patterns. Flymake | 71 | parses the output for known error/warning message patterns. Flymake |
| 72 | then highlights erroneous lines (i.e. lines for which at least one | 72 | then highlights erroneous lines (i.e., lines for which at least one |
| 73 | error or warning has been reported by the syntax check tool), and | 73 | error or warning has been reported by the syntax check tool), and |
| 74 | displays an overall buffer status in the mode line. Status information | 74 | displays an overall buffer status in the mode line. Status information |
| 75 | displayed by Flymake contains total number of errors and warnings | 75 | displayed by Flymake contains total number of errors and warnings |
diff --git a/doc/misc/forms.texi b/doc/misc/forms.texi index 11c3782dd7e..7f84de9754b 100644 --- a/doc/misc/forms.texi +++ b/doc/misc/forms.texi | |||
| @@ -74,7 +74,7 @@ job: a control file and a data file. The data file holds the | |||
| 74 | actual data to be presented. The control file describes | 74 | actual data to be presented. The control file describes |
| 75 | how to present it. | 75 | how to present it. |
| 76 | 76 | ||
| 77 | @insertcopying | 77 | @insertcopying |
| 78 | 78 | ||
| 79 | @menu | 79 | @menu |
| 80 | * Forms Example:: An example: editing the password data base. | 80 | * Forms Example:: An example: editing the password data base. |
| @@ -117,7 +117,7 @@ are all there, but instead of being colon-separated on one single line, | |||
| 117 | they make up a forms. | 117 | they make up a forms. |
| 118 | 118 | ||
| 119 | The contents of the forms consist of the contents of the fields of the | 119 | The contents of the forms consist of the contents of the fields of the |
| 120 | record (e.g. @samp{root}, @samp{0}, @samp{1}, @samp{Super User}) | 120 | record (e.g., @samp{root}, @samp{0}, @samp{1}, @samp{Super User}) |
| 121 | interspersed with normal text (e.g @samp{User : }, @samp{Uid: }). | 121 | interspersed with normal text (e.g @samp{User : }, @samp{Uid: }). |
| 122 | 122 | ||
| 123 | If you modify the contents of the fields, Forms mode will analyze your | 123 | If you modify the contents of the fields, Forms mode will analyze your |
| @@ -467,7 +467,7 @@ appears that way when displayed in Forms mode. If the value is | |||
| 467 | @code{nil}, multi-line text fields are prohibited. The pseudo newline | 467 | @code{nil}, multi-line text fields are prohibited. The pseudo newline |
| 468 | must not be a character contained in @code{forms-field-sep}. | 468 | must not be a character contained in @code{forms-field-sep}. |
| 469 | 469 | ||
| 470 | The default value is @code{"\^k"}, the character Control-K. Example: | 470 | The default value is @code{"\^k"}, the character Control-K@. Example: |
| 471 | 471 | ||
| 472 | @example | 472 | @example |
| 473 | (setq forms-multi-line "\^k") | 473 | (setq forms-multi-line "\^k") |
| @@ -739,7 +739,7 @@ so you'd better think twice before using this. | |||
| 739 | 739 | ||
| 740 | The default format for the data file, using @code{"\t"} to separate | 740 | The default format for the data file, using @code{"\t"} to separate |
| 741 | fields and @code{"\^k"} to separate lines within a field, matches the | 741 | fields and @code{"\^k"} to separate lines within a field, matches the |
| 742 | file format of some popular database programs, e.g. FileMaker. So | 742 | file format of some popular database programs, e.g., FileMaker. So |
| 743 | @code{forms-mode} can decrease the need to use proprietary software. | 743 | @code{forms-mode} can decrease the need to use proprietary software. |
| 744 | 744 | ||
| 745 | @node Error Messages | 745 | @node Error Messages |
diff --git a/doc/misc/gnus-coding.texi b/doc/misc/gnus-coding.texi index bbaf2c068da..2bc064071ec 100644 --- a/doc/misc/gnus-coding.texi +++ b/doc/misc/gnus-coding.texi | |||
| @@ -48,7 +48,7 @@ license to the document, as described in section 6 of the license. | |||
| 48 | @top Gnus Coding Style and Maintenance Guide | 48 | @top Gnus Coding Style and Maintenance Guide |
| 49 | This manual describes @dots{} | 49 | This manual describes @dots{} |
| 50 | 50 | ||
| 51 | @insertcopying | 51 | @insertcopying |
| 52 | @end ifnottex | 52 | @end ifnottex |
| 53 | 53 | ||
| 54 | @menu | 54 | @menu |
| @@ -64,7 +64,7 @@ This manual describes @dots{} | |||
| 64 | 64 | ||
| 65 | The Gnus distribution contains a lot of libraries that have been written | 65 | The Gnus distribution contains a lot of libraries that have been written |
| 66 | for Gnus and used intensively for Gnus. But many of those libraries are | 66 | for Gnus and used intensively for Gnus. But many of those libraries are |
| 67 | useful on their own. E.g. other Emacs Lisp packages might use the | 67 | useful on their own. E.g., other Emacs Lisp packages might use the |
| 68 | @acronym{MIME} library @xref{Top, ,Top, emacs-mime, The Emacs MIME | 68 | @acronym{MIME} library @xref{Top, ,Top, emacs-mime, The Emacs MIME |
| 69 | Manual}. | 69 | Manual}. |
| 70 | 70 | ||
| @@ -196,7 +196,7 @@ There are no Gnus dependencies in this file. | |||
| 196 | Functions for Cancel-Lock feature | 196 | Functions for Cancel-Lock feature |
| 197 | @c Cf. draft-ietf-usefor-cancel-lock-01.txt | 197 | @c Cf. draft-ietf-usefor-cancel-lock-01.txt |
| 198 | @c Although this draft has expired, Canlock-Lock revived in 2007 when | 198 | @c Although this draft has expired, Canlock-Lock revived in 2007 when |
| 199 | @c major news providers (e.g. news.individual.org) started to use it. | 199 | @c major news providers (e.g., news.individual.org) started to use it. |
| 200 | @c As of 2007-08-25... | 200 | @c As of 2007-08-25... |
| 201 | There are no Gnus dependencies in these files. | 201 | There are no Gnus dependencies in these files. |
| 202 | 202 | ||
| @@ -257,18 +257,18 @@ XEmacs 21.1 and up. | |||
| 257 | 257 | ||
| 258 | The development of Gnus normally is done on the Git repository trunk | 258 | The development of Gnus normally is done on the Git repository trunk |
| 259 | as of April 19, 2010 (formerly it was done in CVS; the repository is | 259 | as of April 19, 2010 (formerly it was done in CVS; the repository is |
| 260 | at http://git.gnus.org), i.e. there are no separate branches to | 260 | at http://git.gnus.org), i.e., there are no separate branches to |
| 261 | develop and test new features. Most of the time, the trunk is | 261 | develop and test new features. Most of the time, the trunk is |
| 262 | developed quite actively with more or less daily changes. Only after | 262 | developed quite actively with more or less daily changes. Only after |
| 263 | a new major release, e.g. 5.10.1, there's usually a feature period of | 263 | a new major release, e.g., 5.10.1, there's usually a feature period of |
| 264 | several months. After the release of Gnus 5.10.6 the development of | 264 | several months. After the release of Gnus 5.10.6 the development of |
| 265 | new features started again on the trunk while the 5.10 series is | 265 | new features started again on the trunk while the 5.10 series is |
| 266 | continued on the stable branch (v5-10) from which more stable releases | 266 | continued on the stable branch (v5-10) from which more stable releases |
| 267 | will be done when needed (5.10.8, @dots{}). @ref{Gnus Development, | 267 | will be done when needed (5.10.8, @dots{}). @ref{Gnus Development, |
| 268 | ,Gnus Development, gnus, The Gnus Newsreader} | 268 | ,Gnus Development, gnus, The Gnus Newsreader} |
| 269 | 269 | ||
| 270 | Stable releases of Gnus finally become part of Emacs. E.g. Gnus 5.8 | 270 | Stable releases of Gnus finally become part of Emacs. E.g., Gnus 5.8 |
| 271 | became a part of Emacs 21 (relabeled to Gnus 5.9). The 5.10 series | 271 | became a part of Emacs 21 (relabeled to Gnus 5.9). The 5.10 series |
| 272 | became part of Emacs 22 as Gnus 5.11. | 272 | became part of Emacs 22 as Gnus 5.11. |
| 273 | 273 | ||
| 274 | @section Syncing | 274 | @section Syncing |
| @@ -379,7 +379,7 @@ Starting from No Gnus, the @file{GNUS-NEWS} is created from | |||
| 379 | 379 | ||
| 380 | For new customizable variables introduced in Oort Gnus (including the | 380 | For new customizable variables introduced in Oort Gnus (including the |
| 381 | v5-10 branch) use @code{:version "22.1" ;; Oort Gnus} (including the | 381 | v5-10 branch) use @code{:version "22.1" ;; Oort Gnus} (including the |
| 382 | comment) or e.g. @code{:version "22.2" ;; Gnus 5.10.10} if the feature | 382 | comment) or, e.g., @code{:version "22.2" ;; Gnus 5.10.10} if the feature |
| 383 | was added for Emacs 22.2 and Gnus 5.10.10. | 383 | was added for Emacs 22.2 and Gnus 5.10.10. |
| 384 | @c | 384 | @c |
| 385 | If the variable is new in No Gnus use @code{:version "23.1" ;; No Gnus}. | 385 | If the variable is new in No Gnus use @code{:version "23.1" ;; No Gnus}. |
diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi index 6c2946549e8..038b78cced3 100644 --- a/doc/misc/gnus-faq.texi +++ b/doc/misc/gnus-faq.texi | |||
| @@ -65,7 +65,7 @@ Gnus is a Usenet Newsreader and Electronic Mail User Agent implemented | |||
| 65 | as a part of Emacs. It's been around in some form for almost a decade | 65 | as a part of Emacs. It's been around in some form for almost a decade |
| 66 | now, and has been distributed as a standard part of Emacs for much of | 66 | now, and has been distributed as a standard part of Emacs for much of |
| 67 | that time. Gnus 5 is the latest (and greatest) incarnation. The | 67 | that time. Gnus 5 is the latest (and greatest) incarnation. The |
| 68 | original version was called GNUS, and was written by Masanobu UMEDA. | 68 | original version was called GNUS, and was written by Masanobu UMEDA@. |
| 69 | When autumn crept up in '94, Lars Magne Ingebrigtsen grew bored and | 69 | When autumn crept up in '94, Lars Magne Ingebrigtsen grew bored and |
| 70 | decided to rewrite Gnus. | 70 | decided to rewrite Gnus. |
| 71 | 71 | ||
| @@ -149,7 +149,7 @@ Anti Spam features. | |||
| 149 | Message-utils now included in Gnus. | 149 | Message-utils now included in Gnus. |
| 150 | 150 | ||
| 151 | @item | 151 | @item |
| 152 | New format specifiers for summary lines, e.g. %B for | 152 | New format specifiers for summary lines, e.g., %B for |
| 153 | a complex trn-style thread tree. | 153 | a complex trn-style thread tree. |
| 154 | @end itemize | 154 | @end itemize |
| 155 | 155 | ||
| @@ -162,7 +162,7 @@ Where and how to get Gnus? | |||
| 162 | 162 | ||
| 163 | Gnus is released independent from releases of Emacs and XEmacs. | 163 | Gnus is released independent from releases of Emacs and XEmacs. |
| 164 | Therefore, the version bundled with Emacs or the version in XEmacs's | 164 | Therefore, the version bundled with Emacs or the version in XEmacs's |
| 165 | package system might not be up to date (e.g. Gnus 5.9 bundled with Emacs | 165 | package system might not be up to date (e.g., Gnus 5.9 bundled with Emacs |
| 166 | 21 is outdated). | 166 | 21 is outdated). |
| 167 | You can get the latest released version of Gnus from | 167 | You can get the latest released version of Gnus from |
| 168 | @uref{http://www.gnus.org/dist/gnus.tar.gz} | 168 | @uref{http://www.gnus.org/dist/gnus.tar.gz} |
| @@ -181,7 +181,7 @@ Untar it via @samp{tar xvzf gnus.tar.gz} and do the common | |||
| 181 | (under MS-Windows either get the Cygwin environment from | 181 | (under MS-Windows either get the Cygwin environment from |
| 182 | @uref{http://www.cygwin.com} | 182 | @uref{http://www.cygwin.com} |
| 183 | which allows you to do what's described above or unpack the | 183 | which allows you to do what's described above or unpack the |
| 184 | tarball with some packer (e.g. Winace from | 184 | tarball with some packer (e.g., Winace from |
| 185 | @uref{http://www.winace.com}) | 185 | @uref{http://www.winace.com}) |
| 186 | and use the batch-file make.bat included in the tarball to install | 186 | and use the batch-file make.bat included in the tarball to install |
| 187 | Gnus.) If you don't want to (or aren't allowed to) install Gnus | 187 | Gnus.) If you don't want to (or aren't allowed to) install Gnus |
| @@ -267,7 +267,7 @@ and how to prevent it? | |||
| 267 | 267 | ||
| 268 | This message means that the last time you used Gnus, it | 268 | This message means that the last time you used Gnus, it |
| 269 | wasn't properly exited and therefore couldn't write its | 269 | wasn't properly exited and therefore couldn't write its |
| 270 | information to disk (e.g. which messages you read), you | 270 | information to disk (e.g., which messages you read), you |
| 271 | are now asked if you want to restore that information | 271 | are now asked if you want to restore that information |
| 272 | from the auto-save file. | 272 | from the auto-save file. |
| 273 | 273 | ||
| @@ -314,7 +314,7 @@ through them? | |||
| 314 | @subsubheading Answer | 314 | @subsubheading Answer |
| 315 | 315 | ||
| 316 | Gnus offers the topic mode, it allows you to sort your | 316 | Gnus offers the topic mode, it allows you to sort your |
| 317 | groups in, well, topics, e.g. all groups dealing with | 317 | groups in, well, topics, e.g., all groups dealing with |
| 318 | Linux under the topic linux, all dealing with music under | 318 | Linux under the topic linux, all dealing with music under |
| 319 | the topic music and all dealing with scottish music under | 319 | the topic music and all dealing with scottish music under |
| 320 | the topic scottish which is a subtopic of music. | 320 | the topic scottish which is a subtopic of music. |
| @@ -406,7 +406,7 @@ directory Emacs chooses will most certainly not be what | |||
| 406 | you want, so let's do it the correct way. | 406 | you want, so let's do it the correct way. |
| 407 | The first thing you've got to do is to | 407 | The first thing you've got to do is to |
| 408 | create a suitable directory (no blanks in directory name | 408 | create a suitable directory (no blanks in directory name |
| 409 | please) e.g. c:\myhome. Then you must set the environment | 409 | please), e.g., c:\myhome. Then you must set the environment |
| 410 | variable HOME to this directory. To do this under Windows 9x | 410 | variable HOME to this directory. To do this under Windows 9x |
| 411 | or Me include the line | 411 | or Me include the line |
| 412 | 412 | ||
| @@ -556,7 +556,7 @@ these: 1: You want to read your mail from a pop3 server and | |||
| 556 | send them directly to a SMTP Server 2: Some program like | 556 | send them directly to a SMTP Server 2: Some program like |
| 557 | fetchmail retrieves your mail and stores it on disk from | 557 | fetchmail retrieves your mail and stores it on disk from |
| 558 | where Gnus shall read it. Outgoing mail is sent by | 558 | where Gnus shall read it. Outgoing mail is sent by |
| 559 | Sendmail, Postfix or some other MTA. Sometimes, you even | 559 | Sendmail, Postfix or some other MTA@. Sometimes, you even |
| 560 | need a combination of the above cases. | 560 | need a combination of the above cases. |
| 561 | 561 | ||
| 562 | However, the first thing to do is to tell Gnus in which way | 562 | However, the first thing to do is to tell Gnus in which way |
| @@ -716,7 +716,7 @@ However this is Gnus county so there are possibilities to | |||
| 716 | achieve what you want. The easiest way is to get an external | 716 | achieve what you want. The easiest way is to get an external |
| 717 | program which retrieves copies of the mail and stores them | 717 | program which retrieves copies of the mail and stores them |
| 718 | on disk, so Gnus can read it from there. On Unix systems you | 718 | on disk, so Gnus can read it from there. On Unix systems you |
| 719 | could use e.g. fetchmail for this, on MS Windows you can use | 719 | could use, e.g., fetchmail for this, on MS Windows you can use |
| 720 | Hamster, an excellent local news and mail server. | 720 | Hamster, an excellent local news and mail server. |
| 721 | 721 | ||
| 722 | The other solution would be, to replace the method Gnus | 722 | The other solution would be, to replace the method Gnus |
| @@ -728,7 +728,7 @@ Gnus to use it and not to delete the retrieved mail. For | |||
| 728 | GNU Emacs look for the file epop3.el which can do the same | 728 | GNU Emacs look for the file epop3.el which can do the same |
| 729 | (If you know the home of this file, please send me an | 729 | (If you know the home of this file, please send me an |
| 730 | e-mail). You can also tell Gnus to use an external program | 730 | e-mail). You can also tell Gnus to use an external program |
| 731 | (e.g. fetchmail) to fetch your mail, see the info node | 731 | (e.g., fetchmail) to fetch your mail, see the info node |
| 732 | "Mail Source Specifiers" in the Gnus manual on how to do | 732 | "Mail Source Specifiers" in the Gnus manual on how to do |
| 733 | it. | 733 | it. |
| 734 | 734 | ||
| @@ -753,7 +753,7 @@ it. | |||
| 753 | * FAQ 4-9:: Is there a way to automatically ignore posts by specific | 753 | * FAQ 4-9:: Is there a way to automatically ignore posts by specific |
| 754 | authors or with specific words in the subject? And can I | 754 | authors or with specific words in the subject? And can I |
| 755 | highlight more interesting ones in some way? | 755 | highlight more interesting ones in some way? |
| 756 | * FAQ 4-10:: How can I disable threading in some (e.g. mail-) groups, | 756 | * FAQ 4-10:: How can I disable threading in some (e.g., mail-) groups, |
| 757 | or set other variables specific for some groups? | 757 | or set other variables specific for some groups? |
| 758 | * FAQ 4-11:: Can I highlight messages written by me and follow-ups to | 758 | * FAQ 4-11:: Can I highlight messages written by me and follow-ups to |
| 759 | those? | 759 | those? |
| @@ -778,7 +778,7 @@ If you enter the group by saying | |||
| 778 | @samp{RET} | 778 | @samp{RET} |
| 779 | in group buffer with point over the group, only unread and ticked messages are loaded. Say | 779 | in group buffer with point over the group, only unread and ticked messages are loaded. Say |
| 780 | @samp{C-u RET} | 780 | @samp{C-u RET} |
| 781 | instead to load all available messages. If you want only the e.g. 300 newest say | 781 | instead to load all available messages. If you want only the 300 newest say |
| 782 | @samp{C-u 300 RET} | 782 | @samp{C-u 300 RET} |
| 783 | 783 | ||
| 784 | Loading only unread messages can be annoying if you have threaded view enabled, say | 784 | Loading only unread messages can be annoying if you have threaded view enabled, say |
| @@ -954,7 +954,7 @@ Hit either @samp{e} for an exact match or | |||
| 954 | @samp{s} for substring-match and delete afterwards | 954 | @samp{s} for substring-match and delete afterwards |
| 955 | everything but the name to score down all authors with the given | 955 | everything but the name to score down all authors with the given |
| 956 | name no matter which email address is used. Now you need to tell | 956 | name no matter which email address is used. Now you need to tell |
| 957 | Gnus when to apply the rule and how long it should last, hit e.g. | 957 | Gnus when to apply the rule and how long it should last, hit |
| 958 | @samp{p} to apply the rule now and let it last | 958 | @samp{p} to apply the rule now and let it last |
| 959 | forever. If you want to raise the score instead of lowering it say | 959 | forever. If you want to raise the score instead of lowering it say |
| 960 | @samp{I} instead of @samp{L}. | 960 | @samp{I} instead of @samp{L}. |
| @@ -967,7 +967,7 @@ Gnus manual for the exact syntax, basically it's one big list | |||
| 967 | whose elements are lists again. the first element of those lists | 967 | whose elements are lists again. the first element of those lists |
| 968 | is the header to score on, then one more list with what to match, | 968 | is the header to score on, then one more list with what to match, |
| 969 | which score to assign, when to expire the rule and how to do the | 969 | which score to assign, when to expire the rule and how to do the |
| 970 | matching. If you find me very interesting, you could e.g. add the | 970 | matching. If you find me very interesting, you could add the |
| 971 | following to your all.Score: | 971 | following to your all.Score: |
| 972 | 972 | ||
| 973 | @example | 973 | @example |
| @@ -998,7 +998,7 @@ in ~/.gnus.el. | |||
| 998 | @node FAQ 4-10 | 998 | @node FAQ 4-10 |
| 999 | @subsubheading Question 4.10 | 999 | @subsubheading Question 4.10 |
| 1000 | 1000 | ||
| 1001 | How can I disable threading in some (e.g. mail-) groups, or | 1001 | How can I disable threading in some (e.g., mail-) groups, or |
| 1002 | set other variables specific for some groups? | 1002 | set other variables specific for some groups? |
| 1003 | 1003 | ||
| 1004 | @subsubheading Answer | 1004 | @subsubheading Answer |
| @@ -1114,7 +1114,7 @@ tabulators which allow you a summary in table form, but | |||
| 1114 | sadly hard tabulators are broken in 5.8.8. | 1114 | sadly hard tabulators are broken in 5.8.8. |
| 1115 | 1115 | ||
| 1116 | Since 5.10, Gnus offers you some very nice new specifiers, | 1116 | Since 5.10, Gnus offers you some very nice new specifiers, |
| 1117 | e.g. %B which draws a thread-tree and %&user-date which | 1117 | e.g., %B which draws a thread-tree and %&user-date which |
| 1118 | gives you a date where the details are dependent of the | 1118 | gives you a date where the details are dependent of the |
| 1119 | articles age. Here's an example which uses both: | 1119 | articles age. Here's an example which uses both: |
| 1120 | 1120 | ||
| @@ -1771,7 +1771,7 @@ snippet by Frank Haun <pille3003@@fhaun.de> in | |||
| 1771 | 1771 | ||
| 1772 | @example | 1772 | @example |
| 1773 | (defun my-archive-article (&optional n) | 1773 | (defun my-archive-article (&optional n) |
| 1774 | "Copies one or more article(s) to a corresponding `nnml:' group, e.g. | 1774 | "Copies one or more article(s) to a corresponding `nnml:' group, e.g., |
| 1775 | `gnus.ding' goes to `nnml:1.gnus.ding'. And `nnml:List-gnus.ding' goes | 1775 | `gnus.ding' goes to `nnml:1.gnus.ding'. And `nnml:List-gnus.ding' goes |
| 1776 | to `nnml:1.List-gnus-ding'. | 1776 | to `nnml:1.List-gnus-ding'. |
| 1777 | 1777 | ||
| @@ -1879,7 +1879,7 @@ some groups). How to do it? | |||
| 1879 | 1879 | ||
| 1880 | @subsubheading Answer | 1880 | @subsubheading Answer |
| 1881 | 1881 | ||
| 1882 | If you want all read messages to be expired (e.g. in | 1882 | If you want all read messages to be expired (e.g., in |
| 1883 | mailing lists where there's an online archive), you've | 1883 | mailing lists where there's an online archive), you've |
| 1884 | got two choices: auto-expire and | 1884 | got two choices: auto-expire and |
| 1885 | total-expire. Auto-expire means, that every article | 1885 | total-expire. Auto-expire means, that every article |
| @@ -1924,7 +1924,7 @@ Say something like this in ~/.gnus.el: | |||
| 1924 | 1924 | ||
| 1925 | (If you want to change the value of nnmail-expiry-target | 1925 | (If you want to change the value of nnmail-expiry-target |
| 1926 | on a per group basis see the question "How can I disable | 1926 | on a per group basis see the question "How can I disable |
| 1927 | threading in some (e.g. mail-) groups, or set other | 1927 | threading in some (e.g., mail-) groups, or set other |
| 1928 | variables specific for some groups?") | 1928 | variables specific for some groups?") |
| 1929 | 1929 | ||
| 1930 | @node FAQ 7 - Gnus in a dial-up environment | 1930 | @node FAQ 7 - Gnus in a dial-up environment |
| @@ -1983,7 +1983,7 @@ On windows boxes I'd vote for | |||
| 1983 | it's a small freeware, open-source program which fetches | 1983 | it's a small freeware, open-source program which fetches |
| 1984 | your mail and news from remote servers and offers them | 1984 | your mail and news from remote servers and offers them |
| 1985 | to Gnus (or any other mail and/or news reader) via nntp | 1985 | to Gnus (or any other mail and/or news reader) via nntp |
| 1986 | respectively POP3 or IMAP. It also includes a smtp | 1986 | respectively POP3 or IMAP@. It also includes a smtp |
| 1987 | server for receiving mails from Gnus. | 1987 | server for receiving mails from Gnus. |
| 1988 | 1988 | ||
| 1989 | @node FAQ 7-2 | 1989 | @node FAQ 7-2 |
| @@ -1996,7 +1996,7 @@ So what was this thing about the Agent? | |||
| 1996 | The Gnus agent is part of Gnus, it allows you to fetch | 1996 | The Gnus agent is part of Gnus, it allows you to fetch |
| 1997 | mail and news and store them on disk for reading them | 1997 | mail and news and store them on disk for reading them |
| 1998 | later when you're offline. It kind of mimics offline | 1998 | later when you're offline. It kind of mimics offline |
| 1999 | newsreaders like e.g. Forte Agent. If you want to use | 1999 | newsreaders like Forte Agent. If you want to use |
| 2000 | the Agent place the following in ~/.gnus.el if you are | 2000 | the Agent place the following in ~/.gnus.el if you are |
| 2001 | still using 5.8.8 or 5.9 (it's the default since 5.10): | 2001 | still using 5.8.8 or 5.9 (it's the default since 5.10): |
| 2002 | 2002 | ||
| @@ -2075,7 +2075,7 @@ work, the agent must be active. | |||
| 2075 | 2075 | ||
| 2076 | @menu | 2076 | @menu |
| 2077 | * FAQ 8-1:: How to find information and help inside Emacs? | 2077 | * FAQ 8-1:: How to find information and help inside Emacs? |
| 2078 | * FAQ 8-2:: I can't find anything in the Gnus manual about X (e.g. | 2078 | * FAQ 8-2:: I can't find anything in the Gnus manual about X (e.g., |
| 2079 | attachments, PGP, MIME...), is it not documented? | 2079 | attachments, PGP, MIME...), is it not documented? |
| 2080 | * FAQ 8-3:: Which websites should I know? | 2080 | * FAQ 8-3:: Which websites should I know? |
| 2081 | * FAQ 8-4:: Which mailing lists and newsgroups are there? | 2081 | * FAQ 8-4:: Which mailing lists and newsgroups are there? |
| @@ -2105,7 +2105,7 @@ apropos} searches the bound variables. | |||
| 2105 | @subsubheading Question 8.2 | 2105 | @subsubheading Question 8.2 |
| 2106 | 2106 | ||
| 2107 | I can't find anything in the Gnus manual about X | 2107 | I can't find anything in the Gnus manual about X |
| 2108 | (e.g. attachments, PGP, MIME...), is it not documented? | 2108 | (e.g., attachments, PGP, MIME...), is it not documented? |
| 2109 | 2109 | ||
| 2110 | @subsubheading Answer | 2110 | @subsubheading Answer |
| 2111 | 2111 | ||
diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index 47ff355d946..280819701ef 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi | |||
| @@ -1731,7 +1731,7 @@ asterisk at the beginning of the line?). | |||
| 1731 | You can change that format to whatever you want by fiddling with the | 1731 | You can change that format to whatever you want by fiddling with the |
| 1732 | @code{gnus-group-line-format} variable. This variable works along the | 1732 | @code{gnus-group-line-format} variable. This variable works along the |
| 1733 | lines of a @code{format} specification, which is pretty much the same as | 1733 | lines of a @code{format} specification, which is pretty much the same as |
| 1734 | a @code{printf} specifications, for those of you who use (feh!) C. | 1734 | a @code{printf} specifications, for those of you who use (feh!) C@. |
| 1735 | @xref{Formatting Variables}. | 1735 | @xref{Formatting Variables}. |
| 1736 | 1736 | ||
| 1737 | @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above. | 1737 | @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above. |
| @@ -2351,7 +2351,7 @@ groups isn't done because it is nice or clever, it is done purely for | |||
| 2351 | reasons of efficiency. | 2351 | reasons of efficiency. |
| 2352 | 2352 | ||
| 2353 | It is recommended that you keep all your mail groups (if any) on quite | 2353 | It is recommended that you keep all your mail groups (if any) on quite |
| 2354 | low levels (e.g. 1 or 2). | 2354 | low levels (e.g., 1 or 2). |
| 2355 | 2355 | ||
| 2356 | Maybe the following description of the default behavior of Gnus helps to | 2356 | Maybe the following description of the default behavior of Gnus helps to |
| 2357 | understand what these levels are all about. By default, Gnus shows you | 2357 | understand what these levels are all about. By default, Gnus shows you |
| @@ -2418,7 +2418,7 @@ give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will | |||
| 2418 | use this level as the ``work'' level. | 2418 | use this level as the ``work'' level. |
| 2419 | 2419 | ||
| 2420 | @vindex gnus-activate-level | 2420 | @vindex gnus-activate-level |
| 2421 | Gnus will normally just activate (i. e., query the server about) groups | 2421 | Gnus will normally just activate (i.e., query the server about) groups |
| 2422 | on level @code{gnus-activate-level} or less. If you don't want to | 2422 | on level @code{gnus-activate-level} or less. If you don't want to |
| 2423 | activate unsubscribed groups, for instance, you might set this variable | 2423 | activate unsubscribed groups, for instance, you might set this variable |
| 2424 | to 5. The default is 6. | 2424 | to 5. The default is 6. |
| @@ -2654,7 +2654,7 @@ to a particular group by using a match string like | |||
| 2654 | @kindex G R (Group) | 2654 | @kindex G R (Group) |
| 2655 | @findex gnus-group-make-rss-group | 2655 | @findex gnus-group-make-rss-group |
| 2656 | Make a group based on an @acronym{RSS} feed | 2656 | Make a group based on an @acronym{RSS} feed |
| 2657 | (@code{gnus-group-make-rss-group}). You will be prompted for an URL. | 2657 | (@code{gnus-group-make-rss-group}). You will be prompted for an URL@. |
| 2658 | @xref{RSS}. | 2658 | @xref{RSS}. |
| 2659 | 2659 | ||
| 2660 | @item G DEL | 2660 | @item G DEL |
| @@ -2708,7 +2708,7 @@ the article range. | |||
| 2708 | @findex gnus-read-ephemeral-gmane-group-url | 2708 | @findex gnus-read-ephemeral-gmane-group-url |
| 2709 | This command is similar to @code{gnus-read-ephemeral-gmane-group}, but | 2709 | This command is similar to @code{gnus-read-ephemeral-gmane-group}, but |
| 2710 | the group name and the article number and range are constructed from a | 2710 | the group name and the article number and range are constructed from a |
| 2711 | given @acronym{URL}. Supported @acronym{URL} formats include e.g. | 2711 | given @acronym{URL}. Supported @acronym{URL} formats include: |
| 2712 | @url{http://thread.gmane.org/gmane.foo.bar/12300/focus=12399}, | 2712 | @url{http://thread.gmane.org/gmane.foo.bar/12300/focus=12399}, |
| 2713 | @url{http://thread.gmane.org/gmane.foo.bar/12345/}, | 2713 | @url{http://thread.gmane.org/gmane.foo.bar/12345/}, |
| 2714 | @url{http://article.gmane.org/gmane.foo.bar/12345/}, | 2714 | @url{http://article.gmane.org/gmane.foo.bar/12345/}, |
| @@ -3125,7 +3125,7 @@ parameters, then you may need the following statement elsewhere in your | |||
| 3125 | 3125 | ||
| 3126 | @vindex gnus-list-identifiers | 3126 | @vindex gnus-list-identifiers |
| 3127 | A use for this feature is to remove a mailing list identifier tag in | 3127 | A use for this feature is to remove a mailing list identifier tag in |
| 3128 | the subject fields of articles. E.g. if the news group | 3128 | the subject fields of articles. E.g., if the news group |
| 3129 | 3129 | ||
| 3130 | @example | 3130 | @example |
| 3131 | nntp+news.gnus.org:gmane.text.docbook.apps | 3131 | nntp+news.gnus.org:gmane.text.docbook.apps |
| @@ -5036,7 +5036,7 @@ A related variable is @code{nnmail-extra-headers}, which controls when | |||
| 5036 | to include extra headers when generating overview (@acronym{NOV}) files. | 5036 | to include extra headers when generating overview (@acronym{NOV}) files. |
| 5037 | If you have old overview files, you should regenerate them after | 5037 | If you have old overview files, you should regenerate them after |
| 5038 | changing this variable, by entering the server buffer using @kbd{^}, | 5038 | changing this variable, by entering the server buffer using @kbd{^}, |
| 5039 | and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause | 5039 | and then @kbd{g} on the appropriate mail server (e.g., nnml) to cause |
| 5040 | regeneration. | 5040 | regeneration. |
| 5041 | 5041 | ||
| 5042 | @vindex gnus-summary-line-format | 5042 | @vindex gnus-summary-line-format |
| @@ -7120,8 +7120,8 @@ arrived on the mailing list. Consequently, when sorting sub-threads | |||
| 7120 | using the default @code{gnus-thread-sort-by-number}, responses can end | 7120 | using the default @code{gnus-thread-sort-by-number}, responses can end |
| 7121 | up appearing before the article to which they are responding to. | 7121 | up appearing before the article to which they are responding to. |
| 7122 | Setting this variable to an alternate value | 7122 | Setting this variable to an alternate value |
| 7123 | (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an | 7123 | (e.g., @code{gnus-thread-sort-by-date}), in a group's parameters or in an |
| 7124 | appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a | 7124 | appropriate hook (e.g., @code{gnus-summary-generate-hook}) can produce a |
| 7125 | more logical sub-thread ordering in such instances. | 7125 | more logical sub-thread ordering in such instances. |
| 7126 | 7126 | ||
| 7127 | @end table | 7127 | @end table |
| @@ -7908,7 +7908,7 @@ reader to use this setting. | |||
| 7908 | @item gnus-summary-save-in-pipe | 7908 | @item gnus-summary-save-in-pipe |
| 7909 | @findex gnus-summary-save-in-pipe | 7909 | @findex gnus-summary-save-in-pipe |
| 7910 | Pipe the article to a shell command. This function takes optional two | 7910 | Pipe the article to a shell command. This function takes optional two |
| 7911 | arguments COMMAND and RAW. Valid values for COMMAND include: | 7911 | arguments COMMAND and RAW@. Valid values for COMMAND include: |
| 7912 | 7912 | ||
| 7913 | @itemize @bullet | 7913 | @itemize @bullet |
| 7914 | @item a string@* | 7914 | @item a string@* |
| @@ -8916,7 +8916,7 @@ Unreadable articles that tell you to read them with Caesar rotate or rot13. | |||
| 8916 | (Typically offensive jokes and such.) | 8916 | (Typically offensive jokes and such.) |
| 8917 | 8917 | ||
| 8918 | It's commonly called ``rot13'' because each letter is rotated 13 | 8918 | It's commonly called ``rot13'' because each letter is rotated 13 |
| 8919 | positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter | 8919 | positions in the alphabet, e.g., @samp{B} (letter #2) -> @samp{O} (letter |
| 8920 | #15). It is sometimes referred to as ``Caesar rotate'' because Caesar | 8920 | #15). It is sometimes referred to as ``Caesar rotate'' because Caesar |
| 8921 | is rumored to have employed this form of, uh, somewhat weak encryption. | 8921 | is rumored to have employed this form of, uh, somewhat weak encryption. |
| 8922 | 8922 | ||
| @@ -9037,7 +9037,7 @@ Capitalize the first word in each sentence | |||
| 9037 | @item W c | 9037 | @item W c |
| 9038 | @kindex W c (Summary) | 9038 | @kindex W c (Summary) |
| 9039 | @findex gnus-article-remove-cr | 9039 | @findex gnus-article-remove-cr |
| 9040 | Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF | 9040 | Translate CRLF pairs (i.e., @samp{^M}s on the end of the lines) into LF |
| 9041 | (this takes care of DOS line endings), and then translate any remaining | 9041 | (this takes care of DOS line endings), and then translate any remaining |
| 9042 | CRs into LF (this takes care of Mac line endings) | 9042 | CRs into LF (this takes care of Mac line endings) |
| 9043 | (@code{gnus-article-remove-cr}). | 9043 | (@code{gnus-article-remove-cr}). |
| @@ -9587,13 +9587,13 @@ Piconify the @code{From} header (@code{gnus-treat-from-picon}). | |||
| 9587 | @item W D m | 9587 | @item W D m |
| 9588 | @kindex W D m (Summary) | 9588 | @kindex W D m (Summary) |
| 9589 | @findex gnus-treat-mail-picon | 9589 | @findex gnus-treat-mail-picon |
| 9590 | Piconify all mail headers (i. e., @code{Cc}, @code{To}) | 9590 | Piconify all mail headers (i.e., @code{Cc}, @code{To}) |
| 9591 | (@code{gnus-treat-mail-picon}). | 9591 | (@code{gnus-treat-mail-picon}). |
| 9592 | 9592 | ||
| 9593 | @item W D n | 9593 | @item W D n |
| 9594 | @kindex W D n (Summary) | 9594 | @kindex W D n (Summary) |
| 9595 | @findex gnus-treat-newsgroups-picon | 9595 | @findex gnus-treat-newsgroups-picon |
| 9596 | Piconify all news headers (i. e., @code{Newsgroups} and | 9596 | Piconify all news headers (i.e., @code{Newsgroups} and |
| 9597 | @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}). | 9597 | @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}). |
| 9598 | 9598 | ||
| 9599 | @item W D g | 9599 | @item W D g |
| @@ -9604,7 +9604,7 @@ Gravatarify the @code{From} header (@code{gnus-treat-from-gravatar}). | |||
| 9604 | @item W D h | 9604 | @item W D h |
| 9605 | @kindex W D h (Summary) | 9605 | @kindex W D h (Summary) |
| 9606 | @findex gnus-treat-mail-gravatar | 9606 | @findex gnus-treat-mail-gravatar |
| 9607 | Gravatarify all mail headers (i. e., @code{Cc}, @code{To}) | 9607 | Gravatarify all mail headers (i.e., @code{Cc}, @code{To}) |
| 9608 | (@code{gnus-treat-from-gravatar}). | 9608 | (@code{gnus-treat-from-gravatar}). |
| 9609 | 9609 | ||
| 9610 | @item W D D | 9610 | @item W D D |
| @@ -9885,7 +9885,7 @@ displayed. This variable overrides | |||
| 9885 | This variable is only used when @code{gnus-inhibit-mime-unbuttonizing} | 9885 | This variable is only used when @code{gnus-inhibit-mime-unbuttonizing} |
| 9886 | is @code{nil}. | 9886 | is @code{nil}. |
| 9887 | 9887 | ||
| 9888 | To see e.g. security buttons but no other buttons, you could set this | 9888 | E.g., to see security buttons but no other buttons, you could set this |
| 9889 | variable to @code{("multipart/signed")} and leave | 9889 | variable to @code{("multipart/signed")} and leave |
| 9890 | @code{gnus-unbuttonized-mime-types} at the default value. | 9890 | @code{gnus-unbuttonized-mime-types} at the default value. |
| 9891 | 9891 | ||
| @@ -9904,8 +9904,8 @@ default value is @code{nil}. | |||
| 9904 | @vindex gnus-article-mime-part-function | 9904 | @vindex gnus-article-mime-part-function |
| 9905 | For each @acronym{MIME} part, this function will be called with the @acronym{MIME} | 9905 | For each @acronym{MIME} part, this function will be called with the @acronym{MIME} |
| 9906 | handle as the parameter. The function is meant to be used to allow | 9906 | handle as the parameter. The function is meant to be used to allow |
| 9907 | users to gather information from the article (e. g., add Vcard info to | 9907 | users to gather information from the article (e.g., add Vcard info to |
| 9908 | the bbdb database) or to do actions based on parts (e. g., automatically | 9908 | the bbdb database) or to do actions based on parts (e.g., automatically |
| 9909 | save all jpegs into some directory). | 9909 | save all jpegs into some directory). |
| 9910 | 9910 | ||
| 9911 | Here's an example function the does the latter: | 9911 | Here's an example function the does the latter: |
| @@ -10230,7 +10230,7 @@ visible effects normally, but it'll make this command work a whole lot | |||
| 10230 | faster. Of course, it'll make group entry somewhat slow. | 10230 | faster. Of course, it'll make group entry somewhat slow. |
| 10231 | 10231 | ||
| 10232 | @vindex gnus-refer-thread-limit | 10232 | @vindex gnus-refer-thread-limit |
| 10233 | The @code{gnus-refer-thread-limit} variable says how many old (i. e., | 10233 | The @code{gnus-refer-thread-limit} variable says how many old (i.e., |
| 10234 | articles before the first displayed in the current group) headers to | 10234 | articles before the first displayed in the current group) headers to |
| 10235 | fetch when doing this command. The default is 200. If @code{t}, all | 10235 | fetch when doing this command. The default is 200. If @code{t}, all |
| 10236 | the available headers will be fetched. This variable can be overridden | 10236 | the available headers will be fetched. This variable can be overridden |
| @@ -11275,13 +11275,13 @@ things to work: | |||
| 11275 | @enumerate | 11275 | @enumerate |
| 11276 | @item | 11276 | @item |
| 11277 | To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to | 11277 | To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to |
| 11278 | install an OpenPGP implementation such as GnuPG. The Lisp interface | 11278 | install an OpenPGP implementation such as GnuPG@. The Lisp interface |
| 11279 | to GnuPG included with Emacs is called EasyPG (@pxref{Top, ,EasyPG, | 11279 | to GnuPG included with Emacs is called EasyPG (@pxref{Top, ,EasyPG, |
| 11280 | epa, EasyPG Assistant user's manual}), but PGG (@pxref{Top, ,PGG, pgg, | 11280 | epa, EasyPG Assistant user's manual}), but PGG (@pxref{Top, ,PGG, pgg, |
| 11281 | PGG Manual}), and Mailcrypt are also supported. | 11281 | PGG Manual}), and Mailcrypt are also supported. |
| 11282 | 11282 | ||
| 11283 | @item | 11283 | @item |
| 11284 | To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6 | 11284 | To handle @acronym{S/MIME} message, you need to install OpenSSL@. OpenSSL 0.9.6 |
| 11285 | or newer is recommended. | 11285 | or newer is recommended. |
| 11286 | 11286 | ||
| 11287 | @end enumerate | 11287 | @end enumerate |
| @@ -11773,7 +11773,7 @@ directory, the oldest files will be deleted. The default is 500MB. | |||
| 11773 | 11773 | ||
| 11774 | @item gnus-html-frame-width | 11774 | @item gnus-html-frame-width |
| 11775 | @vindex gnus-html-frame-width | 11775 | @vindex gnus-html-frame-width |
| 11776 | The width to use when rendering HTML. The default is 70. | 11776 | The width to use when rendering HTML@. The default is 70. |
| 11777 | 11777 | ||
| 11778 | @item gnus-max-image-proportion | 11778 | @item gnus-max-image-proportion |
| 11779 | @vindex gnus-max-image-proportion | 11779 | @vindex gnus-max-image-proportion |
| @@ -12218,7 +12218,7 @@ Displayed when headers are hidden in the article buffer. | |||
| 12218 | @item p | 12218 | @item p |
| 12219 | Displayed when article is digitally signed or encrypted, and Gnus has | 12219 | Displayed when article is digitally signed or encrypted, and Gnus has |
| 12220 | hidden the security headers. (N.B. does not tell anything about | 12220 | hidden the security headers. (N.B. does not tell anything about |
| 12221 | security status, i.e. good or bad signature.) | 12221 | security status, i.e., good or bad signature.) |
| 12222 | 12222 | ||
| 12223 | @item s | 12223 | @item s |
| 12224 | Displayed when the signature has been hidden in the Article buffer. | 12224 | Displayed when the signature has been hidden in the Article buffer. |
| @@ -12683,7 +12683,7 @@ copy of a sent message. The current buffer (when the hook is run) | |||
| 12683 | contains the message including the message header. Changes made to | 12683 | contains the message including the message header. Changes made to |
| 12684 | the message will only affect the Gcc copy, but not the original | 12684 | the message will only affect the Gcc copy, but not the original |
| 12685 | message. You can use these hooks to edit the copy (and influence | 12685 | message. You can use these hooks to edit the copy (and influence |
| 12686 | subsequent transformations), e.g. remove MML secure tags | 12686 | subsequent transformations), e.g., remove MML secure tags |
| 12687 | (@pxref{Signing and encrypting}). | 12687 | (@pxref{Signing and encrypting}). |
| 12688 | 12688 | ||
| 12689 | @end table | 12689 | @end table |
| @@ -13028,7 +13028,7 @@ personal mail group. | |||
| 13028 | 13028 | ||
| 13029 | A foreign group (or any group, really) is specified by a @dfn{name} and | 13029 | A foreign group (or any group, really) is specified by a @dfn{name} and |
| 13030 | a @dfn{select method}. To take the latter first, a select method is a | 13030 | a @dfn{select method}. To take the latter first, a select method is a |
| 13031 | list where the first element says what back end to use (e.g. @code{nntp}, | 13031 | list where the first element says what back end to use (e.g., @code{nntp}, |
| 13032 | @code{nnspool}, @code{nnml}) and the second element is the @dfn{server | 13032 | @code{nnspool}, @code{nnml}) and the second element is the @dfn{server |
| 13033 | name}. There may be additional elements in the select method, where the | 13033 | name}. There may be additional elements in the select method, where the |
| 13034 | value may have special meaning for the back end in question. | 13034 | value may have special meaning for the back end in question. |
| @@ -13405,7 +13405,7 @@ Server variables are often called @dfn{server parameters}. | |||
| 13405 | @subsection Servers and Methods | 13405 | @subsection Servers and Methods |
| 13406 | 13406 | ||
| 13407 | Wherever you would normally use a select method | 13407 | Wherever you would normally use a select method |
| 13408 | (e.g. @code{gnus-secondary-select-method}, in the group select method, | 13408 | (e.g., @code{gnus-secondary-select-method}, in the group select method, |
| 13409 | when browsing a foreign server) you can use a virtual server name | 13409 | when browsing a foreign server) you can use a virtual server name |
| 13410 | instead. This could potentially save lots of typing. And it's nice all | 13410 | instead. This could potentially save lots of typing. And it's nice all |
| 13411 | over. | 13411 | over. |
| @@ -13749,7 +13749,7 @@ inhibit Gnus to add a @code{Message-ID} header, you could say: | |||
| 13749 | (add-hook 'nntp-prepare-post-hook 'canlock-insert-header) | 13749 | (add-hook 'nntp-prepare-post-hook 'canlock-insert-header) |
| 13750 | @end lisp | 13750 | @end lisp |
| 13751 | 13751 | ||
| 13752 | Note that not all servers support the recommended ID. This works for | 13752 | Note that not all servers support the recommended ID@. This works for |
| 13753 | INN versions 2.3.0 and later, for instance. | 13753 | INN versions 2.3.0 and later, for instance. |
| 13754 | 13754 | ||
| 13755 | @item nntp-server-list-active-group | 13755 | @item nntp-server-list-active-group |
| @@ -14268,7 +14268,7 @@ Here's a complete example @code{nnimap} backend with a client-side | |||
| 14268 | @cindex reading mail | 14268 | @cindex reading mail |
| 14269 | @cindex mail | 14269 | @cindex mail |
| 14270 | 14270 | ||
| 14271 | Reading mail with a newsreader---isn't that just plain WeIrD? But of | 14271 | Reading mail with a newsreader---isn't that just plain WeIrD@? But of |
| 14272 | course. | 14272 | course. |
| 14273 | 14273 | ||
| 14274 | @menu | 14274 | @menu |
| @@ -14684,8 +14684,8 @@ The name of the @acronym{POP} server. The default is taken from the | |||
| 14684 | @env{MAILHOST} environment variable. | 14684 | @env{MAILHOST} environment variable. |
| 14685 | 14685 | ||
| 14686 | @item :port | 14686 | @item :port |
| 14687 | The port number of the @acronym{POP} server. This can be a number (eg, | 14687 | The port number of the @acronym{POP} server. This can be a number (e.g., |
| 14688 | @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a | 14688 | @samp{:port 1234}) or a string (e.g., @samp{:port "pop3"}). If it is a |
| 14689 | string, it should be a service name as listed in @file{/etc/services} on | 14689 | string, it should be a service name as listed in @file{/etc/services} on |
| 14690 | Unix systems. The default is @samp{"pop3"}. On some systems you might | 14690 | Unix systems. The default is @samp{"pop3"}. On some systems you might |
| 14691 | need to specify it as @samp{"pop-3"} instead. | 14691 | need to specify it as @samp{"pop-3"} instead. |
| @@ -14858,7 +14858,7 @@ Two example maildir mail sources: | |||
| 14858 | 14858 | ||
| 14859 | @item imap | 14859 | @item imap |
| 14860 | Get mail from a @acronym{IMAP} server. If you don't want to use | 14860 | Get mail from a @acronym{IMAP} server. If you don't want to use |
| 14861 | @acronym{IMAP} as intended, as a network mail reading protocol (ie | 14861 | @acronym{IMAP} as intended, as a network mail reading protocol (i.e., |
| 14862 | with nnimap), for some reason or other, Gnus let you treat it similar | 14862 | with nnimap), for some reason or other, Gnus let you treat it similar |
| 14863 | to a @acronym{POP} server and fetches articles from a given | 14863 | to a @acronym{POP} server and fetches articles from a given |
| 14864 | @acronym{IMAP} mailbox. @xref{Using IMAP}, for more information. | 14864 | @acronym{IMAP} mailbox. @xref{Using IMAP}, for more information. |
| @@ -15392,7 +15392,7 @@ Where @code{nnmail-split-lowercase-expanded} controls whether the | |||
| 15392 | lowercase of the matched string should be used for the substitution. | 15392 | lowercase of the matched string should be used for the substitution. |
| 15393 | Setting it as non-@code{nil} is useful to avoid the creation of multiple | 15393 | Setting it as non-@code{nil} is useful to avoid the creation of multiple |
| 15394 | groups when users send to an address using different case | 15394 | groups when users send to an address using different case |
| 15395 | (i.e. mailing-list@@domain vs Mailing-List@@Domain). The default value | 15395 | (i.e., mailing-list@@domain vs Mailing-List@@Domain). The default value |
| 15396 | is @code{t}. | 15396 | is @code{t}. |
| 15397 | 15397 | ||
| 15398 | @findex nnmail-split-fancy-with-parent | 15398 | @findex nnmail-split-fancy-with-parent |
| @@ -15926,7 +15926,7 @@ Translate all @samp{TAB} characters into @samp{SPACE} characters. | |||
| 15926 | @c @findex nnmail-fix-eudora-headers | 15926 | @c @findex nnmail-fix-eudora-headers |
| 15927 | @cindex Eudora | 15927 | @cindex Eudora |
| 15928 | @cindex Pegasus | 15928 | @cindex Pegasus |
| 15929 | Some mail user agents (e.g. Eudora and Pegasus) produce broken | 15929 | Some mail user agents (e.g., Eudora and Pegasus) produce broken |
| 15930 | @code{References} headers, but correct @code{In-Reply-To} headers. This | 15930 | @code{References} headers, but correct @code{In-Reply-To} headers. This |
| 15931 | function will get rid of the @code{References} header if the headers | 15931 | function will get rid of the @code{References} header if the headers |
| 15932 | contain a line matching the regular expression | 15932 | contain a line matching the regular expression |
| @@ -16935,7 +16935,7 @@ Some web sites have an RDF Site Summary (@acronym{RSS}). | |||
| 16935 | @acronym{RSS} is a format for summarizing headlines from news related | 16935 | @acronym{RSS} is a format for summarizing headlines from news related |
| 16936 | sites (such as BBC or CNN). But basically anything list-like can be | 16936 | sites (such as BBC or CNN). But basically anything list-like can be |
| 16937 | presented as an @acronym{RSS} feed: weblogs, changelogs or recent | 16937 | presented as an @acronym{RSS} feed: weblogs, changelogs or recent |
| 16938 | changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}). | 16938 | changes to a wiki (e.g., @url{http://cliki.net/recent-changes.rdf}). |
| 16939 | 16939 | ||
| 16940 | @acronym{RSS} has a quite regular and nice interface, and it's | 16940 | @acronym{RSS} has a quite regular and nice interface, and it's |
| 16941 | possible to get the information Gnus needs to keep groups updated. | 16941 | possible to get the information Gnus needs to keep groups updated. |
| @@ -16999,7 +16999,7 @@ in Emacs or @code{escape-quoted} in XEmacs). | |||
| 16999 | @item nnrss-ignore-article-fields | 16999 | @item nnrss-ignore-article-fields |
| 17000 | @vindex nnrss-ignore-article-fields | 17000 | @vindex nnrss-ignore-article-fields |
| 17001 | Some feeds update constantly article fields during their publications, | 17001 | Some feeds update constantly article fields during their publications, |
| 17002 | e.g. to indicate the number of comments. However, if there is | 17002 | e.g., to indicate the number of comments. However, if there is |
| 17003 | a difference between the local article and the distant one, the latter | 17003 | a difference between the local article and the distant one, the latter |
| 17004 | is considered to be new. To avoid this and discard some fields, set this | 17004 | is considered to be new. To avoid this and discard some fields, set this |
| 17005 | variable to the list of fields to be ignored. The default is | 17005 | variable to the list of fields to be ignored. The default is |
| @@ -17169,7 +17169,7 @@ After all, Gnus is a newsreader, in case you're forgetting. | |||
| 17169 | @code{nneething} does this in a two-step process. First, it snoops each | 17169 | @code{nneething} does this in a two-step process. First, it snoops each |
| 17170 | file in question. If the file looks like an article (i.e., the first | 17170 | file in question. If the file looks like an article (i.e., the first |
| 17171 | few lines look like headers), it will use this as the head. If this is | 17171 | few lines look like headers), it will use this as the head. If this is |
| 17172 | just some arbitrary file without a head (e.g. a C source file), | 17172 | just some arbitrary file without a head (e.g., a C source file), |
| 17173 | @code{nneething} will cobble up a header out of thin air. It will use | 17173 | @code{nneething} will cobble up a header out of thin air. It will use |
| 17174 | file ownership, name and date and do whatever it can with these | 17174 | file ownership, name and date and do whatever it can with these |
| 17175 | elements. | 17175 | elements. |
| @@ -17891,7 +17891,7 @@ two variables are probably the only ones you will want to change: | |||
| 17891 | 17891 | ||
| 17892 | @defvar nndiary-reminders | 17892 | @defvar nndiary-reminders |
| 17893 | This is the list of times when you want to be reminded of your | 17893 | This is the list of times when you want to be reminded of your |
| 17894 | appointments (e.g. 3 weeks before, then 2 days before, then 1 hour | 17894 | appointments (e.g., 3 weeks before, then 2 days before, then 1 hour |
| 17895 | before and that's it). Remember that ``being reminded'' means that the | 17895 | before and that's it). Remember that ``being reminded'' means that the |
| 17896 | diary message will pop up as brand new and unread again when you get new | 17896 | diary message will pop up as brand new and unread again when you get new |
| 17897 | mail. | 17897 | mail. |
| @@ -17943,9 +17943,9 @@ see the event's date. | |||
| 17943 | 17943 | ||
| 17944 | @code{gnus-diary} provides two supplemental user formats to be used in | 17944 | @code{gnus-diary} provides two supplemental user formats to be used in |
| 17945 | summary line formats. @code{D} corresponds to a formatted time string | 17945 | summary line formats. @code{D} corresponds to a formatted time string |
| 17946 | for the next occurrence of the event (e.g. ``Sat, Sep 22 01, 12:00''), | 17946 | for the next occurrence of the event (e.g., ``Sat, Sep 22 01, 12:00''), |
| 17947 | while @code{d} corresponds to an approximate remaining time until the | 17947 | while @code{d} corresponds to an approximate remaining time until the |
| 17948 | next occurrence of the event (e.g. ``in 6 months, 1 week''). | 17948 | next occurrence of the event (e.g., ``in 6 months, 1 week''). |
| 17949 | 17949 | ||
| 17950 | For example, here's how Joe's birthday is displayed in my | 17950 | For example, here's how Joe's birthday is displayed in my |
| 17951 | @code{nndiary+diary:birthdays} summary buffer (note that the message is | 17951 | @code{nndiary+diary:birthdays} summary buffer (note that the message is |
| @@ -18399,7 +18399,7 @@ to know: The functions are called with no parameters, but the | |||
| 18399 | useful values. | 18399 | useful values. |
| 18400 | 18400 | ||
| 18401 | For example, you could decide that you don't want to download articles | 18401 | For example, you could decide that you don't want to download articles |
| 18402 | that were posted more than a certain number of days ago (e.g. posted | 18402 | that were posted more than a certain number of days ago (e.g., posted |
| 18403 | more than @code{gnus-agent-expire-days} ago) you might write a function | 18403 | more than @code{gnus-agent-expire-days} ago) you might write a function |
| 18404 | something along the lines of the following: | 18404 | something along the lines of the following: |
| 18405 | 18405 | ||
| @@ -19119,7 +19119,7 @@ Hook run when finished fetching articles. | |||
| 19119 | @item gnus-agent-cache | 19119 | @item gnus-agent-cache |
| 19120 | @vindex gnus-agent-cache | 19120 | @vindex gnus-agent-cache |
| 19121 | Variable to control whether use the locally stored @acronym{NOV} and | 19121 | Variable to control whether use the locally stored @acronym{NOV} and |
| 19122 | articles when plugged, e.g. essentially using the Agent as a cache. | 19122 | articles when plugged, e.g., essentially using the Agent as a cache. |
| 19123 | The default is non-@code{nil}, which means to use the Agent as a cache. | 19123 | The default is non-@code{nil}, which means to use the Agent as a cache. |
| 19124 | 19124 | ||
| 19125 | @item gnus-agent-go-online | 19125 | @item gnus-agent-go-online |
| @@ -19370,7 +19370,7 @@ entries into this list, and upon group exit, this list is saved. | |||
| 19370 | 19370 | ||
| 19371 | The current score file is by default the group's local score file, even | 19371 | The current score file is by default the group's local score file, even |
| 19372 | if no such score file actually exists. To insert score commands into | 19372 | if no such score file actually exists. To insert score commands into |
| 19373 | some other score file (e.g. @file{all.SCORE}), you must first make this | 19373 | some other score file (e.g., @file{all.SCORE}), you must first make this |
| 19374 | score file the current one. | 19374 | score file the current one. |
| 19375 | 19375 | ||
| 19376 | General score commands that don't actually change the score file: | 19376 | General score commands that don't actually change the score file: |
| @@ -19986,7 +19986,7 @@ header uses. | |||
| 19986 | This match key is somewhat special, in that it will match the | 19986 | This match key is somewhat special, in that it will match the |
| 19987 | @code{From} header, and affect the score of not only the matching | 19987 | @code{From} header, and affect the score of not only the matching |
| 19988 | articles, but also all followups to the matching articles. This allows | 19988 | articles, but also all followups to the matching articles. This allows |
| 19989 | you e.g. increase the score of followups to your own articles, or | 19989 | you to increase the score of followups to your own articles, or |
| 19990 | decrease the score of followups to the articles of some known | 19990 | decrease the score of followups to the articles of some known |
| 19991 | trouble-maker. Uses the same match types as the @code{From} header | 19991 | trouble-maker. Uses the same match types as the @code{From} header |
| 19992 | uses. (Using this match key will lead to creation of @file{ADAPT} | 19992 | uses. (Using this match key will lead to creation of @file{ADAPT} |
| @@ -20066,7 +20066,7 @@ interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{c y}) the | |||
| 20066 | rest. Next time you enter the group, you will see new articles in the | 20066 | rest. Next time you enter the group, you will see new articles in the |
| 20067 | interesting threads, plus any new threads. | 20067 | interesting threads, plus any new threads. |
| 20068 | 20068 | ||
| 20069 | I.e.---the orphan score atom is for high-volume groups where a few | 20069 | I.e., the orphan score atom is for high-volume groups where a few |
| 20070 | interesting threads which can't be found automatically by ordinary | 20070 | interesting threads which can't be found automatically by ordinary |
| 20071 | scoring rules exist. | 20071 | scoring rules exist. |
| 20072 | 20072 | ||
| @@ -20961,7 +20961,7 @@ When score files are loaded and @code{gnus-decay-scores} is | |||
| 20961 | non-@code{nil}, Gnus will run the score files through the decaying | 20961 | non-@code{nil}, Gnus will run the score files through the decaying |
| 20962 | mechanism thereby lowering the scores of all non-permanent score rules. | 20962 | mechanism thereby lowering the scores of all non-permanent score rules. |
| 20963 | If @code{gnus-decay-scores} is a regexp, only score files matching this | 20963 | If @code{gnus-decay-scores} is a regexp, only score files matching this |
| 20964 | regexp are treated. E.g. you may set it to @samp{\\.ADAPT\\'} if only | 20964 | regexp are treated. E.g., you may set it to @samp{\\.ADAPT\\'} if only |
| 20965 | @emph{adaptive} score files should be decayed. The decay itself if | 20965 | @emph{adaptive} score files should be decayed. The decay itself if |
| 20966 | performed by the @code{gnus-decay-score-function} function, which is | 20966 | performed by the @code{gnus-decay-score-function} function, which is |
| 20967 | @code{gnus-decay-score} by default. Here's the definition of that | 20967 | @code{gnus-decay-score} by default. Here's the definition of that |
| @@ -21168,7 +21168,7 @@ features (inspired by the Google search input language): | |||
| 21168 | 21168 | ||
| 21169 | @item Boolean query operators | 21169 | @item Boolean query operators |
| 21170 | AND, OR, and NOT are supported, and parentheses can be used to control | 21170 | AND, OR, and NOT are supported, and parentheses can be used to control |
| 21171 | operator precedence, e.g. (emacs OR xemacs) AND linux. Note that | 21171 | operator precedence, e.g., (emacs OR xemacs) AND linux. Note that |
| 21172 | operators must be written with all capital letters to be | 21172 | operators must be written with all capital letters to be |
| 21173 | recognized. Also preceding a term with a - sign is equivalent to NOT | 21173 | recognized. Also preceding a term with a - sign is equivalent to NOT |
| 21174 | term. | 21174 | term. |
| @@ -21213,12 +21213,12 @@ Gmane queries follow a simple query language: | |||
| 21213 | @table @samp | 21213 | @table @samp |
| 21214 | @item Boolean query operators | 21214 | @item Boolean query operators |
| 21215 | AND, OR, NOT (or AND NOT), and XOR are supported, and brackets can be | 21215 | AND, OR, NOT (or AND NOT), and XOR are supported, and brackets can be |
| 21216 | used to control operator precedence, e.g. (emacs OR xemacs) AND linux. | 21216 | used to control operator precedence, e.g., (emacs OR xemacs) AND linux. |
| 21217 | Note that operators must be written with all capital letters to be | 21217 | Note that operators must be written with all capital letters to be |
| 21218 | recognized. | 21218 | recognized. |
| 21219 | 21219 | ||
| 21220 | @item Required and excluded terms | 21220 | @item Required and excluded terms |
| 21221 | + and - can be used to require or exclude terms, e.g. football -american | 21221 | + and - can be used to require or exclude terms, e.g., football -american |
| 21222 | 21222 | ||
| 21223 | @item Unicode handling | 21223 | @item Unicode handling |
| 21224 | The search engine converts all text to utf-8, so searching should work | 21224 | The search engine converts all text to utf-8, so searching should work |
| @@ -21226,8 +21226,8 @@ in any language. | |||
| 21226 | 21226 | ||
| 21227 | @item Stopwords | 21227 | @item Stopwords |
| 21228 | Common English words (like 'the' and 'a') are ignored by default. You | 21228 | Common English words (like 'the' and 'a') are ignored by default. You |
| 21229 | can override this by prefixing such words with a + (e.g. +the) or | 21229 | can override this by prefixing such words with a + (e.g., +the) or |
| 21230 | enclosing the word in quotes (e.g. "the"). | 21230 | enclosing the word in quotes (e.g., "the"). |
| 21231 | 21231 | ||
| 21232 | @end table | 21232 | @end table |
| 21233 | 21233 | ||
| @@ -21417,7 +21417,7 @@ bound to mairix searches and are automatically updated. | |||
| 21417 | @end menu | 21417 | @end menu |
| 21418 | 21418 | ||
| 21419 | @c FIXME: The markup in this section might need improvement. | 21419 | @c FIXME: The markup in this section might need improvement. |
| 21420 | @c E.g. adding @samp, @var, @file, @command, etc. | 21420 | @c E.g., adding @samp, @var, @file, @command, etc. |
| 21421 | @c Cf. (info "(texinfo)Indicating") | 21421 | @c Cf. (info "(texinfo)Indicating") |
| 21422 | 21422 | ||
| 21423 | @node About mairix | 21423 | @node About mairix |
| @@ -21425,7 +21425,7 @@ bound to mairix searches and are automatically updated. | |||
| 21425 | 21425 | ||
| 21426 | Mairix is a tool for indexing and searching words in locally stored | 21426 | Mairix is a tool for indexing and searching words in locally stored |
| 21427 | mail. It was written by Richard Curnow and is licensed under the | 21427 | mail. It was written by Richard Curnow and is licensed under the |
| 21428 | GPL. Mairix comes with most popular GNU/Linux distributions, but it also | 21428 | GPL@. Mairix comes with most popular GNU/Linux distributions, but it also |
| 21429 | runs under Windows (with cygwin), Mac OS X and Solaris. The homepage can | 21429 | runs under Windows (with cygwin), Mac OS X and Solaris. The homepage can |
| 21430 | be found at | 21430 | be found at |
| 21431 | @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html} | 21431 | @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html} |
| @@ -21455,8 +21455,8 @@ searches. | |||
| 21455 | 21455 | ||
| 21456 | Mairix searches local mail---that means, mairix absolutely must have | 21456 | Mairix searches local mail---that means, mairix absolutely must have |
| 21457 | direct access to your mail folders. If your mail resides on another | 21457 | direct access to your mail folders. If your mail resides on another |
| 21458 | server (e.g. an @acronym{IMAP} server) and you happen to have shell | 21458 | server (e.g., an @acronym{IMAP} server) and you happen to have shell |
| 21459 | access, @code{nnmairix} supports running mairix remotely, e.g. via ssh. | 21459 | access, @code{nnmairix} supports running mairix remotely, e.g., via ssh. |
| 21460 | 21460 | ||
| 21461 | Additionally, @code{nnmairix} only supports the following Gnus back | 21461 | Additionally, @code{nnmairix} only supports the following Gnus back |
| 21462 | ends: @code{nnml}, @code{nnmaildir}, and @code{nnimap}. You must use | 21462 | ends: @code{nnml}, @code{nnmaildir}, and @code{nnimap}. You must use |
| @@ -21476,7 +21476,7 @@ the package @file{mairix.el}, which comes with Emacs 23. | |||
| 21476 | The back end @code{nnmairix} enables you to call mairix from within Gnus, | 21476 | The back end @code{nnmairix} enables you to call mairix from within Gnus, |
| 21477 | either to query mairix with a search term or to update the | 21477 | either to query mairix with a search term or to update the |
| 21478 | database. While visiting a message in the summary buffer, you can use | 21478 | database. While visiting a message in the summary buffer, you can use |
| 21479 | several pre-defined shortcuts for calling mairix, e.g. to quickly | 21479 | several pre-defined shortcuts for calling mairix, e.g., to quickly |
| 21480 | search for all mails from the sender of the current message or to | 21480 | search for all mails from the sender of the current message or to |
| 21481 | display the whole thread associated with the message, even if the | 21481 | display the whole thread associated with the message, even if the |
| 21482 | mails are in different folders. | 21482 | mails are in different folders. |
| @@ -21484,8 +21484,8 @@ mails are in different folders. | |||
| 21484 | Additionally, you can create permanent @code{nnmairix} groups which are bound | 21484 | Additionally, you can create permanent @code{nnmairix} groups which are bound |
| 21485 | to certain mairix searches. This way, you can easily create a group | 21485 | to certain mairix searches. This way, you can easily create a group |
| 21486 | containing mails from a certain sender, with a certain subject line or | 21486 | containing mails from a certain sender, with a certain subject line or |
| 21487 | even for one specific thread based on the Message-ID. If you check for | 21487 | even for one specific thread based on the Message-ID@. If you check for |
| 21488 | new mail in these folders (e.g. by pressing @kbd{g} or @kbd{M-g}), they | 21488 | new mail in these folders (e.g., by pressing @kbd{g} or @kbd{M-g}), they |
| 21489 | automatically update themselves by calling mairix. | 21489 | automatically update themselves by calling mairix. |
| 21490 | 21490 | ||
| 21491 | You might ask why you need @code{nnmairix} at all, since mairix already | 21491 | You might ask why you need @code{nnmairix} at all, since mairix already |
| @@ -21495,7 +21495,7 @@ does not---at least not without problems. Most probably you will get | |||
| 21495 | strange article counts, and sometimes you might see mails which Gnus | 21495 | strange article counts, and sometimes you might see mails which Gnus |
| 21496 | claims have already been canceled and are inaccessible. This is due to | 21496 | claims have already been canceled and are inaccessible. This is due to |
| 21497 | the fact that Gnus isn't really amused when things are happening behind | 21497 | the fact that Gnus isn't really amused when things are happening behind |
| 21498 | its back. Another problem can be the mail back end itself, e.g. if you | 21498 | its back. Another problem can be the mail back end itself, e.g., if you |
| 21499 | use mairix with an @acronym{IMAP} server (I had Dovecot complaining | 21499 | use mairix with an @acronym{IMAP} server (I had Dovecot complaining |
| 21500 | about corrupt index files when mairix changed the contents of the search | 21500 | about corrupt index files when mairix changed the contents of the search |
| 21501 | group). Using @code{nnmairix} should circumvent these problems. | 21501 | group). Using @code{nnmairix} should circumvent these problems. |
| @@ -21510,7 +21510,7 @@ binary so that the search results are stored in folders named | |||
| 21510 | present these folders in the Gnus front end only with @code{<NAME>}. | 21510 | present these folders in the Gnus front end only with @code{<NAME>}. |
| 21511 | You can use an existing mail back end where you already store your mail, | 21511 | You can use an existing mail back end where you already store your mail, |
| 21512 | but if you're uncomfortable with @code{nnmairix} creating new mail | 21512 | but if you're uncomfortable with @code{nnmairix} creating new mail |
| 21513 | groups alongside your other mail, you can also create e.g. a new | 21513 | groups alongside your other mail, you can also create, e.g., a new |
| 21514 | @code{nnmaildir} or @code{nnml} server exclusively for mairix, but then | 21514 | @code{nnmaildir} or @code{nnml} server exclusively for mairix, but then |
| 21515 | make sure those servers do not accidentally receive your new mail | 21515 | make sure those servers do not accidentally receive your new mail |
| 21516 | (@pxref{nnmairix caveats}). A special case exists if you want to use | 21516 | (@pxref{nnmairix caveats}). A special case exists if you want to use |
| @@ -21619,7 +21619,7 @@ Just hit @kbd{TAB} to see the available servers. Currently, servers | |||
| 21619 | which are accessed through @code{nnmaildir}, @code{nnimap} and | 21619 | which are accessed through @code{nnmaildir}, @code{nnimap} and |
| 21620 | @code{nnml} are supported. As explained above, for locally stored | 21620 | @code{nnml} are supported. As explained above, for locally stored |
| 21621 | mails, this can be an existing server where you store your mails. | 21621 | mails, this can be an existing server where you store your mails. |
| 21622 | However, you can also create e.g. a new @code{nnmaildir} or @code{nnml} | 21622 | However, you can also create, e.g., a new @code{nnmaildir} or @code{nnml} |
| 21623 | server exclusively for @code{nnmairix} in your secondary select methods | 21623 | server exclusively for @code{nnmairix} in your secondary select methods |
| 21624 | (@pxref{Finding the News}). If you use a secondary @code{nnml} server | 21624 | (@pxref{Finding the News}). If you use a secondary @code{nnml} server |
| 21625 | just for mairix, make sure that you explicitly set the server variable | 21625 | just for mairix, make sure that you explicitly set the server variable |
| @@ -21632,20 +21632,20 @@ just for mairix, make sure that you explicitly set the server variable | |||
| 21632 | @vindex nnmairix-mairix-search-options | 21632 | @vindex nnmairix-mairix-search-options |
| 21633 | The @strong{command} to call the mairix binary. This will usually just | 21633 | The @strong{command} to call the mairix binary. This will usually just |
| 21634 | be @code{mairix}, but you can also choose something like @code{ssh | 21634 | be @code{mairix}, but you can also choose something like @code{ssh |
| 21635 | SERVER mairix} if you want to call mairix remotely, e.g. on your | 21635 | SERVER mairix} if you want to call mairix remotely, e.g., on your |
| 21636 | @acronym{IMAP} server. If you want to add some default options to | 21636 | @acronym{IMAP} server. If you want to add some default options to |
| 21637 | mairix, you could do this here, but better use the variable | 21637 | mairix, you could do this here, but better use the variable |
| 21638 | @code{nnmairix-mairix-search-options} instead. | 21638 | @code{nnmairix-mairix-search-options} instead. |
| 21639 | 21639 | ||
| 21640 | @item | 21640 | @item |
| 21641 | The name of the @strong{default search group}. This will be the group | 21641 | The name of the @strong{default search group}. This will be the group |
| 21642 | where all temporary mairix searches are stored, i.e. all searches which | 21642 | where all temporary mairix searches are stored, i.e., all searches which |
| 21643 | are not bound to permanent @code{nnmairix} groups. Choose whatever you | 21643 | are not bound to permanent @code{nnmairix} groups. Choose whatever you |
| 21644 | like. | 21644 | like. |
| 21645 | 21645 | ||
| 21646 | @item | 21646 | @item |
| 21647 | If the mail back end is @code{nnimap} or @code{nnmaildir}, you will be | 21647 | If the mail back end is @code{nnimap} or @code{nnmaildir}, you will be |
| 21648 | asked if you work with @strong{Maildir++}, i.e. with hidden maildir | 21648 | asked if you work with @strong{Maildir++}, i.e., with hidden maildir |
| 21649 | folders (=beginning with a dot). For example, you have to answer | 21649 | folders (=beginning with a dot). For example, you have to answer |
| 21650 | @samp{yes} here if you work with the Dovecot @acronym{IMAP} | 21650 | @samp{yes} here if you work with the Dovecot @acronym{IMAP} |
| 21651 | server. Otherwise, you should answer @samp{no} here. | 21651 | server. Otherwise, you should answer @samp{no} here. |
| @@ -21704,7 +21704,7 @@ Changes the search query for the @code{nnmairix} group under cursor | |||
| 21704 | @kindex G b t (Group) | 21704 | @kindex G b t (Group) |
| 21705 | @findex nnmairix-group-toggle-threads-this-group | 21705 | @findex nnmairix-group-toggle-threads-this-group |
| 21706 | Toggles the 'threads' parameter for the @code{nnmairix} group under cursor, | 21706 | Toggles the 'threads' parameter for the @code{nnmairix} group under cursor, |
| 21707 | i.e. if you want see the whole threads of the found messages | 21707 | i.e., if you want see the whole threads of the found messages |
| 21708 | (@code{nnmairix-group-toggle-threads-this-group}). | 21708 | (@code{nnmairix-group-toggle-threads-this-group}). |
| 21709 | 21709 | ||
| 21710 | @item G b u | 21710 | @item G b u |
| @@ -21794,8 +21794,8 @@ calling @code{nnmairix-search} with @samp{f:From}. | |||
| 21794 | @kindex $ o (Summary) | 21794 | @kindex $ o (Summary) |
| 21795 | @findex nnmairix-goto-original-article | 21795 | @findex nnmairix-goto-original-article |
| 21796 | (Only in @code{nnmairix} groups!) Tries determine the group this article | 21796 | (Only in @code{nnmairix} groups!) Tries determine the group this article |
| 21797 | originally came from and displays the article in this group, so that | 21797 | originally came from and displays the article in this group, so that, |
| 21798 | e.g. replying to this article the correct posting styles/group | 21798 | e.g., replying to this article the correct posting styles/group |
| 21799 | parameters are applied (@code{nnmairix-goto-original-article}). This | 21799 | parameters are applied (@code{nnmairix-goto-original-article}). This |
| 21800 | function will use the registry if available, but can also parse the | 21800 | function will use the registry if available, but can also parse the |
| 21801 | article file name as a fallback method. | 21801 | article file name as a fallback method. |
| @@ -21893,7 +21893,7 @@ way slower than the registry---if you set hundreds or even thousands of | |||
| 21893 | marks this way, it might take some time. You can avoid this situation by | 21893 | marks this way, it might take some time. You can avoid this situation by |
| 21894 | setting @code{nnmairix-only-use-registry} to t. | 21894 | setting @code{nnmairix-only-use-registry} to t. |
| 21895 | 21895 | ||
| 21896 | Maybe you also want to propagate marks the other way round, i.e. if you | 21896 | Maybe you also want to propagate marks the other way round, i.e., if you |
| 21897 | tick an article in a "real" mail group, you'd like to have the same | 21897 | tick an article in a "real" mail group, you'd like to have the same |
| 21898 | article in a @code{nnmairix} group ticked, too. For several good | 21898 | article in a @code{nnmairix} group ticked, too. For several good |
| 21899 | reasons, this can only be done efficiently if you use maildir. To | 21899 | reasons, this can only be done efficiently if you use maildir. To |
| @@ -21947,7 +21947,7 @@ Example: search group for ticked articles | |||
| 21947 | For example, you can create a group for all ticked articles, where the | 21947 | For example, you can create a group for all ticked articles, where the |
| 21948 | articles always stay unread: | 21948 | articles always stay unread: |
| 21949 | 21949 | ||
| 21950 | Hit @kbd{G b g}, enter group name (e.g. @samp{important}), use | 21950 | Hit @kbd{G b g}, enter group name (e.g., @samp{important}), use |
| 21951 | @samp{F:f} as query and do not include threads. | 21951 | @samp{F:f} as query and do not include threads. |
| 21952 | 21952 | ||
| 21953 | Now activate marks propagation for this group by using @kbd{G b p}. Then | 21953 | Now activate marks propagation for this group by using @kbd{G b p}. Then |
| @@ -21960,7 +21960,7 @@ tick marks from the original article. The other possibility is to set | |||
| 21960 | @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t}, but see the above | 21960 | @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t}, but see the above |
| 21961 | comments about this option. If it works for you, the tick marks should | 21961 | comments about this option. If it works for you, the tick marks should |
| 21962 | also exist in the @code{nnmairix} group and you can remove them as usual, | 21962 | also exist in the @code{nnmairix} group and you can remove them as usual, |
| 21963 | e.g. by marking an article as read. | 21963 | e.g., by marking an article as read. |
| 21964 | 21964 | ||
| 21965 | When you have removed a tick mark from the original article, this | 21965 | When you have removed a tick mark from the original article, this |
| 21966 | article should vanish from the @code{nnmairix} group after you have updated the | 21966 | article should vanish from the @code{nnmairix} group after you have updated the |
| @@ -21976,7 +21976,7 @@ the mail back end in the form @samp{zz_mairix-<NAME>-<NUMBER>}. You can | |||
| 21976 | see them when you enter the back end server in the server buffer. You | 21976 | see them when you enter the back end server in the server buffer. You |
| 21977 | should not subscribe these groups! Unfortunately, these groups will | 21977 | should not subscribe these groups! Unfortunately, these groups will |
| 21978 | usually get @emph{auto-subscribed} when you use @code{nnmaildir} or | 21978 | usually get @emph{auto-subscribed} when you use @code{nnmaildir} or |
| 21979 | @code{nnml}, i.e. you will suddenly see groups of the form | 21979 | @code{nnml}, i.e., you will suddenly see groups of the form |
| 21980 | @samp{zz_mairix*} pop up in your group buffer. If this happens to you, | 21980 | @samp{zz_mairix*} pop up in your group buffer. If this happens to you, |
| 21981 | simply kill these groups with C-k. For avoiding this, turn off | 21981 | simply kill these groups with C-k. For avoiding this, turn off |
| 21982 | auto-subscription completely by setting the variable | 21982 | auto-subscription completely by setting the variable |
| @@ -22588,7 +22588,7 @@ size spec per split. | |||
| 22588 | 22588 | ||
| 22589 | Point will be put in the buffer that has the optional third element | 22589 | Point will be put in the buffer that has the optional third element |
| 22590 | @code{point}. In a @code{frame} split, the last subsplit having a leaf | 22590 | @code{point}. In a @code{frame} split, the last subsplit having a leaf |
| 22591 | split where the tag @code{frame-focus} is a member (i.e. is the third or | 22591 | split where the tag @code{frame-focus} is a member (i.e., is the third or |
| 22592 | fourth element in the list, depending on whether the @code{point} tag is | 22592 | fourth element in the list, depending on whether the @code{point} tag is |
| 22593 | present) gets focus. | 22593 | present) gets focus. |
| 22594 | 22594 | ||
| @@ -22923,11 +22923,11 @@ quicker. | |||
| 22923 | @vindex gnus-mode-non-string-length | 22923 | @vindex gnus-mode-non-string-length |
| 22924 | By default, Gnus displays information on the current article in the mode | 22924 | By default, Gnus displays information on the current article in the mode |
| 22925 | lines of the summary and article buffers. The information Gnus wishes | 22925 | lines of the summary and article buffers. The information Gnus wishes |
| 22926 | to display (e.g. the subject of the article) is often longer than the | 22926 | to display (e.g., the subject of the article) is often longer than the |
| 22927 | mode lines, and therefore have to be cut off at some point. The | 22927 | mode lines, and therefore have to be cut off at some point. The |
| 22928 | @code{gnus-mode-non-string-length} variable says how long the other | 22928 | @code{gnus-mode-non-string-length} variable says how long the other |
| 22929 | elements on the line is (i.e., the non-info part). If you put | 22929 | elements on the line is (i.e., the non-info part). If you put |
| 22930 | additional elements on the mode line (e.g. a clock), you should modify | 22930 | additional elements on the mode line (e.g., a clock), you should modify |
| 22931 | this variable: | 22931 | this variable: |
| 22932 | 22932 | ||
| 22933 | @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it> | 22933 | @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it> |
| @@ -23947,7 +23947,7 @@ Specifiers}) follow. | |||
| 23947 | @end lisp | 23947 | @end lisp |
| 23948 | 23948 | ||
| 23949 | Once you manage to process your incoming spool somehow, thus making | 23949 | Once you manage to process your incoming spool somehow, thus making |
| 23950 | the mail contain e.g.@: a header indicating it is spam, you are ready to | 23950 | the mail contain, e.g., a header indicating it is spam, you are ready to |
| 23951 | filter it out. Using normal split methods (@pxref{Splitting Mail}): | 23951 | filter it out. Using normal split methods (@pxref{Splitting Mail}): |
| 23952 | 23952 | ||
| 23953 | @lisp | 23953 | @lisp |
| @@ -24625,7 +24625,7 @@ From Reiner Steib <reiner.steib@@gmx.de>. | |||
| 24625 | My provider has set up bogofilter (in combination with @acronym{DCC}) on | 24625 | My provider has set up bogofilter (in combination with @acronym{DCC}) on |
| 24626 | the mail server (@acronym{IMAP}). Recognized spam goes to | 24626 | the mail server (@acronym{IMAP}). Recognized spam goes to |
| 24627 | @samp{spam.detected}, the rest goes through the normal filter rules, | 24627 | @samp{spam.detected}, the rest goes through the normal filter rules, |
| 24628 | i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false | 24628 | i.e., to @samp{some.folder} or to @samp{INBOX}. Training on false |
| 24629 | positives or negatives is done by copying or moving the article to | 24629 | positives or negatives is done by copying or moving the article to |
| 24630 | @samp{training.ham} or @samp{training.spam} respectively. A cron job on | 24630 | @samp{training.ham} or @samp{training.spam} respectively. A cron job on |
| 24631 | the server feeds those to bogofilter with the suitable ham or spam | 24631 | the server feeds those to bogofilter with the suitable ham or spam |
| @@ -24650,7 +24650,7 @@ does most of the job for me: | |||
| 24650 | @item @b{The Spam folder:} | 24650 | @item @b{The Spam folder:} |
| 24651 | 24651 | ||
| 24652 | In the folder @samp{spam.detected}, I have to check for false positives | 24652 | In the folder @samp{spam.detected}, I have to check for false positives |
| 24653 | (i.e. legitimate mails, that were wrongly judged as spam by | 24653 | (i.e., legitimate mails, that were wrongly judged as spam by |
| 24654 | bogofilter or DCC). | 24654 | bogofilter or DCC). |
| 24655 | 24655 | ||
| 24656 | Because of the @code{gnus-group-spam-classification-spam} entry, all | 24656 | Because of the @code{gnus-group-spam-classification-spam} entry, all |
| @@ -24663,7 +24663,7 @@ and deleted from the @samp{spam.detected} folder. | |||
| 24663 | 24663 | ||
| 24664 | The @code{gnus-article-sort-by-chars} entry simplifies detection of | 24664 | The @code{gnus-article-sort-by-chars} entry simplifies detection of |
| 24665 | false positives for me. I receive lots of worms (sweN, @dots{}), that all | 24665 | false positives for me. I receive lots of worms (sweN, @dots{}), that all |
| 24666 | have a similar size. Grouping them by size (i.e. chars) makes finding | 24666 | have a similar size. Grouping them by size (i.e., chars) makes finding |
| 24667 | other false positives easier. (Of course worms aren't @i{spam} | 24667 | other false positives easier. (Of course worms aren't @i{spam} |
| 24668 | (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is | 24668 | (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is |
| 24669 | an excellent tool for filtering those unwanted mails for me.) | 24669 | an excellent tool for filtering those unwanted mails for me.) |
| @@ -24691,7 +24691,7 @@ groups as spam and reports the to Gmane at group exit: | |||
| 24691 | 24691 | ||
| 24692 | Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)} | 24692 | Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)} |
| 24693 | because I don't read the groups directly from news.gmane.org, but | 24693 | because I don't read the groups directly from news.gmane.org, but |
| 24694 | through my local news server (leafnode). I.e. the article numbers are | 24694 | through my local news server (leafnode). I.e., the article numbers are |
| 24695 | not the same as on news.gmane.org, thus @code{spam-report.el} has to check | 24695 | not the same as on news.gmane.org, thus @code{spam-report.el} has to check |
| 24696 | the @code{X-Report-Spam} header to find the correct number. | 24696 | the @code{X-Report-Spam} header to find the correct number. |
| 24697 | 24697 | ||
| @@ -24830,7 +24830,7 @@ messages are not assumed to be spam or ham. | |||
| 24830 | 24830 | ||
| 24831 | Set this variable to @code{t} if you want to use the BBDB as an | 24831 | Set this variable to @code{t} if you want to use the BBDB as an |
| 24832 | implicit filter, meaning that every message will be considered spam | 24832 | implicit filter, meaning that every message will be considered spam |
| 24833 | unless the sender is in the BBDB. Use with care. Only sender | 24833 | unless the sender is in the BBDB@. Use with care. Only sender |
| 24834 | addresses in the BBDB will be allowed through; all others will be | 24834 | addresses in the BBDB will be allowed through; all others will be |
| 24835 | classified as spammers. | 24835 | classified as spammers. |
| 24836 | 24836 | ||
| @@ -25294,7 +25294,7 @@ SpamOracle. | |||
| 25294 | 25294 | ||
| 25295 | @defvar spam-spamoracle-binary | 25295 | @defvar spam-spamoracle-binary |
| 25296 | Gnus uses the SpamOracle binary called @file{spamoracle} found in the | 25296 | Gnus uses the SpamOracle binary called @file{spamoracle} found in the |
| 25297 | user's PATH. Using the variable @code{spam-spamoracle-binary}, this | 25297 | user's PATH@. Using the variable @code{spam-spamoracle-binary}, this |
| 25298 | can be customized. | 25298 | can be customized. |
| 25299 | @end defvar | 25299 | @end defvar |
| 25300 | 25300 | ||
| @@ -25359,7 +25359,7 @@ messages. | |||
| 25359 | @end example | 25359 | @end example |
| 25360 | For this group the @code{spam-use-spamoracle} is installed for both | 25360 | For this group the @code{spam-use-spamoracle} is installed for both |
| 25361 | ham and spam processing. If the group contains spam message | 25361 | ham and spam processing. If the group contains spam message |
| 25362 | (e.g. because SpamOracle has not had enough sample messages yet) and | 25362 | (e.g., because SpamOracle has not had enough sample messages yet) and |
| 25363 | the user marks some messages as spam messages, these messages will be | 25363 | the user marks some messages as spam messages, these messages will be |
| 25364 | processed by SpamOracle. The processor sends the messages to | 25364 | processed by SpamOracle. The processor sends the messages to |
| 25365 | SpamOracle as new samples for spam. | 25365 | SpamOracle as new samples for spam. |
| @@ -25805,7 +25805,7 @@ of said features in case your attention span is... never mind. | |||
| 25805 | Split messages to their parent | 25805 | Split messages to their parent |
| 25806 | 25806 | ||
| 25807 | This keeps discussions in the same group. You can use the subject and | 25807 | This keeps discussions in the same group. You can use the subject and |
| 25808 | the sender in addition to the Message-ID. Several strategies are | 25808 | the sender in addition to the Message-ID@. Several strategies are |
| 25809 | available. | 25809 | available. |
| 25810 | 25810 | ||
| 25811 | @item | 25811 | @item |
| @@ -26507,7 +26507,7 @@ Message Mode is able to request notifications from the receiver. | |||
| 26507 | @cindex RFC 1991 | 26507 | @cindex RFC 1991 |
| 26508 | @cindex RFC 2440 | 26508 | @cindex RFC 2440 |
| 26509 | RFC 1991 is the original @acronym{PGP} message specification, | 26509 | RFC 1991 is the original @acronym{PGP} message specification, |
| 26510 | published as an informational RFC. RFC 2440 was the follow-up, now | 26510 | published as an informational RFC@. RFC 2440 was the follow-up, now |
| 26511 | called Open PGP, and put on the Standards Track. Both document a | 26511 | called Open PGP, and put on the Standards Track. Both document a |
| 26512 | non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both | 26512 | non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both |
| 26513 | encoding (signing and encryption) and decoding (verification and | 26513 | encoding (signing and encryption) and decoding (verification and |
| @@ -27480,7 +27480,7 @@ group, which is created automatically. | |||
| 27480 | values. | 27480 | values. |
| 27481 | 27481 | ||
| 27482 | @item | 27482 | @item |
| 27483 | @code{gnus-summary-goto-article} now accept Message-ID's. | 27483 | @code{gnus-summary-goto-article} now accept Message-IDs. |
| 27484 | 27484 | ||
| 27485 | @item | 27485 | @item |
| 27486 | A new Message command for deleting text in the body of a message | 27486 | A new Message command for deleting text in the body of a message |
| @@ -28234,7 +28234,7 @@ The nnml and nnfolder back ends store marks for each groups. | |||
| 28234 | This makes it possible to take backup of nnml/nnfolder servers/groups | 28234 | This makes it possible to take backup of nnml/nnfolder servers/groups |
| 28235 | separately of @file{~/.newsrc.eld}, while preserving marks. It also | 28235 | separately of @file{~/.newsrc.eld}, while preserving marks. It also |
| 28236 | makes it possible to share articles and marks between users (without | 28236 | makes it possible to share articles and marks between users (without |
| 28237 | sharing the @file{~/.newsrc.eld} file) within e.g. a department. It | 28237 | sharing the @file{~/.newsrc.eld} file) within, e.g., a department. It |
| 28238 | works by storing the marks stored in @file{~/.newsrc.eld} in a per-group | 28238 | works by storing the marks stored in @file{~/.newsrc.eld} in a per-group |
| 28239 | file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for | 28239 | file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for |
| 28240 | nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to | 28240 | nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to |
| @@ -28937,10 +28937,10 @@ can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are | |||
| 28937 | slow, and then try to analyze the backtrace (repeating the procedure | 28937 | slow, and then try to analyze the backtrace (repeating the procedure |
| 28938 | helps isolating the real problem areas). | 28938 | helps isolating the real problem areas). |
| 28939 | 28939 | ||
| 28940 | A fancier approach is to use the elisp profiler, ELP. The profiler is | 28940 | A fancier approach is to use the elisp profiler, ELP@. The profiler is |
| 28941 | (or should be) fully documented elsewhere, but to get you started | 28941 | (or should be) fully documented elsewhere, but to get you started |
| 28942 | there are a few steps that need to be followed. First, instrument the | 28942 | there are a few steps that need to be followed. First, instrument the |
| 28943 | part of Gnus you are interested in for profiling, e.g. @kbd{M-x | 28943 | part of Gnus you are interested in for profiling, e.g., @kbd{M-x |
| 28944 | elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package | 28944 | elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package |
| 28945 | RET message}. Then perform the operation that is slow and press | 28945 | RET message}. Then perform the operation that is slow and press |
| 28946 | @kbd{M-x elp-results}. You will then see which operations that takes | 28946 | @kbd{M-x elp-results}. You will then see which operations that takes |
diff --git a/doc/misc/idlwave.texi b/doc/misc/idlwave.texi index feef325ad30..436fa28b1fb 100644 --- a/doc/misc/idlwave.texi +++ b/doc/misc/idlwave.texi | |||
| @@ -382,7 +382,7 @@ at point. | |||
| 382 | @section Lesson I: Development Cycle | 382 | @section Lesson I: Development Cycle |
| 383 | 383 | ||
| 384 | The purpose of this tutorial is to guide you through a very basic | 384 | The purpose of this tutorial is to guide you through a very basic |
| 385 | development cycle using IDLWAVE. We will paste a simple program into | 385 | development cycle using IDLWAVE@. We will paste a simple program into |
| 386 | a buffer and use the shell to compile, debug and run it. On the way | 386 | a buffer and use the shell to compile, debug and run it. On the way |
| 387 | we will use many of the important IDLWAVE commands. Note, however, | 387 | we will use many of the important IDLWAVE commands. Note, however, |
| 388 | that IDLWAVE has many more capabilities than covered here, which can | 388 | that IDLWAVE has many more capabilities than covered here, which can |
| @@ -444,7 +444,7 @@ buffer with @kbd{C-x h}, and indent the whole region with | |||
| 444 | highlighted in different colors, if you have set up support for | 444 | highlighted in different colors, if you have set up support for |
| 445 | font-lock. | 445 | font-lock. |
| 446 | 446 | ||
| 447 | Let's check out two particular editing features of IDLWAVE. Place the | 447 | Let's check out two particular editing features of IDLWAVE@. Place the |
| 448 | cursor after the @code{end} statement of the @code{for} loop and press | 448 | cursor after the @code{end} statement of the @code{for} loop and press |
| 449 | @key{SPC}. IDLWAVE blinks back to the beginning of the block and | 449 | @key{SPC}. IDLWAVE blinks back to the beginning of the block and |
| 450 | changes the generic @code{end} to the specific @code{endfor} | 450 | changes the generic @code{end} to the specific @code{endfor} |
| @@ -464,7 +464,7 @@ First, let's launch the IDLWAVE shell. You do this with the command | |||
| 464 | @kbd{C-c C-s}. The Emacs window will split or another window will popup | 464 | @kbd{C-c C-s}. The Emacs window will split or another window will popup |
| 465 | to display IDL running in a shell interaction buffer. Type a few | 465 | to display IDL running in a shell interaction buffer. Type a few |
| 466 | commands like @code{print,!PI} to convince yourself that you can work | 466 | commands like @code{print,!PI} to convince yourself that you can work |
| 467 | there just as well as in a terminal, or the IDLDE. Use the arrow keys | 467 | there just as well as in a terminal, or the IDLDE@. Use the arrow keys |
| 468 | to cycle through your command history. Are we having fun now? | 468 | to cycle through your command history. Are we having fun now? |
| 469 | 469 | ||
| 470 | Now go back to the source window and type @kbd{C-c C-d C-c} to compile | 470 | Now go back to the source window and type @kbd{C-c C-d C-c} to compile |
| @@ -602,7 +602,7 @@ there is another, more user-friendly way to customize all the IDLWAVE | |||
| 602 | variables. You can access it through the IDLWAVE menu in one of the | 602 | variables. You can access it through the IDLWAVE menu in one of the |
| 603 | @file{.pro} buffers, menu item @code{Customize->Browse IDLWAVE | 603 | @file{.pro} buffers, menu item @code{Customize->Browse IDLWAVE |
| 604 | Group}. Here you'll be presented with all the various variables grouped | 604 | Group}. Here you'll be presented with all the various variables grouped |
| 605 | into categories. You can navigate the hierarchy (e.g. @samp{IDLWAVE | 605 | into categories. You can navigate the hierarchy (e.g., @samp{IDLWAVE |
| 606 | Code Formatting->Idlwave Abbrev And Indent Action->Idlwave Expand | 606 | Code Formatting->Idlwave Abbrev And Indent Action->Idlwave Expand |
| 607 | Generic End} to turn on @code{END} expansion), read about the variables, | 607 | Generic End} to turn on @code{END} expansion), read about the variables, |
| 608 | change them, and `Save for Future Sessions'. Few of these variables | 608 | change them, and `Save for Future Sessions'. Few of these variables |
| @@ -691,7 +691,7 @@ go for a cup of coffee while IDLWAVE collects information for each and | |||
| 691 | every IDL routine on your search path. All this information is | 691 | every IDL routine on your search path. All this information is |
| 692 | written to the file @file{.idlwave/idlusercat.el} in your home | 692 | written to the file @file{.idlwave/idlusercat.el} in your home |
| 693 | directory and will from now on automatically load whenever you use | 693 | directory and will from now on automatically load whenever you use |
| 694 | IDLWAVE. You may find it necessary to rebuild the catalog on occasion | 694 | IDLWAVE@. You may find it necessary to rebuild the catalog on occasion |
| 695 | as your local libraries change, or build a library catalog for those | 695 | as your local libraries change, or build a library catalog for those |
| 696 | directories instead. Invoke routine info (@kbd{C-c ?}) or completion | 696 | directories instead. Invoke routine info (@kbd{C-c ?}) or completion |
| 697 | (@kbd{M-@key{TAB}}) on any routine or partial routine name you know to | 697 | (@kbd{M-@key{TAB}}) on any routine or partial routine name you know to |
| @@ -715,7 +715,7 @@ Usage: Result = READFITS(filename, header, heap) | |||
| 715 | ... | 715 | ... |
| 716 | @end example | 716 | @end example |
| 717 | 717 | ||
| 718 | I hope you made it until here. Now you are set to work with IDLWAVE. | 718 | I hope you made it until here. Now you are set to work with IDLWAVE@. |
| 719 | On the way you will want to change other things, and to learn more | 719 | On the way you will want to change other things, and to learn more |
| 720 | about the possibilities not discussed in this short tutorial. Read | 720 | about the possibilities not discussed in this short tutorial. Read |
| 721 | the manual, look at the documentation strings of interesting variables | 721 | the manual, look at the documentation strings of interesting variables |
| @@ -789,7 +789,7 @@ continuation lines. | |||
| 789 | @cindex Foreign code, adapting | 789 | @cindex Foreign code, adapting |
| 790 | @cindex Indentation, of foreign code | 790 | @cindex Indentation, of foreign code |
| 791 | @kindex C-M-\ | 791 | @kindex C-M-\ |
| 792 | To re-indent a larger portion of code (e.g. when working with foreign | 792 | To re-indent a larger portion of code (e.g., when working with foreign |
| 793 | code written with different conventions), use @kbd{C-M-\} | 793 | code written with different conventions), use @kbd{C-M-\} |
| 794 | (@code{indent-region}) after marking the relevant code. Useful marking | 794 | (@code{indent-region}) after marking the relevant code. Useful marking |
| 795 | commands are @kbd{C-x h} (the entire file) or @kbd{C-M-h} (the current | 795 | commands are @kbd{C-x h} (the entire file) or @kbd{C-M-h} (the current |
| @@ -1057,7 +1057,7 @@ altogether, and use the more sensible alternative IDL provides: | |||
| 1057 | @end example | 1057 | @end example |
| 1058 | 1058 | ||
| 1059 | @noindent This simultaneously solves the font-lock problem and is more | 1059 | @noindent This simultaneously solves the font-lock problem and is more |
| 1060 | consistent with the notation for hexadecimal numbers, e.g. @code{'C5'XB}. | 1060 | consistent with the notation for hexadecimal numbers, e.g., @code{'C5'XB}. |
| 1061 | 1061 | ||
| 1062 | @node Routine Info, Online Help, Code Formatting, The IDLWAVE Major Mode | 1062 | @node Routine Info, Online Help, Code Formatting, The IDLWAVE Major Mode |
| 1063 | @section Routine Info | 1063 | @section Routine Info |
| @@ -1111,7 +1111,7 @@ method exists in several classes, IDLWAVE queries for the class of the | |||
| 1111 | object, unless the class is already known through a text property on the | 1111 | object, unless the class is already known through a text property on the |
| 1112 | @samp{->} operator (@pxref{Object Method Completion and Class | 1112 | @samp{->} operator (@pxref{Object Method Completion and Class |
| 1113 | Ambiguity}), or by having been explicitly included in the call | 1113 | Ambiguity}), or by having been explicitly included in the call |
| 1114 | (e.g. @code{a->myclass::Foo}). | 1114 | (e.g., @code{a->myclass::Foo}). |
| 1115 | 1115 | ||
| 1116 | @cindex Calling sequences | 1116 | @cindex Calling sequences |
| 1117 | @cindex Keywords of a routine | 1117 | @cindex Keywords of a routine |
| @@ -1168,7 +1168,7 @@ will automatically split into the next two. | |||
| 1168 | 1168 | ||
| 1169 | Any routines discovered in library catalogs (@pxref{Library | 1169 | Any routines discovered in library catalogs (@pxref{Library |
| 1170 | Catalogs}), will display the category assigned during creation, | 1170 | Catalogs}), will display the category assigned during creation, |
| 1171 | e.g. @samp{NasaLib}. For routines not discovered in this way, you can | 1171 | e.g., @samp{NasaLib}. For routines not discovered in this way, you can |
| 1172 | create additional categories based on the routine's filename using the | 1172 | create additional categories based on the routine's filename using the |
| 1173 | variable @code{idlwave-special-lib-alist}. | 1173 | variable @code{idlwave-special-lib-alist}. |
| 1174 | 1174 | ||
| @@ -1248,12 +1248,12 @@ Maximum number of source files displayed in the Routine Info window. | |||
| 1248 | @cindex Speed, of online help | 1248 | @cindex Speed, of online help |
| 1249 | @cindex XML Help Catalog | 1249 | @cindex XML Help Catalog |
| 1250 | 1250 | ||
| 1251 | For IDL system routines, extensive documentation is supplied with IDL. | 1251 | For IDL system routines, extensive documentation is supplied with IDL@. |
| 1252 | IDLWAVE can access the HTML version of this documentation very quickly | 1252 | IDLWAVE can access the HTML version of this documentation very quickly |
| 1253 | and accurately, based on the local context. This can be @emph{much} | 1253 | and accurately, based on the local context. This can be @emph{much} |
| 1254 | faster than using the IDL online help application, because IDLWAVE | 1254 | faster than using the IDL online help application, because IDLWAVE |
| 1255 | usually gets you to the right place in the documentation directly --- | 1255 | usually gets you to the right place in the documentation directly --- |
| 1256 | e.g. a specific keyword of a routine --- without any additional browsing | 1256 | e.g., a specific keyword of a routine --- without any additional browsing |
| 1257 | and scrolling. | 1257 | and scrolling. |
| 1258 | 1258 | ||
| 1259 | For this online help to work, an HTML version of the IDL documentation | 1259 | For this online help to work, an HTML version of the IDL documentation |
| @@ -1331,7 +1331,7 @@ When using completion and Emacs pops up a @file{*Completions*} buffer | |||
| 1331 | with possible completions, clicking with @kbd{Mouse-3} on a completion | 1331 | with possible completions, clicking with @kbd{Mouse-3} on a completion |
| 1332 | item invokes help on that item (@pxref{Completion}). Items for which | 1332 | item invokes help on that item (@pxref{Completion}). Items for which |
| 1333 | help is available in the online system documentation (vs. just the | 1333 | help is available in the online system documentation (vs. just the |
| 1334 | program source itself) will be emphasized (e.g. colored blue). | 1334 | program source itself) will be emphasized (e.g., colored blue). |
| 1335 | @end itemize | 1335 | @end itemize |
| 1336 | @noindent | 1336 | @noindent |
| 1337 | In both cases, a blue face indicates that the item is documented in | 1337 | In both cases, a blue face indicates that the item is documented in |
| @@ -1501,7 +1501,7 @@ displaying source file. | |||
| 1501 | 1501 | ||
| 1502 | @defopt idlwave-help-doclib-name (@code{"name"}) | 1502 | @defopt idlwave-help-doclib-name (@code{"name"}) |
| 1503 | The case-insensitive heading word in doclib headers to locate the | 1503 | The case-insensitive heading word in doclib headers to locate the |
| 1504 | @emph{name} section. Can be a regexp, e.g. @code{"\\(name\\|nom\\)"}. | 1504 | @emph{name} section. Can be a regexp, e.g., @code{"\\(name\\|nom\\)"}. |
| 1505 | @end defopt | 1505 | @end defopt |
| 1506 | 1506 | ||
| 1507 | @defopt idlwave-help-doclib-keyword (@code{"KEYWORD"}) | 1507 | @defopt idlwave-help-doclib-keyword (@code{"KEYWORD"}) |
| @@ -1576,7 +1576,7 @@ If the list of completions is too long to fit in the | |||
| 1576 | @kbd{M-@key{TAB}} repeatedly. Online help (if installed) for each | 1576 | @kbd{M-@key{TAB}} repeatedly. Online help (if installed) for each |
| 1577 | possible completion is available by clicking with @kbd{Mouse-3} on the | 1577 | possible completion is available by clicking with @kbd{Mouse-3} on the |
| 1578 | item. Items for which system online help (from the IDL manual) is | 1578 | item. Items for which system online help (from the IDL manual) is |
| 1579 | available will be emphasized (e.g. colored blue). For other items, the | 1579 | available will be emphasized (e.g., colored blue). For other items, the |
| 1580 | corresponding source code or DocLib header will be used as the help | 1580 | corresponding source code or DocLib header will be used as the help |
| 1581 | text. | 1581 | text. |
| 1582 | 1582 | ||
| @@ -1681,14 +1681,14 @@ narrow down the number of possible completions. The variable | |||
| 1681 | @code{idlwave-query-class} can be configured to make such prompting the | 1681 | @code{idlwave-query-class} can be configured to make such prompting the |
| 1682 | default for all methods (not recommended), or selectively for very | 1682 | default for all methods (not recommended), or selectively for very |
| 1683 | common methods for which the number of completing keywords would be too | 1683 | common methods for which the number of completing keywords would be too |
| 1684 | large (e.g. @code{Init,SetProperty,GetProperty}). | 1684 | large (e.g., @code{Init,SetProperty,GetProperty}). |
| 1685 | 1685 | ||
| 1686 | @cindex Saving object class on @code{->} | 1686 | @cindex Saving object class on @code{->} |
| 1687 | @cindex @code{->} | 1687 | @cindex @code{->} |
| 1688 | After you have specified the class for a particular statement (e.g. when | 1688 | After you have specified the class for a particular statement (e.g., when |
| 1689 | completing the method), IDLWAVE can remember it for the rest of the | 1689 | completing the method), IDLWAVE can remember it for the rest of the |
| 1690 | editing session. Subsequent completions in the same statement | 1690 | editing session. Subsequent completions in the same statement |
| 1691 | (e.g. keywords) can then reuse this class information. This works by | 1691 | (e.g., keywords) can then reuse this class information. This works by |
| 1692 | placing a text property on the method invocation operator @samp{->}, | 1692 | placing a text property on the method invocation operator @samp{->}, |
| 1693 | after which the operator will be shown in a different face (bold by | 1693 | after which the operator will be shown in a different face (bold by |
| 1694 | default). The variable @code{idlwave-store-inquired-class} can be used | 1694 | default). The variable @code{idlwave-store-inquired-class} can be used |
| @@ -1737,7 +1737,7 @@ be used (as in the buffer). | |||
| 1737 | @cindex Keyword inheritance | 1737 | @cindex Keyword inheritance |
| 1738 | @cindex Inheritance, keyword | 1738 | @cindex Inheritance, keyword |
| 1739 | 1739 | ||
| 1740 | Class inheritance affects which methods are called in IDL. An object of | 1740 | Class inheritance affects which methods are called in IDL@. An object of |
| 1741 | a class which inherits methods from one or more superclasses can | 1741 | a class which inherits methods from one or more superclasses can |
| 1742 | override that method by defining its own method of the same name, extend | 1742 | override that method by defining its own method of the same name, extend |
| 1743 | the method by calling the method(s) of its superclass(es) in its | 1743 | the method by calling the method(s) of its superclass(es) in its |
| @@ -1783,7 +1783,7 @@ class-driven keyword inheritance will be used for Completion. | |||
| 1783 | @cindex Structure tag completion | 1783 | @cindex Structure tag completion |
| 1784 | 1784 | ||
| 1785 | In many programs, especially those involving widgets, large structures | 1785 | In many programs, especially those involving widgets, large structures |
| 1786 | (e.g. the @samp{state} structure) are used to communicate among | 1786 | (e.g., the @samp{state} structure) are used to communicate among |
| 1787 | routines. It is very convenient to be able to complete structure tags, | 1787 | routines. It is very convenient to be able to complete structure tags, |
| 1788 | in the same way as for instance variables (tags) of the @samp{self} | 1788 | in the same way as for instance variables (tags) of the @samp{self} |
| 1789 | object (@pxref{Object Method Completion and Class Ambiguity}). Add-in | 1789 | object (@pxref{Object Method Completion and Class Ambiguity}). Add-in |
| @@ -1795,7 +1795,7 @@ specific assumption: the exact same variable name is used to refer to | |||
| 1795 | the structure in all parts of the program. This is entirely unenforced | 1795 | the structure in all parts of the program. This is entirely unenforced |
| 1796 | by the IDL language, but is a typical convention. If you consistently | 1796 | by the IDL language, but is a typical convention. If you consistently |
| 1797 | refer to the same structure with the same variable name | 1797 | refer to the same structure with the same variable name |
| 1798 | (e.g. @samp{state}), structure tags which are read from its definition | 1798 | (e.g., @samp{state}), structure tags which are read from its definition |
| 1799 | in the same file can be used for completion. | 1799 | in the same file can be used for completion. |
| 1800 | 1800 | ||
| 1801 | Structure tag completion is not enabled by default. To enable it, | 1801 | Structure tag completion is not enabled by default. To enable it, |
| @@ -2070,7 +2070,7 @@ abbreviation strings. | |||
| 2070 | @end defopt | 2070 | @end defopt |
| 2071 | 2071 | ||
| 2072 | @defopt idlwave-abbrev-move (@code{t}) | 2072 | @defopt idlwave-abbrev-move (@code{t}) |
| 2073 | Non-@code{nil} means the abbrev hook can move point, e.g. to end up | 2073 | Non-@code{nil} means the abbrev hook can move point, e.g., to end up |
| 2074 | between the parentheses of a function call. | 2074 | between the parentheses of a function call. |
| 2075 | @end defopt | 2075 | @end defopt |
| 2076 | 2076 | ||
| @@ -2103,7 +2103,7 @@ must be non-@code{nil}. | |||
| 2103 | @item | 2103 | @item |
| 2104 | @cindex Foreign code, adapting | 2104 | @cindex Foreign code, adapting |
| 2105 | @cindex Actions, applied to foreign code | 2105 | @cindex Actions, applied to foreign code |
| 2106 | Actions can also be applied to a larger piece of code, e.g. to convert | 2106 | Actions can also be applied to a larger piece of code, e.g., to convert |
| 2107 | foreign code to your own style. To do this, mark the relevant part of | 2107 | foreign code to your own style. To do this, mark the relevant part of |
| 2108 | the code and execute @kbd{M-x expand-region-abbrevs}. Useful marking | 2108 | the code and execute @kbd{M-x expand-region-abbrevs}. Useful marking |
| 2109 | commands are @kbd{C-x h} (the entire file) or @kbd{C-M-h} (the current | 2109 | commands are @kbd{C-x h} (the entire file) or @kbd{C-M-h} (the current |
| @@ -2185,7 +2185,7 @@ operators (outside of strings and comments, of course), try this in | |||
| 2185 | Note that the modified assignment operators which begin with a word | 2185 | Note that the modified assignment operators which begin with a word |
| 2186 | (@samp{AND=}, @samp{OR=}, @samp{NOT=}, etc.) require a leading space to | 2186 | (@samp{AND=}, @samp{OR=}, @samp{NOT=}, etc.) require a leading space to |
| 2187 | be recognized (e.g @code{vAND=4} would be interpreted as a variable | 2187 | be recognized (e.g @code{vAND=4} would be interpreted as a variable |
| 2188 | @code{vAND}). Also note that, since e.g., @code{>} and @code{>=} are | 2188 | @code{vAND}). Also note that since, e.g., @code{>} and @code{>=} are |
| 2189 | both valid operators, it is impossible to surround both by blanks while | 2189 | both valid operators, it is impossible to surround both by blanks while |
| 2190 | they are being typed. Similarly with @code{&} and @code{&&}. For | 2190 | they are being typed. Similarly with @code{&} and @code{&&}. For |
| 2191 | these, a compromise is made: the padding is placed on the left, and if | 2191 | these, a compromise is made: the padding is placed on the left, and if |
| @@ -2605,13 +2605,13 @@ Size of IDL graphics windows popped up by special IDLWAVE command. | |||
| 2605 | @cindex Spells, magic | 2605 | @cindex Spells, magic |
| 2606 | IDLWAVE works in line input mode: You compose a full command line, using | 2606 | IDLWAVE works in line input mode: You compose a full command line, using |
| 2607 | all the power Emacs gives you to do this. When you press @key{RET}, the | 2607 | all the power Emacs gives you to do this. When you press @key{RET}, the |
| 2608 | whole line is sent to IDL. Sometimes it is necessary to send single | 2608 | whole line is sent to IDL@. Sometimes it is necessary to send single |
| 2609 | characters (without a newline), for example when an IDL program is | 2609 | characters (without a newline), for example when an IDL program is |
| 2610 | waiting for single character input with the @code{GET_KBRD} function. | 2610 | waiting for single character input with the @code{GET_KBRD} function. |
| 2611 | You can send a single character to IDL with the command @kbd{C-c C-x} | 2611 | You can send a single character to IDL with the command @kbd{C-c C-x} |
| 2612 | (@code{idlwave-shell-send-char}). When you press @kbd{C-c C-y} | 2612 | (@code{idlwave-shell-send-char}). When you press @kbd{C-c C-y} |
| 2613 | (@code{idlwave-shell-char-mode-loop}), IDLWAVE runs a blocking loop | 2613 | (@code{idlwave-shell-char-mode-loop}), IDLWAVE runs a blocking loop |
| 2614 | which accepts characters and immediately sends them to IDL. The loop | 2614 | which accepts characters and immediately sends them to IDL@. The loop |
| 2615 | can be exited with @kbd{C-g}. It terminates also automatically when the | 2615 | can be exited with @kbd{C-g}. It terminates also automatically when the |
| 2616 | current IDL command is finished. Check the documentation of the two | 2616 | current IDL command is finished. Check the documentation of the two |
| 2617 | variables described below for a way to make IDL programs trigger | 2617 | variables described below for a way to make IDL programs trigger |
| @@ -2745,7 +2745,7 @@ example, if you include in @file{.emacs}: | |||
| 2745 | @end lisp | 2745 | @end lisp |
| 2746 | 2746 | ||
| 2747 | @noindent a breakpoint can then be set by pressing @kbd{b} while holding down | 2747 | @noindent a breakpoint can then be set by pressing @kbd{b} while holding down |
| 2748 | @kbd{shift} and @kbd{control} keys, i.e. @kbd{C-S-b}. Compiling a | 2748 | @kbd{shift} and @kbd{control} keys, i.e., @kbd{C-S-b}. Compiling a |
| 2749 | source file will be on @kbd{C-S-c}, deleting a breakpoint @kbd{C-S-d}, | 2749 | source file will be on @kbd{C-S-c}, deleting a breakpoint @kbd{C-S-d}, |
| 2750 | etc. In the remainder of this chapter we will assume that the | 2750 | etc. In the remainder of this chapter we will assume that the |
| 2751 | @kbd{C-c C-d} bindings are active, but each of these bindings will | 2751 | @kbd{C-c C-d} bindings are active, but each of these bindings will |
| @@ -2783,11 +2783,11 @@ more of @code{control}, @code{meta}, @code{super}, @code{hyper}, | |||
| 2783 | IDLWAVE helps you set breakpoints and step through code. Setting a | 2783 | IDLWAVE helps you set breakpoints and step through code. Setting a |
| 2784 | breakpoint in the current line of the source buffer is accomplished | 2784 | breakpoint in the current line of the source buffer is accomplished |
| 2785 | with @kbd{C-c C-d C-b} (@code{idlwave-shell-break-here}). With a | 2785 | with @kbd{C-c C-d C-b} (@code{idlwave-shell-break-here}). With a |
| 2786 | prefix arg of 1 (i.e. @kbd{C-1 C-c C-d C-b}), the breakpoint gets a | 2786 | prefix arg of 1 (i.e., @kbd{C-1 C-c C-d C-b}), the breakpoint gets a |
| 2787 | @code{/ONCE} keyword, meaning that it will be deleted after first use. | 2787 | @code{/ONCE} keyword, meaning that it will be deleted after first use. |
| 2788 | With a numeric prefix greater than one (e.g. @kbd{C-4 C-c C-d C-b}), | 2788 | With a numeric prefix greater than one (e.g., @kbd{C-4 C-c C-d C-b}), |
| 2789 | the breakpoint will only be active the @code{nth} time it is hit. | 2789 | the breakpoint will only be active the @code{nth} time it is hit. |
| 2790 | With a single non-numeric prefix (i.e. @kbd{C-u C-c C-d C-b}), prompt | 2790 | With a single non-numeric prefix (i.e., @kbd{C-u C-c C-d C-b}), prompt |
| 2791 | for a condition --- an IDL expression to be evaluated and trigger the | 2791 | for a condition --- an IDL expression to be evaluated and trigger the |
| 2792 | breakpoint only if true. To clear the breakpoint in the current line, | 2792 | breakpoint only if true. To clear the breakpoint in the current line, |
| 2793 | use @kbd{C-c C-d C-d} (@code{idlwave-clear-current-bp}). When | 2793 | use @kbd{C-c C-d C-d} (@code{idlwave-clear-current-bp}). When |
| @@ -3042,7 +3042,7 @@ with shortcut of examine type. | |||
| 3042 | 3042 | ||
| 3043 | Most single-character electric debug bindings use the final keystroke | 3043 | Most single-character electric debug bindings use the final keystroke |
| 3044 | of the equivalent multiple key commands (which are of course also | 3044 | of the equivalent multiple key commands (which are of course also |
| 3045 | still available), but some differ (e.g. @kbd{e},@kbd{t},@kbd{q},@kbd{x}). | 3045 | still available), but some differ (e.g., @kbd{e},@kbd{t},@kbd{q},@kbd{x}). |
| 3046 | Some have additional convenience bindings (like @kbd{@key{SPACE}} for | 3046 | Some have additional convenience bindings (like @kbd{@key{SPACE}} for |
| 3047 | stepping). All prefix and other argument options described in this | 3047 | stepping). All prefix and other argument options described in this |
| 3048 | section for the commands invoked by electric debug bindings are still | 3048 | section for the commands invoked by electric debug bindings are still |
| @@ -3106,7 +3106,7 @@ window, but is useful for immediate stepping, etc. | |||
| 3106 | @cindex Mouse binding to print expressions | 3106 | @cindex Mouse binding to print expressions |
| 3107 | 3107 | ||
| 3108 | @kindex C-c C-d C-p | 3108 | @kindex C-c C-d C-p |
| 3109 | Do you find yourself repeatedly typing, e.g. @code{print,n_elements(x)}, | 3109 | Do you find yourself repeatedly typing, e.g., @code{print,n_elements(x)}, |
| 3110 | and similar statements to remind yourself of the | 3110 | and similar statements to remind yourself of the |
| 3111 | type/size/structure/value/etc. of variables and expressions in your code | 3111 | type/size/structure/value/etc. of variables and expressions in your code |
| 3112 | or at the command line? IDLWAVE has a suite of special commands to | 3112 | or at the command line? IDLWAVE has a suite of special commands to |
| @@ -3149,7 +3149,7 @@ print, only an initial portion of long arrays will be printed, up to | |||
| 3149 | For added speed and convenience, there are mouse bindings which allow | 3149 | For added speed and convenience, there are mouse bindings which allow |
| 3150 | you to click on expressions and examine their values. Use | 3150 | you to click on expressions and examine their values. Use |
| 3151 | @kbd{S-Mouse-2} to print an expression and @kbd{C-M-Mouse-2} to invoke | 3151 | @kbd{S-Mouse-2} to print an expression and @kbd{C-M-Mouse-2} to invoke |
| 3152 | help (i.e. you need to hold down @key{META} and @key{CONTROL} while | 3152 | help (i.e., you need to hold down @key{META} and @key{CONTROL} while |
| 3153 | clicking with the middle mouse button). If you simply click, the | 3153 | clicking with the middle mouse button). If you simply click, the |
| 3154 | nearest expression will be selected in the same manner as described | 3154 | nearest expression will be selected in the same manner as described |
| 3155 | above. You can also @emph{drag} the mouse in order to highlight | 3155 | above. You can also @emph{drag} the mouse in order to highlight |
| @@ -3177,7 +3177,7 @@ with a @samp{( )} will be interpreted as function calls. | |||
| 3177 | @cindex ROUTINE_NAMES, IDL procedure | 3177 | @cindex ROUTINE_NAMES, IDL procedure |
| 3178 | N.B.: printing values of expressions on higher levels of the calling | 3178 | N.B.: printing values of expressions on higher levels of the calling |
| 3179 | stack uses the @emph{unsupported} IDL routine @code{ROUTINE_NAMES}, | 3179 | stack uses the @emph{unsupported} IDL routine @code{ROUTINE_NAMES}, |
| 3180 | which may or may not be available in future versions of IDL. Caveat | 3180 | which may or may not be available in future versions of IDL@. Caveat |
| 3181 | Examinor. | 3181 | Examinor. |
| 3182 | @end itemize | 3182 | @end itemize |
| 3183 | 3183 | ||
| @@ -3503,7 +3503,7 @@ extending the internal built-in information available for IDL system | |||
| 3503 | routines (@pxref{Routine Info}) to other source collections. | 3503 | routines (@pxref{Routine Info}) to other source collections. |
| 3504 | 3504 | ||
| 3505 | Starting with version 5.0, there are two types of catalogs available | 3505 | Starting with version 5.0, there are two types of catalogs available |
| 3506 | with IDLWAVE. The traditional @emph{user catalog} and the newer | 3506 | with IDLWAVE@. The traditional @emph{user catalog} and the newer |
| 3507 | @emph{library catalogs}. Although they can be used interchangeably, the | 3507 | @emph{library catalogs}. Although they can be used interchangeably, the |
| 3508 | library catalogs are more flexible, and preferred. There are few | 3508 | library catalogs are more flexible, and preferred. There are few |
| 3509 | occasions when a user catalog might be preferred --- read below. Both | 3509 | occasions when a user catalog might be preferred --- read below. Both |
| @@ -3513,7 +3513,7 @@ To facilitate the catalog systems, IDLWAVE stores information it gathers | |||
| 3513 | from the shell about the IDL search paths, and can write this | 3513 | from the shell about the IDL search paths, and can write this |
| 3514 | information out automatically, or on-demand (menu @code{Debug->Save Path | 3514 | information out automatically, or on-demand (menu @code{Debug->Save Path |
| 3515 | Info}). On systems with no shell from which to discover the path | 3515 | Info}). On systems with no shell from which to discover the path |
| 3516 | information (e.g. Windows), a library path must be specified in | 3516 | information (e.g., Windows), a library path must be specified in |
| 3517 | @code{idlwave-library-path} to allow library catalogs to be located, and | 3517 | @code{idlwave-library-path} to allow library catalogs to be located, and |
| 3518 | to setup directories for user catalog scan (@pxref{User Catalog} for | 3518 | to setup directories for user catalog scan (@pxref{User Catalog} for |
| 3519 | more on this variable). Note that, before the shell is running, IDLWAVE | 3519 | more on this variable). Note that, before the shell is running, IDLWAVE |
| @@ -3530,12 +3530,12 @@ to locate library catalogs. | |||
| 3530 | @end defopt | 3530 | @end defopt |
| 3531 | 3531 | ||
| 3532 | @defopt idlwave-library-path | 3532 | @defopt idlwave-library-path |
| 3533 | IDL library path for Windows and MacOS. Under Unix/MacOSX, will be | 3533 | IDL library path for Windows and MacOS@. Under Unix/MacOSX, will be |
| 3534 | obtained from the Shell when run. | 3534 | obtained from the Shell when run. |
| 3535 | @end defopt | 3535 | @end defopt |
| 3536 | 3536 | ||
| 3537 | @defopt idlwave-system-directory | 3537 | @defopt idlwave-system-directory |
| 3538 | The IDL system directory for Windows and MacOS. Also needed for | 3538 | The IDL system directory for Windows and MacOS@. Also needed for |
| 3539 | locating HTML help and the IDL Assistant for IDL v6.2 and later. Under | 3539 | locating HTML help and the IDL Assistant for IDL v6.2 and later. Under |
| 3540 | Unix/MacOSX, will be obtained from the Shell and recorded, if run. | 3540 | Unix/MacOSX, will be obtained from the Shell and recorded, if run. |
| 3541 | @end defopt | 3541 | @end defopt |
| @@ -3565,19 +3565,19 @@ in directories containing @code{.pro} routine files. They are | |||
| 3565 | discovered on the IDL search path and loaded automatically when routine | 3565 | discovered on the IDL search path and loaded automatically when routine |
| 3566 | information is read. Each catalog file documents the routines found in | 3566 | information is read. Each catalog file documents the routines found in |
| 3567 | that directory --- one catalog per directory. Every catalog has a | 3567 | that directory --- one catalog per directory. Every catalog has a |
| 3568 | library name associated with it (e.g. @emph{AstroLib}). This name will | 3568 | library name associated with it (e.g., @emph{AstroLib}). This name will |
| 3569 | be shown briefly when the catalog is found, and in the routine info of | 3569 | be shown briefly when the catalog is found, and in the routine info of |
| 3570 | routines it documents. | 3570 | routines it documents. |
| 3571 | 3571 | ||
| 3572 | Many popular libraries of routines are shipped with IDLWAVE catalog | 3572 | Many popular libraries of routines are shipped with IDLWAVE catalog |
| 3573 | files by default, and so will be automatically discovered. Library | 3573 | files by default, and so will be automatically discovered. Library |
| 3574 | catalogs are scanned externally to Emacs using a tool provided with | 3574 | catalogs are scanned externally to Emacs using a tool provided with |
| 3575 | IDLWAVE. Each catalog can be re-scanned independently of any other. | 3575 | IDLWAVE@. Each catalog can be re-scanned independently of any other. |
| 3576 | Catalogs can easily be made available system-wide with a common source | 3576 | Catalogs can easily be made available system-wide with a common source |
| 3577 | repository, providing uniform routine information, and lifting the | 3577 | repository, providing uniform routine information, and lifting the |
| 3578 | burden of scanning from the user (who may not even know they're using a | 3578 | burden of scanning from the user (who may not even know they're using a |
| 3579 | scanned catalog). Since all catalogs are independent, they can be | 3579 | scanned catalog). Since all catalogs are independent, they can be |
| 3580 | re-scanned automatically to gather updates, e.g. in a @file{cron} job. | 3580 | re-scanned automatically to gather updates, e.g., in a @file{cron} job. |
| 3581 | Scanning is much faster than with the built-in user catalog method. One | 3581 | Scanning is much faster than with the built-in user catalog method. One |
| 3582 | minor disadvantage: the entire IDL search path is scanned for catalog | 3582 | minor disadvantage: the entire IDL search path is scanned for catalog |
| 3583 | files every time IDLWAVE starts up, which might be slow if accessing IDL | 3583 | files every time IDLWAVE starts up, which might be slow if accessing IDL |
| @@ -3719,7 +3719,7 @@ C-i}. Here are the different routines (also available in the Menu | |||
| 3719 | @item @kbd{M-x idlwave-list-buffer-load-path-shadows} | 3719 | @item @kbd{M-x idlwave-list-buffer-load-path-shadows} |
| 3720 | This command checks the names of all routines defined in the current | 3720 | This command checks the names of all routines defined in the current |
| 3721 | buffer for shadowing conflicts with other routines accessible to | 3721 | buffer for shadowing conflicts with other routines accessible to |
| 3722 | IDLWAVE. The command also has a key binding: @kbd{C-c C-b} | 3722 | IDLWAVE@. The command also has a key binding: @kbd{C-c C-b} |
| 3723 | @item @kbd{M-x idlwave-list-shell-load-path-shadows}. | 3723 | @item @kbd{M-x idlwave-list-shell-load-path-shadows}. |
| 3724 | Checks all routines compiled under the shell for shadowing. This is | 3724 | Checks all routines compiled under the shell for shadowing. This is |
| 3725 | very useful when you have written a complete application. Just compile | 3725 | very useful when you have written a complete application. Just compile |
| @@ -3744,7 +3744,7 @@ many other reasons. | |||
| 3744 | @cindex @code{!DIR}, IDL variable | 3744 | @cindex @code{!DIR}, IDL variable |
| 3745 | Users of Windows and MacOS (not X) also must set the variable | 3745 | Users of Windows and MacOS (not X) also must set the variable |
| 3746 | @code{idlwave-system-directory} to the value of the @code{!DIR} system | 3746 | @code{idlwave-system-directory} to the value of the @code{!DIR} system |
| 3747 | variable in IDL. IDLWAVE appends @file{lib} to the value of this | 3747 | variable in IDL@. IDLWAVE appends @file{lib} to the value of this |
| 3748 | variable and assumes that all files found on that path are system | 3748 | variable and assumes that all files found on that path are system |
| 3749 | routines. | 3749 | routines. |
| 3750 | 3750 | ||
| @@ -3791,7 +3791,7 @@ itself. | |||
| 3791 | There are a wide variety of possible browsers to use for displaying | 3791 | There are a wide variety of possible browsers to use for displaying |
| 3792 | the online HTML help available with IDLWAVE (starting with version | 3792 | the online HTML help available with IDLWAVE (starting with version |
| 3793 | 5.0). Since IDL v6.2, a single cross-platform HTML help browser, the | 3793 | 5.0). Since IDL v6.2, a single cross-platform HTML help browser, the |
| 3794 | @emph{IDL Assistant} is distributed with IDL. If this help browser is | 3794 | @emph{IDL Assistant} is distributed with IDL@. If this help browser is |
| 3795 | available, it is the preferred choice, and the default. The variable | 3795 | available, it is the preferred choice, and the default. The variable |
| 3796 | @code{idlwave-help-use-assistant}, enabled by default, controls | 3796 | @code{idlwave-help-use-assistant}, enabled by default, controls |
| 3797 | whether this help browser is used. If you use the IDL Assistant, the | 3797 | whether this help browser is used. If you use the IDL Assistant, the |
| @@ -3879,7 +3879,7 @@ features which: | |||
| 3879 | 3879 | ||
| 3880 | @itemize @minus | 3880 | @itemize @minus |
| 3881 | @item | 3881 | @item |
| 3882 | are not self-evident (i.e. too magic) when used by an unsuspecting user. | 3882 | are not self-evident (i.e., too magic) when used by an unsuspecting user. |
| 3883 | @item | 3883 | @item |
| 3884 | are too intrusive. | 3884 | are too intrusive. |
| 3885 | @item | 3885 | @item |
| @@ -3910,7 +3910,7 @@ the old maintainer had in his @file{.emacs}: | |||
| 3910 | 3910 | ||
| 3911 | However, if you are an Emacs power-user and want IDLWAVE to work | 3911 | However, if you are an Emacs power-user and want IDLWAVE to work |
| 3912 | completely differently, you can change almost every aspect of it. Here | 3912 | completely differently, you can change almost every aspect of it. Here |
| 3913 | is an example of a much more extensive configuration of IDLWAVE. The | 3913 | is an example of a much more extensive configuration of IDLWAVE@. The |
| 3914 | user is King! | 3914 | user is King! |
| 3915 | 3915 | ||
| 3916 | @example | 3916 | @example |
| @@ -4121,7 +4121,7 @@ under MacOSX} | |||
| 4121 | 4121 | ||
| 4122 | If you run Emacs directly as an Aqua application, rather than from the | 4122 | If you run Emacs directly as an Aqua application, rather than from the |
| 4123 | console shell, the environment is set not from your usual shell | 4123 | console shell, the environment is set not from your usual shell |
| 4124 | configuration files (e.g. @file{.cshrc}), but from the file | 4124 | configuration files (e.g., @file{.cshrc}), but from the file |
| 4125 | @file{~/.MacOSX/environment.plist}. Either include your path settings | 4125 | @file{~/.MacOSX/environment.plist}. Either include your path settings |
| 4126 | there, or start Emacs and IDLWAVE from the shell. | 4126 | there, or start Emacs and IDLWAVE from the shell. |
| 4127 | 4127 | ||
| @@ -4136,7 +4136,7 @@ which includes it by default. | |||
| 4136 | cl-builtin-gethash} on completion or routine info.} | 4136 | cl-builtin-gethash} on completion or routine info.} |
| 4137 | 4137 | ||
| 4138 | This error arises if you upgraded Emacs from 20.x to 21.x without | 4138 | This error arises if you upgraded Emacs from 20.x to 21.x without |
| 4139 | re-installing IDLWAVE. Old Emacs and new Emacs are not byte-compatible | 4139 | re-installing IDLWAVE@. Old Emacs and new Emacs are not byte-compatible |
| 4140 | in compiled lisp files. Presumably, you kept the original .elc files in | 4140 | in compiled lisp files. Presumably, you kept the original .elc files in |
| 4141 | place, and this is the source of the error. If you recompile (or just | 4141 | place, and this is the source of the error. If you recompile (or just |
| 4142 | "make; make install") from source, it should resolve this problem. | 4142 | "make; make install") from source, it should resolve this problem. |
| @@ -4190,7 +4190,7 @@ load file}}. | |||
| 4190 | 4190 | ||
| 4191 | The problem is that your Emacs is not finding the version of IDLWAVE you | 4191 | The problem is that your Emacs is not finding the version of IDLWAVE you |
| 4192 | installed. Many Emacsen come with an older bundled copy of IDLWAVE | 4192 | installed. Many Emacsen come with an older bundled copy of IDLWAVE |
| 4193 | (e.g. v4.7 for Emacs 21.x), which is likely what's being used instead. | 4193 | (e.g., v4.7 for Emacs 21.x), which is likely what's being used instead. |
| 4194 | You need to make sure your Emacs @emph{load-path} contains the directory | 4194 | You need to make sure your Emacs @emph{load-path} contains the directory |
| 4195 | where IDLWAVE is installed (@file{/usr/local/share/emacs/site-lisp}, by | 4195 | where IDLWAVE is installed (@file{/usr/local/share/emacs/site-lisp}, by |
| 4196 | default), @emph{before} Emacs's default search directories. You can | 4196 | default), @emph{before} Emacs's default search directories. You can |
| @@ -4244,13 +4244,13 @@ displayed as Latin characters!} | |||
| 4244 | 4244 | ||
| 4245 | Unfortunately, the HTMLHelp files RSI provides attempt to switch to | 4245 | Unfortunately, the HTMLHelp files RSI provides attempt to switch to |
| 4246 | @samp{Symbol} font to display Greek characters, which is not really an | 4246 | @samp{Symbol} font to display Greek characters, which is not really an |
| 4247 | permitted method for doing this in HTML. There is a "workaround" for | 4247 | permitted method for doing this in HTML@. There is a "workaround" for |
| 4248 | some browsers: @xref{HTML Help Browser Tips}. | 4248 | some browsers: @xref{HTML Help Browser Tips}. |
| 4249 | 4249 | ||
| 4250 | @item @strong{In the shell, my long commands are truncated at 256 characters!} | 4250 | @item @strong{In the shell, my long commands are truncated at 256 characters!} |
| 4251 | 4251 | ||
| 4252 | This actually happens when running IDL in an XTerm as well. There are | 4252 | This actually happens when running IDL in an XTerm as well. There are |
| 4253 | a couple of workarounds: @code{define_key,/control,'^d'} (e.g. in | 4253 | a couple of workarounds: @code{define_key,/control,'^d'} (e.g., in |
| 4254 | your @file{$IDL_STARTUP} file) will disable the @samp{EOF} character | 4254 | your @file{$IDL_STARTUP} file) will disable the @samp{EOF} character |
| 4255 | and give you a 512 character limit. You won't be able to use | 4255 | and give you a 512 character limit. You won't be able to use |
| 4256 | @key{C-d} to quit the shell, however. Another possibility is | 4256 | @key{C-d} to quit the shell, however. Another possibility is |
| @@ -4259,7 +4259,7 @@ memory-bounded limit), but disables the processing of background | |||
| 4259 | widget events (those with @code{/NO_BLOCK} passed to @code{XManager}). | 4259 | widget events (those with @code{/NO_BLOCK} passed to @code{XManager}). |
| 4260 | 4260 | ||
| 4261 | @item @strong{When I invoke IDL HTML help on a routine, the page which | 4261 | @item @strong{When I invoke IDL HTML help on a routine, the page which |
| 4262 | is loaded is one page off, e.g. for @code{CONVERT_COORD}, I get | 4262 | is loaded is one page off, e.g., for @code{CONVERT_COORD}, I get |
| 4263 | @code{CONTOUR}.} | 4263 | @code{CONTOUR}.} |
| 4264 | 4264 | ||
| 4265 | You have a mismatch between your help index and the HTML help package | 4265 | You have a mismatch between your help index and the HTML help package |
diff --git a/doc/misc/info.texi b/doc/misc/info.texi index 8952bfb9122..141b8da5728 100644 --- a/doc/misc/info.texi +++ b/doc/misc/info.texi | |||
| @@ -78,7 +78,7 @@ Started' chapter. | |||
| 78 | @end ifinfo | 78 | @end ifinfo |
| 79 | @end ifnottex | 79 | @end ifnottex |
| 80 | 80 | ||
| 81 | @insertcopying | 81 | @insertcopying |
| 82 | 82 | ||
| 83 | @menu | 83 | @menu |
| 84 | * Getting Started:: Getting started using an Info reader. | 84 | * Getting Started:: Getting started using an Info reader. |
| @@ -264,7 +264,7 @@ links. | |||
| 264 | 264 | ||
| 265 | @format | 265 | @format |
| 266 | >> If you are in Emacs and have a mouse, and if you already practiced | 266 | >> If you are in Emacs and have a mouse, and if you already practiced |
| 267 | typing @kbd{n} to get to the next node, click now with the left | 267 | typing @kbd{n} to get to the next node, click now with the left |
| 268 | mouse button on the @samp{Next} link to do the same ``the mouse way''. | 268 | mouse button on the @samp{Next} link to do the same ``the mouse way''. |
| 269 | @end format | 269 | @end format |
| 270 | 270 | ||
| @@ -324,7 +324,7 @@ the screen. | |||
| 324 | we call ``Backspace or DEL'' in this manual is labeled differently on | 324 | we call ``Backspace or DEL'' in this manual is labeled differently on |
| 325 | different keyboards. Look for a key which is a little ways above the | 325 | different keyboards. Look for a key which is a little ways above the |
| 326 | @key{ENTER} or @key{RET} key and which you normally use outside Emacs | 326 | @key{ENTER} or @key{RET} key and which you normally use outside Emacs |
| 327 | to erase the character before the cursor, i.e.@: the character you | 327 | to erase the character before the cursor, i.e., the character you |
| 328 | typed last. It might be labeled @samp{Backspace} or @samp{<-} or | 328 | typed last. It might be labeled @samp{Backspace} or @samp{<-} or |
| 329 | @samp{DEL}, or sometimes @samp{Delete}.} and @kbd{b} commands exist to | 329 | @samp{DEL}, or sometimes @samp{Delete}.} and @kbd{b} commands exist to |
| 330 | allow you to ``move around'' in a node that does not all fit on the | 330 | allow you to ``move around'' in a node that does not all fit on the |
diff --git a/doc/misc/mairix-el.texi b/doc/misc/mairix-el.texi index 468283ffd93..1e835d44838 100644 --- a/doc/misc/mairix-el.texi +++ b/doc/misc/mairix-el.texi | |||
| @@ -68,7 +68,7 @@ database. | |||
| 68 | 68 | ||
| 69 | Mairix is a tool for indexing and searching words in locally stored | 69 | Mairix is a tool for indexing and searching words in locally stored |
| 70 | mail. It was written by Richard Curnow and is licensed under the | 70 | mail. It was written by Richard Curnow and is licensed under the |
| 71 | GPL. Mairix comes with most popular GNU/Linux distributions, but it also | 71 | GPL@. Mairix comes with most popular GNU/Linux distributions, but it also |
| 72 | runs under Windows (with cygwin), Mac OS X and Solaris. The homepage can | 72 | runs under Windows (with cygwin), Mac OS X and Solaris. The homepage can |
| 73 | be found at | 73 | be found at |
| 74 | @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html} | 74 | @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html} |
| @@ -246,7 +246,7 @@ modifying `mairix-widget-fields-list'. | |||
| 246 | @kindex M-x mairix-widget-search-based-on-article | 246 | @kindex M-x mairix-widget-search-based-on-article |
| 247 | @findex mairix-widget-search-based-on-article | 247 | @findex mairix-widget-search-based-on-article |
| 248 | Create a mairix query using graphical widgets, but based on the | 248 | Create a mairix query using graphical widgets, but based on the |
| 249 | currently displayed article, i.e. the available fields will be filled | 249 | currently displayed article, i.e., the available fields will be filled |
| 250 | with the current header values. | 250 | with the current header values. |
| 251 | 251 | ||
| 252 | @item mairix-search-from-this-article | 252 | @item mairix-search-from-this-article |
diff --git a/doc/misc/message.texi b/doc/misc/message.texi index ef752a96fdc..68e14c9b253 100644 --- a/doc/misc/message.texi +++ b/doc/misc/message.texi | |||
| @@ -163,8 +163,8 @@ header should be. If it does not, it should just return @code{nil}, and | |||
| 163 | the normal methods for determining the To header will be used. | 163 | the normal methods for determining the To header will be used. |
| 164 | 164 | ||
| 165 | Each list element should be a cons, where the @sc{car} should be the | 165 | Each list element should be a cons, where the @sc{car} should be the |
| 166 | name of a header (e.g. @code{Cc}) and the @sc{cdr} should be the header | 166 | name of a header (e.g., @code{Cc}) and the @sc{cdr} should be the header |
| 167 | value (e.g. @samp{larsi@@ifi.uio.no}). All these headers will be | 167 | value (e.g., @samp{larsi@@ifi.uio.no}). All these headers will be |
| 168 | inserted into the head of the outgoing mail. | 168 | inserted into the head of the outgoing mail. |
| 169 | 169 | ||
| 170 | 170 | ||
| @@ -407,7 +407,7 @@ and very difficult to follow. | |||
| 407 | 407 | ||
| 408 | @end itemize | 408 | @end itemize |
| 409 | 409 | ||
| 410 | Gnus honors the MFT header in other's messages (i.e. while following | 410 | Gnus honors the MFT header in other's messages (i.e., while following |
| 411 | up to someone else's post) and also provides support for generating | 411 | up to someone else's post) and also provides support for generating |
| 412 | sensible MFT headers for outgoing messages as well. | 412 | sensible MFT headers for outgoing messages as well. |
| 413 | 413 | ||
| @@ -1041,7 +1041,7 @@ modern cryptography, @acronym{S/MIME}, various PKCS standards, OpenSSL and | |||
| 1041 | so on. | 1041 | so on. |
| 1042 | 1042 | ||
| 1043 | The @acronym{S/MIME} support in Message (and @acronym{MML}) require | 1043 | The @acronym{S/MIME} support in Message (and @acronym{MML}) require |
| 1044 | OpenSSL. OpenSSL performs the actual @acronym{S/MIME} sign/encrypt | 1044 | OpenSSL@. OpenSSL performs the actual @acronym{S/MIME} sign/encrypt |
| 1045 | operations. OpenSSL can be found at @uref{http://www.openssl.org/}. | 1045 | operations. OpenSSL can be found at @uref{http://www.openssl.org/}. |
| 1046 | OpenSSL 0.9.6 and later should work. Version 0.9.5a cannot extract mail | 1046 | OpenSSL 0.9.6 and later should work. Version 0.9.5a cannot extract mail |
| 1047 | addresses from certificates, and it insert a spurious CR character into | 1047 | addresses from certificates, and it insert a spurious CR character into |
| @@ -1054,7 +1054,7 @@ To be able to send encrypted mail, a personal certificate is not | |||
| 1054 | required. Message (@acronym{MML}) need a certificate for the person to whom you | 1054 | required. Message (@acronym{MML}) need a certificate for the person to whom you |
| 1055 | wish to communicate with though. You're asked for this when you type | 1055 | wish to communicate with though. You're asked for this when you type |
| 1056 | @kbd{C-c C-m c s}. Currently there are two ways to retrieve this | 1056 | @kbd{C-c C-m c s}. Currently there are two ways to retrieve this |
| 1057 | certificate, from a local file or from DNS. If you chose a local | 1057 | certificate, from a local file or from DNS@. If you chose a local |
| 1058 | file, it need to contain a X.509 certificate in @acronym{PEM} format. | 1058 | file, it need to contain a X.509 certificate in @acronym{PEM} format. |
| 1059 | If you chose DNS, you're asked for the domain name where the | 1059 | If you chose DNS, you're asked for the domain name where the |
| 1060 | certificate is stored, the default is a good guess. To my belief, | 1060 | certificate is stored, the default is a good guess. To my belief, |
| @@ -1091,7 +1091,7 @@ The @file{key+cert.pem} file should be pointed to from the | |||
| 1091 | @emph{Note!} Your private key is now stored unencrypted in the file, | 1091 | @emph{Note!} Your private key is now stored unencrypted in the file, |
| 1092 | so take care in handling it. Storing encrypted keys on the disk are | 1092 | so take care in handling it. Storing encrypted keys on the disk are |
| 1093 | supported, and Gnus will ask you for a passphrase before invoking | 1093 | supported, and Gnus will ask you for a passphrase before invoking |
| 1094 | OpenSSL. Read the OpenSSL documentation for how to achieve this. If | 1094 | OpenSSL@. Read the OpenSSL documentation for how to achieve this. If |
| 1095 | you use unencrypted keys (e.g., if they are on a secure storage, or if | 1095 | you use unencrypted keys (e.g., if they are on a secure storage, or if |
| 1096 | you are on a secure single user machine) simply press @code{RET} at | 1096 | you are on a secure single user machine) simply press @code{RET} at |
| 1097 | the passphrase prompt. | 1097 | the passphrase prompt. |
| @@ -1154,9 +1154,9 @@ your PGP implementation, so we refer to it. | |||
| 1154 | If you have imported your old PGP 2.x key into GnuPG, and want to send | 1154 | If you have imported your old PGP 2.x key into GnuPG, and want to send |
| 1155 | signed and encrypted messages to your fellow PGP 2.x users, you'll | 1155 | signed and encrypted messages to your fellow PGP 2.x users, you'll |
| 1156 | discover that the receiver cannot understand what you send. One | 1156 | discover that the receiver cannot understand what you send. One |
| 1157 | solution is to use PGP 2.x instead (e.g.@: if you use @code{pgg}, set | 1157 | solution is to use PGP 2.x instead (e.g., if you use @code{pgg}, set |
| 1158 | @code{pgg-default-scheme} to @code{pgp}). You could also convince your | 1158 | @code{pgg-default-scheme} to @code{pgp}). You could also convince your |
| 1159 | fellow PGP 2.x users to convert to GnuPG. | 1159 | fellow PGP 2.x users to convert to GnuPG@. |
| 1160 | @vindex mml-signencrypt-style-alist | 1160 | @vindex mml-signencrypt-style-alist |
| 1161 | As a final workaround, you can make the sign and encryption work in | 1161 | As a final workaround, you can make the sign and encryption work in |
| 1162 | two steps; separately sign, then encrypt a message. If you would like | 1162 | two steps; separately sign, then encrypt a message. If you would like |
| @@ -1676,7 +1676,7 @@ installation. | |||
| 1676 | Most versions of MH doesn't like being fed messages that contain the | 1676 | Most versions of MH doesn't like being fed messages that contain the |
| 1677 | headers in this variable. If this variable is non-@code{nil} (which is | 1677 | headers in this variable. If this variable is non-@code{nil} (which is |
| 1678 | the default), these headers will be removed before mailing when sending | 1678 | the default), these headers will be removed before mailing when sending |
| 1679 | messages via MH. Set it to @code{nil} if your MH can handle these | 1679 | messages via MH@. Set it to @code{nil} if your MH can handle these |
| 1680 | headers. | 1680 | headers. |
| 1681 | 1681 | ||
| 1682 | @item message-qmail-inject-program | 1682 | @item message-qmail-inject-program |
| @@ -1690,7 +1690,7 @@ Arguments passed to qmail-inject programs. | |||
| 1690 | This should be a list of strings, one string for each argument. It | 1690 | This should be a list of strings, one string for each argument. It |
| 1691 | may also be a function. | 1691 | may also be a function. |
| 1692 | 1692 | ||
| 1693 | For e.g., if you wish to set the envelope sender address so that bounces | 1693 | E.g., if you wish to set the envelope sender address so that bounces |
| 1694 | go to the right place or to deal with listserv's usage of that address, you | 1694 | go to the right place or to deal with listserv's usage of that address, you |
| 1695 | might set this variable to @code{'("-f" "you@@some.where")}. | 1695 | might set this variable to @code{'("-f" "you@@some.where")}. |
| 1696 | 1696 | ||
| @@ -1780,7 +1780,7 @@ This required header will be generated by Message. A unique ID will be | |||
| 1780 | created based on the date, time, user name (for the local part) and the | 1780 | created based on the date, time, user name (for the local part) and the |
| 1781 | domain part. For the domain part, message will look (in this order) at | 1781 | domain part. For the domain part, message will look (in this order) at |
| 1782 | @code{message-user-fqdn}, @code{system-name}, @code{mail-host-address} | 1782 | @code{message-user-fqdn}, @code{system-name}, @code{mail-host-address} |
| 1783 | and @code{message-user-mail-address} (i.e. @code{user-mail-address}) | 1783 | and @code{message-user-mail-address} (i.e., @code{user-mail-address}) |
| 1784 | until a probably valid fully qualified domain name (FQDN) was found. | 1784 | until a probably valid fully qualified domain name (FQDN) was found. |
| 1785 | 1785 | ||
| 1786 | @item User-Agent | 1786 | @item User-Agent |
diff --git a/doc/misc/mh-e.texi b/doc/misc/mh-e.texi index e419ba05055..06ab93f91c7 100644 --- a/doc/misc/mh-e.texi +++ b/doc/misc/mh-e.texi | |||
| @@ -206,7 +206,7 @@ History of MH-E | |||
| 206 | This manual introduces another interface to the MH mail system that is | 206 | This manual introduces another interface to the MH mail system that is |
| 207 | accessible through the GNU Emacs editor, namely, @emph{MH-E}. MH-E is | 207 | accessible through the GNU Emacs editor, namely, @emph{MH-E}. MH-E is |
| 208 | easy to use. I don't assume that you know GNU Emacs or even MH at this | 208 | easy to use. I don't assume that you know GNU Emacs or even MH at this |
| 209 | point, since I didn't know either of them when I discovered MH-E. | 209 | point, since I didn't know either of them when I discovered MH-E@. |
| 210 | However, MH-E was the tip of the iceberg, and I discovered more and | 210 | However, MH-E was the tip of the iceberg, and I discovered more and |
| 211 | more niceties about GNU Emacs and MH@. Now I'm fully hooked on both of | 211 | more niceties about GNU Emacs and MH@. Now I'm fully hooked on both of |
| 212 | them. | 212 | them. |
| @@ -540,7 +540,7 @@ installing MH-E. | |||
| 540 | If the @code{mh-version} command displays @samp{No MH variant | 540 | If the @code{mh-version} command displays @samp{No MH variant |
| 541 | detected}@footnote{In very old versions of MH-E, you may get the error | 541 | detected}@footnote{In very old versions of MH-E, you may get the error |
| 542 | message, @samp{Cannot find the commands `inc' and `mhl' and the file | 542 | message, @samp{Cannot find the commands `inc' and `mhl' and the file |
| 543 | `components'} if MH-E can't find MH. In this case, you need to update | 543 | `components'} if MH-E can't find MH@. In this case, you need to update |
| 544 | MH-E, and you may need to install MH too. However, newer versions of | 544 | MH-E, and you may need to install MH too. However, newer versions of |
| 545 | MH-E are better at finding MH if it is on your system.}, then you need | 545 | MH-E are better at finding MH if it is on your system.}, then you need |
| 546 | to install MH or tell MH-E where to find MH. | 546 | to install MH or tell MH-E where to find MH. |
| @@ -550,11 +550,11 @@ to install MH or tell MH-E where to find MH. | |||
| 550 | @cindex GNU mailutils MH | 550 | @cindex GNU mailutils MH |
| 551 | 551 | ||
| 552 | If you don't have MH on your system already, you must install a | 552 | If you don't have MH on your system already, you must install a |
| 553 | variant of MH. The Debian mh-e package does this for you automatically | 553 | variant of MH@. The Debian mh-e package does this for you automatically |
| 554 | (@pxref{Getting MH-E}). Most people use | 554 | (@pxref{Getting MH-E}). Most people use |
| 555 | @uref{http://www.nongnu.org/nmh/, nmh}, but you may be interested in | 555 | @uref{http://www.nongnu.org/nmh/, nmh}, but you may be interested in |
| 556 | trying out @uref{http://www.gnu.org/software/mailutils/, GNU mailutils | 556 | trying out @uref{http://www.gnu.org/software/mailutils/, GNU mailutils |
| 557 | MH}, which supports IMAP. Your GNU/Linux distribution probably has | 557 | MH}, which supports IMAP@. Your GNU/Linux distribution probably has |
| 558 | packages for both of these. | 558 | packages for both of these. |
| 559 | 559 | ||
| 560 | @cindex @command{install-mh} | 560 | @cindex @command{install-mh} |
| @@ -671,7 +671,7 @@ chapter for a mapping between default key bindings and function | |||
| 671 | names.}. When you're done, you'll be able to send, read, and file | 671 | names.}. When you're done, you'll be able to send, read, and file |
| 672 | mail, which is all that a lot of people ever do. But if you're the | 672 | mail, which is all that a lot of people ever do. But if you're the |
| 673 | curious or adventurous type, read the rest of the manual to be able to | 673 | curious or adventurous type, read the rest of the manual to be able to |
| 674 | use all the features of MH-E. I suggest you read this chapter first to | 674 | use all the features of MH-E@. I suggest you read this chapter first to |
| 675 | get the big picture, and then you can read the manual as you wish. | 675 | get the big picture, and then you can read the manual as you wish. |
| 676 | 676 | ||
| 677 | @menu | 677 | @menu |
| @@ -1572,7 +1572,7 @@ command incorporates your mail and creates a buffer called | |||
| 1572 | @samp{+inbox} in MH-Folder mode. The command @kbd{M-x mh-rmail} shows | 1572 | @samp{+inbox} in MH-Folder mode. The command @kbd{M-x mh-rmail} shows |
| 1573 | you only new mail, not mail you have already read@footnote{If you want | 1573 | you only new mail, not mail you have already read@footnote{If you want |
| 1574 | to see your old mail as well, use @kbd{F r} to pull all your messages | 1574 | to see your old mail as well, use @kbd{F r} to pull all your messages |
| 1575 | into MH-E. Or, give a prefix argument to @code{mh-rmail} so it will | 1575 | into MH-E@. Or, give a prefix argument to @code{mh-rmail} so it will |
| 1576 | prompt you for folder to visit like @kbd{F v} (for example, @kbd{C-u | 1576 | prompt you for folder to visit like @kbd{F v} (for example, @kbd{C-u |
| 1577 | M-x mh-rmail @key{RET} bob @key{RET}}). @xref{Folders}.}. | 1577 | M-x mh-rmail @key{RET} bob @key{RET}}). @xref{Folders}.}. |
| 1578 | 1578 | ||
| @@ -2456,7 +2456,7 @@ that they do not really appear like an attachment at all to the | |||
| 2456 | reader. Most of the time, this is desirable, so by default MH-E | 2456 | reader. Most of the time, this is desirable, so by default MH-E |
| 2457 | suppresses the buttons for inline attachments. On the other hand, you | 2457 | suppresses the buttons for inline attachments. On the other hand, you |
| 2458 | may receive code or HTML which the sender has added to his message as | 2458 | may receive code or HTML which the sender has added to his message as |
| 2459 | inline attachments so that you can read them in MH-E. In this case, it | 2459 | inline attachments so that you can read them in MH-E@. In this case, it |
| 2460 | is useful to see the buttons so that you know you don't have to cut | 2460 | is useful to see the buttons so that you know you don't have to cut |
| 2461 | and paste the code into a file; you can simply save the attachment. If | 2461 | and paste the code into a file; you can simply save the attachment. If |
| 2462 | you want to make the buttons visible for inline attachments, you can | 2462 | you want to make the buttons visible for inline attachments, you can |
| @@ -3222,7 +3222,7 @@ original configuration is displayed. | |||
| 3222 | @cindex menu, @samp{Message} | 3222 | @cindex menu, @samp{Message} |
| 3223 | @cindex using folders | 3223 | @cindex using folders |
| 3224 | 3224 | ||
| 3225 | This chapter discusses the things you can do with folders within MH-E. | 3225 | This chapter discusses the things you can do with folders within MH-E@. |
| 3226 | The commands in this chapter are also found in the @samp{Folder} and | 3226 | The commands in this chapter are also found in the @samp{Folder} and |
| 3227 | @samp{Message} menus. | 3227 | @samp{Message} menus. |
| 3228 | 3228 | ||
| @@ -5705,7 +5705,7 @@ buffer and delete the draft message. Use the command @kbd{C-x k} | |||
| 5705 | 5705 | ||
| 5706 | @cindex aliases | 5706 | @cindex aliases |
| 5707 | 5707 | ||
| 5708 | MH aliases are used in the same way in MH-E as they are in MH. Any | 5708 | MH aliases are used in the same way in MH-E as they are in MH@. Any |
| 5709 | alias listed as a recipient will be expanded when the message is sent. | 5709 | alias listed as a recipient will be expanded when the message is sent. |
| 5710 | This chapter discusses other things you can do with aliases in MH-E. | 5710 | This chapter discusses other things you can do with aliases in MH-E. |
| 5711 | 5711 | ||
| @@ -5816,7 +5816,7 @@ Otherwise, you can complete aliases in the header of the draft with | |||
| 5816 | 5816 | ||
| 5817 | @vindex mh-alias-completion-ignore-case-flag | 5817 | @vindex mh-alias-completion-ignore-case-flag |
| 5818 | 5818 | ||
| 5819 | As MH ignores case in the aliases, so too does MH-E. However, you may | 5819 | As MH ignores case in the aliases, so too does MH-E@. However, you may |
| 5820 | turn off the option @code{mh-alias-completion-ignore-case-flag} to | 5820 | turn off the option @code{mh-alias-completion-ignore-case-flag} to |
| 5821 | make case significant which can be used to segregate completion of | 5821 | make case significant which can be used to segregate completion of |
| 5822 | your aliases. You might use uppercase for mailing lists and lowercase | 5822 | your aliases. You might use uppercase for mailing lists and lowercase |
| @@ -8647,7 +8647,7 @@ modify. Note that for them to become accessible, you'll have to load | |||
| 8647 | @vtable @code | 8647 | @vtable @code |
| 8648 | @item gnus-secondary-select-methods | 8648 | @item gnus-secondary-select-methods |
| 8649 | Select the @samp{nnml} value. This select method uses directories for | 8649 | Select the @samp{nnml} value. This select method uses directories for |
| 8650 | folders and individual files for messages, just like MH. You do not | 8650 | folders and individual files for messages, just like MH@. You do not |
| 8651 | have to set an address. | 8651 | have to set an address. |
| 8652 | @c ------------------------- | 8652 | @c ------------------------- |
| 8653 | @item mail-sources | 8653 | @item mail-sources |
| @@ -8725,7 +8725,7 @@ positive we won't ask for it. | |||
| 8725 | @cindex SourceForge | 8725 | @cindex SourceForge |
| 8726 | @cindex mailing lists | 8726 | @cindex mailing lists |
| 8727 | 8727 | ||
| 8728 | There are several mailing lists for MH-E. They are @i{mh-e-users at | 8728 | There are several mailing lists for MH-E@. They are @i{mh-e-users at |
| 8729 | lists.sourceforge.net}, @i{mh-e-announce at lists.sourceforge.net}, | 8729 | lists.sourceforge.net}, @i{mh-e-announce at lists.sourceforge.net}, |
| 8730 | and @i{mh-e-devel at lists.sourceforge.net}. You can subscribe or view | 8730 | and @i{mh-e-devel at lists.sourceforge.net}. You can subscribe or view |
| 8731 | the archives at @uref{https://sourceforge.net/mail/?group_id=13357, | 8731 | the archives at @uref{https://sourceforge.net/mail/?group_id=13357, |
| @@ -8792,9 +8792,9 @@ instead. | |||
| 8792 | After you download and extract the MH-E tarball, read the | 8792 | After you download and extract the MH-E tarball, read the |
| 8793 | @file{README} file and @file{MH-E-NEWS}. These correspond to the | 8793 | @file{README} file and @file{MH-E-NEWS}. These correspond to the |
| 8794 | release notes and change log mentioned above. The file @file{README} | 8794 | release notes and change log mentioned above. The file @file{README} |
| 8795 | contains instructions on installing MH-E. If you're already running | 8795 | contains instructions on installing MH-E@. If you're already running |
| 8796 | Emacs, please quit that session and start again to load in the new | 8796 | Emacs, please quit that session and start again to load in the new |
| 8797 | MH-E. Check that you're running the new version with the command | 8797 | MH-E@. Check that you're running the new version with the command |
| 8798 | @kbd{M-x mh-version}. | 8798 | @kbd{M-x mh-version}. |
| 8799 | 8799 | ||
| 8800 | @cindex contributed software | 8800 | @cindex contributed software |
| @@ -8904,13 +8904,13 @@ limited the use and appeal of the package. | |||
| 8904 | @cindex @command{xmh}, in MH-E history | 8904 | @cindex @command{xmh}, in MH-E history |
| 8905 | 8905 | ||
| 8906 | In '89, I came to Wisconsin as a professor and decided not to work on | 8906 | In '89, I came to Wisconsin as a professor and decided not to work on |
| 8907 | MH-E. It was stable, except for minor bugs, and had enough | 8907 | MH-E@. It was stable, except for minor bugs, and had enough |
| 8908 | functionality, so I let it be for a few years. Stephen Gildea of BBN | 8908 | functionality, so I let it be for a few years. Stephen Gildea of BBN |
| 8909 | began to pester me about the bugs, but I ignored them. In 1990, he | 8909 | began to pester me about the bugs, but I ignored them. In 1990, he |
| 8910 | went off to the X Consortium, said good bye, and said that he would | 8910 | went off to the X Consortium, said good bye, and said that he would |
| 8911 | now be using @command{xmh}. A few months later, he came back and said | 8911 | now be using @command{xmh}. A few months later, he came back and said |
| 8912 | that he couldn't stand @command{xmh} and could I put a few more bug fixes | 8912 | that he couldn't stand @command{xmh} and could I put a few more bug fixes |
| 8913 | into MH-E. At that point, I had no interest in fixing MH-E, so I gave | 8913 | into MH-E@. At that point, I had no interest in fixing MH-E, so I gave |
| 8914 | the responsibility of maintenance to him and he has done a fine job | 8914 | the responsibility of maintenance to him and he has done a fine job |
| 8915 | since then. | 8915 | since then. |
| 8916 | 8916 | ||
| @@ -8931,7 +8931,7 @@ modifications of my own) and dislike having to use applications with | |||
| 8931 | embedded editors; they never live up to Emacs. | 8931 | embedded editors; they never live up to Emacs. |
| 8932 | 8932 | ||
| 8933 | MH is the mail reader of choice at BBN, so I converted to it. Since I | 8933 | MH is the mail reader of choice at BBN, so I converted to it. Since I |
| 8934 | didn't want to give up using an Emacs interface, I started using MH-E. | 8934 | didn't want to give up using an Emacs interface, I started using MH-E@. |
| 8935 | As is my wont, I started hacking on it almost immediately. I first | 8935 | As is my wont, I started hacking on it almost immediately. I first |
| 8936 | used version 3.4m. One of the first features I added was to treat the | 8936 | used version 3.4m. One of the first features I added was to treat the |
| 8937 | folder buffer as a file-visiting buffer: you could lock it, save it, | 8937 | folder buffer as a file-visiting buffer: you could lock it, save it, |
| @@ -8943,7 +8943,7 @@ MH-E was too slow and optimized it a lot. Version, 3.7, distributed | |||
| 8943 | with Emacs 18.56 in 1990, was noticeably faster. | 8943 | with Emacs 18.56 in 1990, was noticeably faster. |
| 8944 | 8944 | ||
| 8945 | When I moved to the X Consortium I became the first person there to | 8945 | When I moved to the X Consortium I became the first person there to |
| 8946 | not use xmh. (There is now one other engineer there using MH-E.) About | 8946 | not use xmh. (There is now one other engineer there using MH-E@.) About |
| 8947 | this point I took over maintenance of MH-E from Jim and was finally | 8947 | this point I took over maintenance of MH-E from Jim and was finally |
| 8948 | able to add some features Jim hadn't accepted, such as the backward | 8948 | able to add some features Jim hadn't accepted, such as the backward |
| 8949 | searching undo. My first release was 3.8 (Emacs 18.58) in 1992. | 8949 | searching undo. My first release was 3.8 (Emacs 18.58) in 1992. |
diff --git a/doc/misc/newsticker.texi b/doc/misc/newsticker.texi index 5add229724c..60510f41e71 100644 --- a/doc/misc/newsticker.texi +++ b/doc/misc/newsticker.texi | |||
| @@ -190,7 +190,7 @@ stop the periodic download, but will call | |||
| 190 | @node Configuration | 190 | @node Configuration |
| 191 | @chapter Configuration | 191 | @chapter Configuration |
| 192 | 192 | ||
| 193 | All Newsticker options are customizable, i.e. they can be changed with | 193 | All Newsticker options are customizable, i.e., they can be changed with |
| 194 | Emacs customization methods. Call the command | 194 | Emacs customization methods. Call the command |
| 195 | @code{customize-group} and enter @samp{newsticker} for the customization | 195 | @code{customize-group} and enter @samp{newsticker} for the customization |
| 196 | group. | 196 | group. |
| @@ -260,7 +260,7 @@ apply to the plainview reader only. | |||
| 260 | 260 | ||
| 261 | @item | 261 | @item |
| 262 | @code{newsticker-ticker} contains options that define how headlines | 262 | @code{newsticker-ticker} contains options that define how headlines |
| 263 | are shown in the echo area, i.e. the ``ticker''. | 263 | are shown in the echo area, i.e., the ``ticker''. |
| 264 | 264 | ||
| 265 | @itemize | 265 | @itemize |
| 266 | @item | 266 | @item |
diff --git a/doc/misc/nxml-mode.texi b/doc/misc/nxml-mode.texi index c8d159e2363..a0e34b2cf5a 100644 --- a/doc/misc/nxml-mode.texi +++ b/doc/misc/nxml-mode.texi | |||
| @@ -76,7 +76,7 @@ documents. | |||
| 76 | To get validation and schema-sensitive editing, you need a RELAX NG Compact | 76 | To get validation and schema-sensitive editing, you need a RELAX NG Compact |
| 77 | Syntax (RNC) schema for your document (@pxref{Locating a schema}). The | 77 | Syntax (RNC) schema for your document (@pxref{Locating a schema}). The |
| 78 | @file{etc/schema} directory includes some schemas for popular document | 78 | @file{etc/schema} directory includes some schemas for popular document |
| 79 | types. See @url{http://relaxng.org/} for more information on RELAX NG. | 79 | types. See @url{http://relaxng.org/} for more information on RELAX NG@. |
| 80 | You can use the @samp{Trang} program from | 80 | You can use the @samp{Trang} program from |
| 81 | @url{http://www.thaiopensource.com/relaxng/trang.html} to | 81 | @url{http://www.thaiopensource.com/relaxng/trang.html} to |
| 82 | automatically create RNC schemas. This program can: | 82 | automatically create RNC schemas. This program can: |
| @@ -138,7 +138,7 @@ indicates point): | |||
| 138 | @end example | 138 | @end example |
| 139 | 139 | ||
| 140 | @noindent | 140 | @noindent |
| 141 | and the schema is XHTML. In this context, the symbol to be completed | 141 | and the schema is XHTML@. In this context, the symbol to be completed |
| 142 | is @samp{h}. The possible completions consist of just | 142 | is @samp{h}. The possible completions consist of just |
| 143 | @samp{head}. Another example, is | 143 | @samp{head}. Another example, is |
| 144 | 144 | ||
| @@ -288,7 +288,7 @@ and then following the instructions in the displayed buffer. | |||
| 288 | 288 | ||
| 289 | Emacs has several commands that operate on paragraphs, most | 289 | Emacs has several commands that operate on paragraphs, most |
| 290 | notably @kbd{M-q}. nXML mode redefines these to work in a way | 290 | notably @kbd{M-q}. nXML mode redefines these to work in a way |
| 291 | that is useful for XML. The exact rules that are used to find the | 291 | that is useful for XML@. The exact rules that are used to find the |
| 292 | beginning and end of a paragraph are complicated; they are designed | 292 | beginning and end of a paragraph are complicated; they are designed |
| 293 | mainly to ensure that @kbd{M-q} does the right thing. | 293 | mainly to ensure that @kbd{M-q} does the right thing. |
| 294 | 294 | ||
| @@ -355,7 +355,7 @@ child element. A section also contains its subordinate sections (its | |||
| 355 | subsections). The text content of a section consists of anything in a | 355 | subsections). The text content of a section consists of anything in a |
| 356 | section that is neither a subsection nor a heading. | 356 | section that is neither a subsection nor a heading. |
| 357 | 357 | ||
| 358 | Note that this is a different model from that used by XHTML. | 358 | Note that this is a different model from that used by XHTML@. |
| 359 | nXML mode's outline support will not be useful for XHTML unless you | 359 | nXML mode's outline support will not be useful for XHTML unless you |
| 360 | adopt a convention of adding a @code{div} to enclose each | 360 | adopt a convention of adding a @code{div} to enclose each |
| 361 | section, rather than having sections implicitly delimited by different | 361 | section, rather than having sections implicitly delimited by different |
| @@ -363,7 +363,7 @@ section, rather than having sections implicitly delimited by different | |||
| 363 | in a future version. | 363 | in a future version. |
| 364 | 364 | ||
| 365 | The variable @code{nxml-section-element-name-regexp} gives | 365 | The variable @code{nxml-section-element-name-regexp} gives |
| 366 | a regexp for the local names (i.e. the part of the name following any | 366 | a regexp for the local names (i.e., the part of the name following any |
| 367 | prefix) of section elements. The variable | 367 | prefix) of section elements. The variable |
| 368 | @code{nxml-heading-element-name-regexp} gives a regexp for the | 368 | @code{nxml-heading-element-name-regexp} gives a regexp for the |
| 369 | local names of heading elements. For an element to be recognized | 369 | local names of heading elements. For an element to be recognized |
| @@ -653,7 +653,7 @@ of any type is used. | |||
| 653 | 653 | ||
| 654 | As usual with XML-related technologies, resources are identified | 654 | As usual with XML-related technologies, resources are identified |
| 655 | by URIs. The @samp{uri} attribute identifies the schema by | 655 | by URIs. The @samp{uri} attribute identifies the schema by |
| 656 | specifying the URI. The URI may be relative. If so, it is resolved | 656 | specifying the URI@. The URI may be relative. If so, it is resolved |
| 657 | relative to the URI of the schema locating file that contains | 657 | relative to the URI of the schema locating file that contains |
| 658 | attribute. This means that if the value of @samp{uri} attribute | 658 | attribute. This means that if the value of @samp{uri} attribute |
| 659 | does not contain a @samp{/}, then it will refer to a filename in | 659 | does not contain a @samp{/}, then it will refer to a filename in |
| @@ -680,13 +680,13 @@ The @samp{pattern} attribute can be used instead of the | |||
| 680 | whose URI matches a pattern. The pattern has the same syntax as an | 680 | whose URI matches a pattern. The pattern has the same syntax as an |
| 681 | absolute or relative URI except that the path component of the URI can | 681 | absolute or relative URI except that the path component of the URI can |
| 682 | use a @samp{*} character to stand for zero or more characters | 682 | use a @samp{*} character to stand for zero or more characters |
| 683 | within a path segment (i.e. any character other @samp{/}). | 683 | within a path segment (i.e., any character other @samp{/}). |
| 684 | Typically, the URI pattern looks like a relative URI, but, whereas a | 684 | Typically, the URI pattern looks like a relative URI, but, whereas a |
| 685 | relative URI in the @samp{resource} attribute is resolved into a | 685 | relative URI in the @samp{resource} attribute is resolved into a |
| 686 | particular absolute URI using the base URI of the schema locating | 686 | particular absolute URI using the base URI of the schema locating |
| 687 | file, a relative URI pattern matches if it matches some number of | 687 | file, a relative URI pattern matches if it matches some number of |
| 688 | complete path segments of the document's URI ending with the last path | 688 | complete path segments of the document's URI ending with the last path |
| 689 | segment of the document's URI. For example, | 689 | segment of the document's URI@. For example, |
| 690 | 690 | ||
| 691 | @example | 691 | @example |
| 692 | <uri pattern="*.xsl" uri="xslt.rnc"/> | 692 | <uri pattern="*.xsl" uri="xslt.rnc"/> |
| @@ -757,7 +757,7 @@ specifies that when the namespace URI of the document is | |||
| 757 | Type identifiers allow a level of indirection in locating the | 757 | Type identifiers allow a level of indirection in locating the |
| 758 | schema for a document. Instead of associating the document directly | 758 | schema for a document. Instead of associating the document directly |
| 759 | with a schema URI, the document is associated with a type identifier, | 759 | with a schema URI, the document is associated with a type identifier, |
| 760 | which is in turn associated with a schema URI. nXML mode does not | 760 | which is in turn associated with a schema URI@. nXML mode does not |
| 761 | constrain the format of type identifiers. They can be simply strings | 761 | constrain the format of type identifiers. They can be simply strings |
| 762 | without any formal structure or they can be public identifiers or | 762 | without any formal structure or they can be public identifiers or |
| 763 | URIs. Note that these type identifiers have nothing to do with the | 763 | URIs. Note that these type identifiers have nothing to do with the |
| @@ -862,12 +862,12 @@ an @samp{applyFollowingRules} to the private file. | |||
| 862 | @chapter DTDs | 862 | @chapter DTDs |
| 863 | 863 | ||
| 864 | nXML mode is designed to support the creation of standalone XML | 864 | nXML mode is designed to support the creation of standalone XML |
| 865 | documents that do not depend on a DTD. Although it is common practice | 865 | documents that do not depend on a DTD@. Although it is common practice |
| 866 | to insert a DOCTYPE declaration referencing an external DTD, this has | 866 | to insert a DOCTYPE declaration referencing an external DTD, this has |
| 867 | undesirable side-effects. It means that the document is no longer | 867 | undesirable side-effects. It means that the document is no longer |
| 868 | self-contained. It also means that different XML parsers may interpret | 868 | self-contained. It also means that different XML parsers may interpret |
| 869 | the document in different ways, since the XML Recommendation does not | 869 | the document in different ways, since the XML Recommendation does not |
| 870 | require XML parsers to read the DTD. With DTDs, it was impractical to | 870 | require XML parsers to read the DTD@. With DTDs, it was impractical to |
| 871 | get validation without using an external DTD or reference to an | 871 | get validation without using an external DTD or reference to an |
| 872 | parameter entity. With RELAX NG and other schema languages, you can | 872 | parameter entity. With RELAX NG and other schema languages, you can |
| 873 | simultaneously get the benefits of validation and standalone XML | 873 | simultaneously get the benefits of validation and standalone XML |
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index a69dc0fd81f..700dffd26bf 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi | |||
| @@ -478,7 +478,7 @@ Capture - Refile - Archive | |||
| 478 | * Capture:: Capturing new stuff | 478 | * Capture:: Capturing new stuff |
| 479 | * Attachments:: Add files to tasks | 479 | * Attachments:: Add files to tasks |
| 480 | * RSS Feeds:: Getting input from RSS feeds | 480 | * RSS Feeds:: Getting input from RSS feeds |
| 481 | * Protocols:: External (e.g.@: Browser) access to Emacs and Org | 481 | * Protocols:: External (e.g., Browser) access to Emacs and Org |
| 482 | * Refiling notes:: Moving a tree from one place to another | 482 | * Refiling notes:: Moving a tree from one place to another |
| 483 | * Archiving:: What to do with finished projects | 483 | * Archiving:: What to do with finished projects |
| 484 | 484 | ||
| @@ -838,7 +838,7 @@ ends, for example: | |||
| 838 | @cindex FAQ | 838 | @cindex FAQ |
| 839 | There is a website for Org which provides links to the newest | 839 | There is a website for Org which provides links to the newest |
| 840 | version of Org, as well as additional information, frequently asked | 840 | version of Org, as well as additional information, frequently asked |
| 841 | questions (FAQ), links to tutorials, etc@. This page is located at | 841 | questions (FAQ), links to tutorials, etc. This page is located at |
| 842 | @uref{http://orgmode.org}. | 842 | @uref{http://orgmode.org}. |
| 843 | 843 | ||
| 844 | @cindex print edition | 844 | @cindex print edition |
| @@ -996,7 +996,7 @@ packages, please take the time to check the list (@pxref{Conflicts}). | |||
| 996 | 996 | ||
| 997 | The four Org commands @command{org-store-link}, @command{org-capture}, | 997 | The four Org commands @command{org-store-link}, @command{org-capture}, |
| 998 | @command{org-agenda}, and @command{org-iswitchb} should be accessible through | 998 | @command{org-agenda}, and @command{org-iswitchb} should be accessible through |
| 999 | global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are | 999 | global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are |
| 1000 | suggested bindings for these keys, please modify the keys to your own | 1000 | suggested bindings for these keys, please modify the keys to your own |
| 1001 | liking. | 1001 | liking. |
| 1002 | @lisp | 1002 | @lisp |
| @@ -1324,7 +1324,7 @@ Expose all the headings of the subtree, CONTENT view for just one subtree. | |||
| 1324 | @cindex show children, command | 1324 | @cindex show children, command |
| 1325 | @orgcmd{C-c @key{TAB},show-children} | 1325 | @orgcmd{C-c @key{TAB},show-children} |
| 1326 | Expose all direct children of the subtree. With a numeric prefix argument N, | 1326 | Expose all direct children of the subtree. With a numeric prefix argument N, |
| 1327 | expose all children down to level N. | 1327 | expose all children down to level N@. |
| 1328 | @orgcmd{C-c C-x b,org-tree-to-indirect-buffer} | 1328 | @orgcmd{C-c C-x b,org-tree-to-indirect-buffer} |
| 1329 | Show the current subtree in an indirect buffer@footnote{The indirect | 1329 | Show the current subtree in an indirect buffer@footnote{The indirect |
| 1330 | buffer | 1330 | buffer |
| @@ -1351,7 +1351,7 @@ Copy the @i{visible} text in the region into the kill ring. | |||
| 1351 | @cindex @code{showeverything}, STARTUP keyword | 1351 | @cindex @code{showeverything}, STARTUP keyword |
| 1352 | 1352 | ||
| 1353 | When Emacs first visits an Org file, the global state is set to | 1353 | When Emacs first visits an Org file, the global state is set to |
| 1354 | OVERVIEW, i.e.@: only the top level headlines are visible. This can be | 1354 | OVERVIEW, i.e., only the top level headlines are visible. This can be |
| 1355 | configured through the variable @code{org-startup-folded}, or on a | 1355 | configured through the variable @code{org-startup-folded}, or on a |
| 1356 | per-file basis by adding one of the following lines anywhere in the | 1356 | per-file basis by adding one of the following lines anywhere in the |
| 1357 | buffer: | 1357 | buffer: |
| @@ -1371,7 +1371,7 @@ for this property are @code{folded}, @code{children}, @code{content}, and | |||
| 1371 | @code{all}. | 1371 | @code{all}. |
| 1372 | @table @asis | 1372 | @table @asis |
| 1373 | @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility} | 1373 | @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility} |
| 1374 | Switch back to the startup visibility of the buffer, i.e.@: whatever is | 1374 | Switch back to the startup visibility of the buffer, i.e., whatever is |
| 1375 | requested by startup options and @samp{VISIBILITY} properties in individual | 1375 | requested by startup options and @samp{VISIBILITY} properties in individual |
| 1376 | entries. | 1376 | entries. |
| 1377 | @end table | 1377 | @end table |
| @@ -1440,7 +1440,7 @@ headline@footnote{If you do not want the line to be split, customize the | |||
| 1440 | variable @code{org-M-RET-may-split-line}.}. If the command is used at the | 1440 | variable @code{org-M-RET-may-split-line}.}. If the command is used at the |
| 1441 | beginning of a headline, the new headline is created before the current line. | 1441 | beginning of a headline, the new headline is created before the current line. |
| 1442 | If at the beginning of any other line, the content of that line is made the | 1442 | If at the beginning of any other line, the content of that line is made the |
| 1443 | new heading. If the command is used at the end of a folded subtree (i.e.@: | 1443 | new heading. If the command is used at the end of a folded subtree (i.e., |
| 1444 | behind the ellipses at the end of a headline), then a headline like the | 1444 | behind the ellipses at the end of a headline), then a headline like the |
| 1445 | current one will be inserted after the end of the subtree. | 1445 | current one will be inserted after the end of the subtree. |
| 1446 | @orgcmd{C-@key{RET},org-insert-heading-respect-content} | 1446 | @orgcmd{C-@key{RET},org-insert-heading-respect-content} |
| @@ -1474,7 +1474,7 @@ level). | |||
| 1474 | @orgcmd{M-S-@key{down},org-move-subtree-down} | 1474 | @orgcmd{M-S-@key{down},org-move-subtree-down} |
| 1475 | Move subtree down (swap with next subtree of same level). | 1475 | Move subtree down (swap with next subtree of same level). |
| 1476 | @orgcmd{C-c C-x C-w,org-cut-subtree} | 1476 | @orgcmd{C-c C-x C-w,org-cut-subtree} |
| 1477 | Kill subtree, i.e.@: remove it from buffer but save in kill ring. | 1477 | Kill subtree, i.e., remove it from buffer but save in kill ring. |
| 1478 | With a numeric prefix argument N, kill N sequential subtrees. | 1478 | With a numeric prefix argument N, kill N sequential subtrees. |
| 1479 | @orgcmd{C-c C-x M-w,org-copy-subtree} | 1479 | @orgcmd{C-c C-x M-w,org-copy-subtree} |
| 1480 | Copy subtree to kill ring. With a numeric prefix argument N, copy the N | 1480 | Copy subtree to kill ring. With a numeric prefix argument N, copy the N |
| @@ -1649,7 +1649,7 @@ a right parenthesis@footnote{You can filter out any of them by configuring | |||
| 1649 | @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize | 1649 | @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize |
| 1650 | confusion with normal text, those are limited to one character only. Beyond | 1650 | confusion with normal text, those are limited to one character only. Beyond |
| 1651 | that limit, bullets will automatically fallback to numbers.}. If you want a | 1651 | that limit, bullets will automatically fallback to numbers.}. If you want a |
| 1652 | list to start with a different value (e.g.@: 20), start the text of the item | 1652 | list to start with a different value (e.g., 20), start the text of the item |
| 1653 | with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie | 1653 | with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie |
| 1654 | must be put @emph{before} the checkbox. If you have activated alphabetical | 1654 | must be put @emph{before} the checkbox. If you have activated alphabetical |
| 1655 | lists, you can also use counters like @code{[@@b]}.}. Those constructs can | 1655 | lists, you can also use counters like @code{[@@b]}.}. Those constructs can |
| @@ -1896,7 +1896,7 @@ or on a per-file basis by using | |||
| 1896 | Org mode supports the creation of footnotes. In contrast to the | 1896 | Org mode supports the creation of footnotes. In contrast to the |
| 1897 | @file{footnote.el} package, Org mode's footnotes are designed for work on a | 1897 | @file{footnote.el} package, Org mode's footnotes are designed for work on a |
| 1898 | larger document, not only for one-off documents like emails. The basic | 1898 | larger document, not only for one-off documents like emails. The basic |
| 1899 | syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is | 1899 | syntax is similar to the one used by @file{footnote.el}, i.e., a footnote is |
| 1900 | defined in a paragraph that is started by a footnote marker in square | 1900 | defined in a paragraph that is started by a footnote marker in square |
| 1901 | brackets in column 0, no indentation allowed. If you need a paragraph break | 1901 | brackets in column 0, no indentation allowed. If you need a paragraph break |
| 1902 | inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference | 1902 | inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference |
| @@ -1973,7 +1973,7 @@ S @r{Short for first @code{r}, then @code{s} action.} | |||
| 1973 | n @r{Normalize the footnotes by collecting all definitions (including} | 1973 | n @r{Normalize the footnotes by collecting all definitions (including} |
| 1974 | @r{inline definitions) into a special section, and then numbering them} | 1974 | @r{inline definitions) into a special section, and then numbering them} |
| 1975 | @r{in sequence. The references will then also be numbers. This is} | 1975 | @r{in sequence. The references will then also be numbers. This is} |
| 1976 | @r{meant to be the final step before finishing a document (e.g.@: sending} | 1976 | @r{meant to be the final step before finishing a document (e.g., sending} |
| 1977 | @r{off an email). The exporters do this automatically, and so could} | 1977 | @r{off an email). The exporters do this automatically, and so could} |
| 1978 | @r{something like @code{message-send-hook}.} | 1978 | @r{something like @code{message-send-hook}.} |
| 1979 | d @r{Delete the footnote at point, and all definitions of and references} | 1979 | d @r{Delete the footnote at point, and all definitions of and references} |
| @@ -2044,7 +2044,7 @@ calculations are supported using the Emacs @file{calc} package | |||
| 2044 | @section The built-in table editor | 2044 | @section The built-in table editor |
| 2045 | @cindex table editor, built-in | 2045 | @cindex table editor, built-in |
| 2046 | 2046 | ||
| 2047 | Org makes it easy to format tables in plain ASCII. Any line with @samp{|} as | 2047 | Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as |
| 2048 | the first non-whitespace character is considered part of a table. @samp{|} | 2048 | the first non-whitespace character is considered part of a table. @samp{|} |
| 2049 | is also the column separator@footnote{To insert a vertical bar into a table | 2049 | is also the column separator@footnote{To insert a vertical bar into a table |
| 2050 | field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table | 2050 | field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table |
| @@ -2429,7 +2429,7 @@ representation that looks like this: | |||
| 2429 | @end example | 2429 | @end example |
| 2430 | 2430 | ||
| 2431 | Column specifications can be absolute like @code{$1}, | 2431 | Column specifications can be absolute like @code{$1}, |
| 2432 | @code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the | 2432 | @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the |
| 2433 | column of the field which is being computed) like @code{$+1} or @code{$-2}. | 2433 | column of the field which is being computed) like @code{$+1} or @code{$-2}. |
| 2434 | @code{$<} and @code{$>} are immutable references to the first and last | 2434 | @code{$<} and @code{$>} are immutable references to the first and last |
| 2435 | column, respectively, and you can use @code{$>>>} to indicate the third | 2435 | column, respectively, and you can use @code{$>>>} to indicate the third |
| @@ -2445,13 +2445,13 @@ a stable way to the 5th and 12th field in the last row of the table. | |||
| 2445 | However, this syntax is deprecated, it should not be used for new documents. | 2445 | However, this syntax is deprecated, it should not be used for new documents. |
| 2446 | Use @code{@@>$} instead.} row in the table, respectively. You may also | 2446 | Use @code{@@>$} instead.} row in the table, respectively. You may also |
| 2447 | specify the row relative to one of the hlines: @code{@@I} refers to the first | 2447 | specify the row relative to one of the hlines: @code{@@I} refers to the first |
| 2448 | hline, @code{@@II} to the second, etc@. @code{@@-I} refers to the first such | 2448 | hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such |
| 2449 | line above the current line, @code{@@+I} to the first such line below the | 2449 | line above the current line, @code{@@+I} to the first such line below the |
| 2450 | current line. You can also write @code{@@III+2} which is the second data line | 2450 | current line. You can also write @code{@@III+2} which is the second data line |
| 2451 | after the third hline in the table. | 2451 | after the third hline in the table. |
| 2452 | 2452 | ||
| 2453 | @code{@@0} and @code{$0} refer to the current row and column, respectively, | 2453 | @code{@@0} and @code{$0} refer to the current row and column, respectively, |
| 2454 | i.e. to the row/column for the field being computed. Also, if you omit | 2454 | i.e., to the row/column for the field being computed. Also, if you omit |
| 2455 | either the column or the row part of the reference, the current row/column is | 2455 | either the column or the row part of the reference, the current row/column is |
| 2456 | implied. | 2456 | implied. |
| 2457 | 2457 | ||
| @@ -2810,7 +2810,7 @@ following command: | |||
| 2810 | Install a new formula for the current column and replace current field with | 2810 | Install a new formula for the current column and replace current field with |
| 2811 | the result of the formula. The command prompts for a formula, with default | 2811 | the result of the formula. The command prompts for a formula, with default |
| 2812 | taken from the @samp{#+TBLFM} line, applies it to the current field and | 2812 | taken from the @samp{#+TBLFM} line, applies it to the current field and |
| 2813 | stores it. With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command | 2813 | stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command |
| 2814 | will apply it to that many consecutive fields in the current column. | 2814 | will apply it to that many consecutive fields in the current column. |
| 2815 | @end table | 2815 | @end table |
| 2816 | 2816 | ||
| @@ -3115,7 +3115,7 @@ Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}. | |||
| 3115 | 3115 | ||
| 3116 | @item with | 3116 | @item with |
| 3117 | Specify a @code{with} option to be inserted for every col being plotted | 3117 | Specify a @code{with} option to be inserted for every col being plotted |
| 3118 | (e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). | 3118 | (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). |
| 3119 | Defaults to @code{lines}. | 3119 | Defaults to @code{lines}. |
| 3120 | 3120 | ||
| 3121 | @item file | 3121 | @item file |
| @@ -3519,7 +3519,7 @@ variable @code{org-display-internal-link-with-indirect-buffer}}. | |||
| 3519 | @cindex @code{inlineimages}, STARTUP keyword | 3519 | @cindex @code{inlineimages}, STARTUP keyword |
| 3520 | @cindex @code{noinlineimages}, STARTUP keyword | 3520 | @cindex @code{noinlineimages}, STARTUP keyword |
| 3521 | Toggle the inline display of linked images. Normally this will only inline | 3521 | Toggle the inline display of linked images. Normally this will only inline |
| 3522 | images that have no description part in the link, i.e.@: images that will also | 3522 | images that have no description part in the link, i.e., images that will also |
| 3523 | be inlined during export. When called with a prefix argument, also display | 3523 | be inlined during export. When called with a prefix argument, also display |
| 3524 | images that do have a link description. You can ask for inline images to be | 3524 | images that do have a link description. You can ask for inline images to be |
| 3525 | displayed at startup by configuring the variable | 3525 | displayed at startup by configuring the variable |
| @@ -3629,7 +3629,7 @@ can define them in the file with | |||
| 3629 | @noindent | 3629 | @noindent |
| 3630 | In-buffer completion (@pxref{Completion}) can be used after @samp{[} to | 3630 | In-buffer completion (@pxref{Completion}) can be used after @samp{[} to |
| 3631 | complete link abbreviations. You may also define a function | 3631 | complete link abbreviations. You may also define a function |
| 3632 | @code{org-PREFIX-complete-link} that implements special (e.g.@: completion) | 3632 | @code{org-PREFIX-complete-link} that implements special (e.g., completion) |
| 3633 | support for inserting such a link with @kbd{C-c C-l}. Such a function should | 3633 | support for inserting such a link with @kbd{C-c C-l}. Such a function should |
| 3634 | not accept any arguments, and return the full link with prefix. | 3634 | not accept any arguments, and return the full link with prefix. |
| 3635 | 3635 | ||
| @@ -3781,7 +3781,7 @@ with @code{shift-selection-mode}. See also the variable | |||
| 3781 | View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the | 3781 | View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the |
| 3782 | entire buffer, but shows all TODO items (with not-DONE state) and the | 3782 | entire buffer, but shows all TODO items (with not-DONE state) and the |
| 3783 | headings hierarchy above them. With a prefix argument (or by using @kbd{C-c | 3783 | headings hierarchy above them. With a prefix argument (or by using @kbd{C-c |
| 3784 | / T}), search for a specific TODO. You will be prompted for the keyword, and | 3784 | / T}), search for a specific TODO@. You will be prompted for the keyword, and |
| 3785 | you can also give a list of keywords like @code{KWD1|KWD2|...} to list | 3785 | you can also give a list of keywords like @code{KWD1|KWD2|...} to list |
| 3786 | entries that match any one of these keywords. With a numeric prefix argument | 3786 | entries that match any one of these keywords. With a numeric prefix argument |
| 3787 | N, show the tree for the Nth keyword in the variable | 3787 | N, show the tree for the Nth keyword in the variable |
| @@ -3808,7 +3808,7 @@ option @code{org-todo-state-tags-triggers} for details. | |||
| 3808 | 3808 | ||
| 3809 | @vindex org-todo-keywords | 3809 | @vindex org-todo-keywords |
| 3810 | By default, marked TODO entries have one of only two states: TODO and | 3810 | By default, marked TODO entries have one of only two states: TODO and |
| 3811 | DONE. Org mode allows you to classify TODO items in more complex ways | 3811 | DONE@. Org mode allows you to classify TODO items in more complex ways |
| 3812 | with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With | 3812 | with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With |
| 3813 | special setup, the TODO keyword system can work differently in different | 3813 | special setup, the TODO keyword system can work differently in different |
| 3814 | files. | 3814 | files. |
| @@ -3847,9 +3847,9 @@ you don't provide the separator bar, the last state is used as the DONE | |||
| 3847 | state. | 3847 | state. |
| 3848 | @cindex completion, of TODO keywords | 3848 | @cindex completion, of TODO keywords |
| 3849 | With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO | 3849 | With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO |
| 3850 | to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may | 3850 | to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may |
| 3851 | also use a numeric prefix argument to quickly select a specific state. For | 3851 | also use a numeric prefix argument to quickly select a specific state. For |
| 3852 | example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY. | 3852 | example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@. |
| 3853 | Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you | 3853 | Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you |
| 3854 | define many keywords, you can use in-buffer completion | 3854 | define many keywords, you can use in-buffer completion |
| 3855 | (@pxref{Completion}) or even a special one-key selection scheme | 3855 | (@pxref{Completion}) or even a special one-key selection scheme |
| @@ -3876,13 +3876,13 @@ be set up like this: | |||
| 3876 | 3876 | ||
| 3877 | In this case, different keywords do not indicate a sequence, but rather | 3877 | In this case, different keywords do not indicate a sequence, but rather |
| 3878 | different types. So the normal work flow would be to assign a task to a | 3878 | different types. So the normal work flow would be to assign a task to a |
| 3879 | person, and later to mark it DONE. Org mode supports this style by adapting | 3879 | person, and later to mark it DONE@. Org mode supports this style by adapting |
| 3880 | the workings of the command @kbd{C-c C-t}@footnote{This is also true for the | 3880 | the workings of the command @kbd{C-c C-t}@footnote{This is also true for the |
| 3881 | @kbd{t} command in the timeline and agenda buffers.}. When used several | 3881 | @kbd{t} command in the timeline and agenda buffers.}. When used several |
| 3882 | times in succession, it will still cycle through all names, in order to first | 3882 | times in succession, it will still cycle through all names, in order to first |
| 3883 | select the right type for a task. But when you return to the item after some | 3883 | select the right type for a task. But when you return to the item after some |
| 3884 | time and execute @kbd{C-c C-t} again, it will switch from any name directly | 3884 | time and execute @kbd{C-c C-t} again, it will switch from any name directly |
| 3885 | to DONE. Use prefix arguments or completion to quickly select a specific | 3885 | to DONE@. Use prefix arguments or completion to quickly select a specific |
| 3886 | name. You can also review the items of a specific TODO type in a sparse tree | 3886 | name. You can also review the items of a specific TODO type in a sparse tree |
| 3887 | by using a numeric prefix to @kbd{C-c / t}. For example, to see all things | 3887 | by using a numeric prefix to @kbd{C-c / t}. For example, to see all things |
| 3888 | Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items | 3888 | Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items |
| @@ -4047,13 +4047,13 @@ foreground or a background color. | |||
| 4047 | @cindex property, ORDERED | 4047 | @cindex property, ORDERED |
| 4048 | The structure of Org files (hierarchy and lists) makes it easy to define TODO | 4048 | The structure of Org files (hierarchy and lists) makes it easy to define TODO |
| 4049 | dependencies. Usually, a parent TODO task should not be marked DONE until | 4049 | dependencies. Usually, a parent TODO task should not be marked DONE until |
| 4050 | all subtasks (defined as children tasks) are marked as DONE. And sometimes | 4050 | all subtasks (defined as children tasks) are marked as DONE@. And sometimes |
| 4051 | there is a logical sequence to a number of (sub)tasks, so that one task | 4051 | there is a logical sequence to a number of (sub)tasks, so that one task |
| 4052 | cannot be acted upon before all siblings above it are done. If you customize | 4052 | cannot be acted upon before all siblings above it are done. If you customize |
| 4053 | the variable @code{org-enforce-todo-dependencies}, Org will block entries | 4053 | the variable @code{org-enforce-todo-dependencies}, Org will block entries |
| 4054 | from changing state to DONE while they have children that are not DONE. | 4054 | from changing state to DONE while they have children that are not DONE@. |
| 4055 | Furthermore, if an entry has a property @code{ORDERED}, each of its children | 4055 | Furthermore, if an entry has a property @code{ORDERED}, each of its children |
| 4056 | will be blocked until all earlier siblings are marked DONE. Here is an | 4056 | will be blocked until all earlier siblings are marked DONE@. Here is an |
| 4057 | example: | 4057 | example: |
| 4058 | 4058 | ||
| 4059 | @example | 4059 | @example |
| @@ -4194,7 +4194,7 @@ when you are using both @code{org-log-done} and state change logging. | |||
| 4194 | However, it will never prompt for two notes---if you have configured | 4194 | However, it will never prompt for two notes---if you have configured |
| 4195 | both, the state change recording note will take precedence and cancel | 4195 | both, the state change recording note will take precedence and cancel |
| 4196 | the @samp{Closing Note}.}, and that a note is recorded when switching to | 4196 | the @samp{Closing Note}.}, and that a note is recorded when switching to |
| 4197 | WAIT or CANCELED. The setting for WAIT is even more special: the | 4197 | WAIT or CANCELED@. The setting for WAIT is even more special: the |
| 4198 | @samp{!} after the slash means that in addition to the note taken when | 4198 | @samp{!} after the slash means that in addition to the note taken when |
| 4199 | entering the state, a timestamp should be recorded when @i{leaving} the | 4199 | entering the state, a timestamp should be recorded when @i{leaving} the |
| 4200 | WAIT state, if and only if the @i{target} state does not configure | 4200 | WAIT state, if and only if the @i{target} state does not configure |
| @@ -5265,7 +5265,7 @@ values. | |||
| 5265 | 5265 | ||
| 5266 | @noindent | 5266 | @noindent |
| 5267 | The first column, @samp{%25ITEM}, means the first 25 characters of the | 5267 | The first column, @samp{%25ITEM}, means the first 25 characters of the |
| 5268 | item itself, i.e.@: of the headline. You probably always should start the | 5268 | item itself, i.e., of the headline. You probably always should start the |
| 5269 | column definition with the @samp{ITEM} specifier. The other specifiers | 5269 | column definition with the @samp{ITEM} specifier. The other specifiers |
| 5270 | create columns @samp{Owner} with a list of names as allowed values, for | 5270 | create columns @samp{Owner} with a list of names as allowed values, for |
| 5271 | @samp{Status} with four different possible values, and for a checkbox | 5271 | @samp{Status} with four different possible values, and for a checkbox |
| @@ -5666,7 +5666,7 @@ letter ([dwmy]) to indicate change in days, weeks, months, or years. With a | |||
| 5666 | single plus or minus, the date is always relative to today. With a | 5666 | single plus or minus, the date is always relative to today. With a |
| 5667 | double plus or minus, it is relative to the default date. If instead of | 5667 | double plus or minus, it is relative to the default date. If instead of |
| 5668 | a single letter, you use the abbreviation of day name, the date will be | 5668 | a single letter, you use the abbreviation of day name, the date will be |
| 5669 | the Nth such day, e.g.@: | 5669 | the Nth such day, e.g.: |
| 5670 | 5670 | ||
| 5671 | @example | 5671 | @example |
| 5672 | +0 @result{} today | 5672 | +0 @result{} today |
| @@ -5694,7 +5694,7 @@ read the docstring of the variable | |||
| 5694 | You can specify a time range by giving start and end times or by giving a | 5694 | You can specify a time range by giving start and end times or by giving a |
| 5695 | start time and a duration (in HH:MM format). Use one or two dash(es) as the | 5695 | start time and a duration (in HH:MM format). Use one or two dash(es) as the |
| 5696 | separator in the former case and use '+' as the separator in the latter | 5696 | separator in the former case and use '+' as the separator in the latter |
| 5697 | case, e.g.@: | 5697 | case, e.g.: |
| 5698 | 5698 | ||
| 5699 | @example | 5699 | @example |
| 5700 | 11am-1:15pm @result{} 11:00-13:15 | 5700 | 11am-1:15pm @result{} 11:00-13:15 |
| @@ -5807,7 +5807,7 @@ On the deadline date, the task will be listed in the agenda. In | |||
| 5807 | addition, the agenda for @emph{today} will carry a warning about the | 5807 | addition, the agenda for @emph{today} will carry a warning about the |
| 5808 | approaching or missed deadline, starting | 5808 | approaching or missed deadline, starting |
| 5809 | @code{org-deadline-warning-days} before the due date, and continuing | 5809 | @code{org-deadline-warning-days} before the due date, and continuing |
| 5810 | until the entry is marked DONE. An example: | 5810 | until the entry is marked DONE@. An example: |
| 5811 | 5811 | ||
| 5812 | @example | 5812 | @example |
| 5813 | *** TODO write article about the Earth for the Guide | 5813 | *** TODO write article about the Earth for the Guide |
| @@ -5827,10 +5827,10 @@ date. | |||
| 5827 | 5827 | ||
| 5828 | @vindex org-agenda-skip-scheduled-if-done | 5828 | @vindex org-agenda-skip-scheduled-if-done |
| 5829 | The headline will be listed under the given date@footnote{It will still | 5829 | The headline will be listed under the given date@footnote{It will still |
| 5830 | be listed on that date after it has been marked DONE. If you don't like | 5830 | be listed on that date after it has been marked DONE@. If you don't like |
| 5831 | this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In | 5831 | this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In |
| 5832 | addition, a reminder that the scheduled date has passed will be present | 5832 | addition, a reminder that the scheduled date has passed will be present |
| 5833 | in the compilation for @emph{today}, until the entry is marked DONE, i.e.@: | 5833 | in the compilation for @emph{today}, until the entry is marked DONE, i.e., |
| 5834 | the task will automatically be forwarded until completed. | 5834 | the task will automatically be forwarded until completed. |
| 5835 | 5835 | ||
| 5836 | @example | 5836 | @example |
| @@ -5919,7 +5919,7 @@ Sparse tree for deadlines and scheduled items after a given date. | |||
| 5919 | @end table | 5919 | @end table |
| 5920 | 5920 | ||
| 5921 | Note that @code{org-schedule} and @code{org-deadline} supports | 5921 | Note that @code{org-schedule} and @code{org-deadline} supports |
| 5922 | setting the date by indicating a relative time: e.g. +1d will set | 5922 | setting the date by indicating a relative time: e.g., +1d will set |
| 5923 | the date to the next day after today, and --1w will set the date | 5923 | the date to the next day after today, and --1w will set the date |
| 5924 | to the previous week before any current timestamp. | 5924 | to the previous week before any current timestamp. |
| 5925 | 5925 | ||
| @@ -6488,7 +6488,7 @@ trees to an archive file keeps the system compact and fast. | |||
| 6488 | * Capture:: Capturing new stuff | 6488 | * Capture:: Capturing new stuff |
| 6489 | * Attachments:: Add files to tasks | 6489 | * Attachments:: Add files to tasks |
| 6490 | * RSS Feeds:: Getting input from RSS feeds | 6490 | * RSS Feeds:: Getting input from RSS feeds |
| 6491 | * Protocols:: External (e.g.@: Browser) access to Emacs and Org | 6491 | * Protocols:: External (e.g., Browser) access to Emacs and Org |
| 6492 | * Refiling notes:: Moving a tree from one place to another | 6492 | * Refiling notes:: Moving a tree from one place to another |
| 6493 | * Archiving:: What to do with finished projects | 6493 | * Archiving:: What to do with finished projects |
| 6494 | @end menu | 6494 | @end menu |
| @@ -7676,7 +7676,7 @@ commands}. | |||
| 7676 | 7676 | ||
| 7677 | @cindex Boolean logic, for tag/property searches | 7677 | @cindex Boolean logic, for tag/property searches |
| 7678 | A search string can use Boolean operators @samp{&} for AND and @samp{|} for | 7678 | A search string can use Boolean operators @samp{&} for AND and @samp{|} for |
| 7679 | OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently | 7679 | OR@. @samp{&} binds more strongly than @samp{|}. Parentheses are currently |
| 7680 | not implemented. Each element in the search is either a tag, a regular | 7680 | not implemented. Each element in the search is either a tag, a regular |
| 7681 | expression matching tags, or an expression like @code{PROPERTY OPERATOR | 7681 | expression matching tags, or an expression like @code{PROPERTY OPERATOR |
| 7682 | VALUE} with a comparison operator, accessing a property value. Each element | 7682 | VALUE} with a comparison operator, accessing a property value. Each element |
| @@ -7712,7 +7712,7 @@ example, the ``property'' @code{TODO} represents the TODO keyword of the | |||
| 7712 | entry. Or, the ``property'' @code{LEVEL} represents the level of an entry. | 7712 | entry. Or, the ``property'' @code{LEVEL} represents the level of an entry. |
| 7713 | So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines | 7713 | So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines |
| 7714 | that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword | 7714 | that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword |
| 7715 | DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not | 7715 | DONE@. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not |
| 7716 | count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc. | 7716 | count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc. |
| 7717 | The ITEM special property cannot currently be used in tags/property | 7717 | The ITEM special property cannot currently be used in tags/property |
| 7718 | searches@footnote{But @pxref{x-agenda-skip-entry-regexp, | 7718 | searches@footnote{But @pxref{x-agenda-skip-entry-regexp, |
| @@ -7751,7 +7751,7 @@ brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are | |||
| 7751 | assumed to be date/time specifications in the standard Org way, and the | 7751 | assumed to be date/time specifications in the standard Org way, and the |
| 7752 | comparison will be done accordingly. Special values that will be recognized | 7752 | comparison will be done accordingly. Special values that will be recognized |
| 7753 | are @code{"<now>"} for now (including time), and @code{"<today>"}, and | 7753 | are @code{"<now>"} for now (including time), and @code{"<today>"}, and |
| 7754 | @code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time | 7754 | @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time |
| 7755 | specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units | 7755 | specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units |
| 7756 | @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year, | 7756 | @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year, |
| 7757 | respectively, can be used. | 7757 | respectively, can be used. |
| @@ -7784,7 +7784,7 @@ tags/property part of the search string (which may include several terms | |||
| 7784 | connected with @samp{|}) with a @samp{/} and then specify a Boolean | 7784 | connected with @samp{|}) with a @samp{/} and then specify a Boolean |
| 7785 | expression just for TODO keywords. The syntax is then similar to that for | 7785 | expression just for TODO keywords. The syntax is then similar to that for |
| 7786 | tags, but should be applied with care: for example, a positive selection on | 7786 | tags, but should be applied with care: for example, a positive selection on |
| 7787 | several TODO keywords cannot meaningfully be combined with boolean AND. | 7787 | several TODO keywords cannot meaningfully be combined with boolean AND@. |
| 7788 | However, @emph{negative selection} combined with AND can be meaningful. To | 7788 | However, @emph{negative selection} combined with AND can be meaningful. To |
| 7789 | make sure that only lines are checked that actually have any TODO keyword | 7789 | make sure that only lines are checked that actually have any TODO keyword |
| 7790 | (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO | 7790 | (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO |
| @@ -8175,7 +8175,7 @@ always show a table with the clocked times for the timespan and file scope | |||
| 8175 | covered by the current agenda view. The initial setting for this mode in new | 8175 | covered by the current agenda view. The initial setting for this mode in new |
| 8176 | agenda buffers can be set with the variable | 8176 | agenda buffers can be set with the variable |
| 8177 | @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument | 8177 | @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument |
| 8178 | when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show | 8178 | when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show |
| 8179 | contributions from entries that are hidden by agenda filtering@footnote{Only | 8179 | contributions from entries that are hidden by agenda filtering@footnote{Only |
| 8180 | tags filtering will be respected here, effort filtering is ignored.}. See | 8180 | tags filtering will be respected here, effort filtering is ignored.}. See |
| 8181 | also the variable @code{org-clock-report-include-clocking-task}. | 8181 | also the variable @code{org-clock-report-include-clocking-task}. |
| @@ -9337,7 +9337,7 @@ switch to the end of the @code{BEGIN} line, to get the lines of the example | |||
| 9337 | numbered. If you use a @code{+n} switch, the numbering from the previous | 9337 | numbered. If you use a @code{+n} switch, the numbering from the previous |
| 9338 | numbered snippet will be continued in the current one. In literal examples, | 9338 | numbered snippet will be continued in the current one. In literal examples, |
| 9339 | Org will interpret strings like @samp{(ref:name)} as labels, and use them as | 9339 | Org will interpret strings like @samp{(ref:name)} as labels, and use them as |
| 9340 | targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name | 9340 | targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name |
| 9341 | enclosed in single parenthesis). In HTML, hovering the mouse over such a | 9341 | enclosed in single parenthesis). In HTML, hovering the mouse over such a |
| 9342 | link will remote-highlight the corresponding code line, which is kind of | 9342 | link will remote-highlight the corresponding code line, which is kind of |
| 9343 | cool. | 9343 | cool. |
| @@ -9408,7 +9408,7 @@ include your @file{.emacs} file, you could use: | |||
| 9408 | #+INCLUDE: "~/.emacs" src emacs-lisp | 9408 | #+INCLUDE: "~/.emacs" src emacs-lisp |
| 9409 | @end example | 9409 | @end example |
| 9410 | @noindent | 9410 | @noindent |
| 9411 | The optional second and third parameter are the markup (e.g.@: @samp{quote}, | 9411 | The optional second and third parameter are the markup (e.g., @samp{quote}, |
| 9412 | @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the | 9412 | @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the |
| 9413 | language for formatting the contents. The markup is optional; if it is not | 9413 | language for formatting the contents. The markup is optional; if it is not |
| 9414 | given, the text will be assumed to be in Org mode format and will be | 9414 | given, the text will be assumed to be in Org mode format and will be |
| @@ -9866,13 +9866,13 @@ Insert template with export options, see example below. | |||
| 9866 | #+AUTHOR: the author (default taken from @code{user-full-name}) | 9866 | #+AUTHOR: the author (default taken from @code{user-full-name}) |
| 9867 | #+DATE: a date, an Org timestamp@footnote{@code{org-export-date-timestamp-format} defines how this timestamp will be exported.}, or a format string for @code{format-time-string} | 9867 | #+DATE: a date, an Org timestamp@footnote{@code{org-export-date-timestamp-format} defines how this timestamp will be exported.}, or a format string for @code{format-time-string} |
| 9868 | #+EMAIL: his/her email address (default from @code{user-mail-address}) | 9868 | #+EMAIL: his/her email address (default from @code{user-mail-address}) |
| 9869 | #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag | 9869 | #+DESCRIPTION: the page description, e.g., for the XHTML meta tag |
| 9870 | #+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag | 9870 | #+KEYWORDS: the page keywords, e.g., for the XHTML meta tag |
| 9871 | #+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language}) | 9871 | #+LANGUAGE: language for HTML, e.g., @samp{en} (@code{org-export-default-language}) |
| 9872 | #+TEXT: Some descriptive text to be inserted at the beginning. | 9872 | #+TEXT: Some descriptive text to be inserted at the beginning. |
| 9873 | #+TEXT: Several lines may be given. | 9873 | #+TEXT: Several lines may be given. |
| 9874 | #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... | 9874 | #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... |
| 9875 | #+BIND: lisp-var lisp-val, e.g.@:: @code{org-export-latex-low-levels itemize} | 9875 | #+BIND: lisp-var lisp-val, e.g., @code{org-export-latex-low-levels itemize} |
| 9876 | @r{You need to confirm using these, or configure @code{org-export-allow-BIND}} | 9876 | @r{You need to confirm using these, or configure @code{org-export-allow-BIND}} |
| 9877 | #+LINK_UP: the ``up'' link of an exported page | 9877 | #+LINK_UP: the ``up'' link of an exported page |
| 9878 | #+LINK_HOME: the ``home'' link of an exported page | 9878 | #+LINK_HOME: the ``home'' link of an exported page |
| @@ -9972,11 +9972,11 @@ separate Emacs process@footnote{To make this behavior the default, customize | |||
| 9972 | the variable @code{org-export-run-in-background}.}. | 9972 | the variable @code{org-export-run-in-background}.}. |
| 9973 | @orgcmd{C-c C-e v,org-export-visible} | 9973 | @orgcmd{C-c C-e v,org-export-visible} |
| 9974 | Like @kbd{C-c C-e}, but only export the text that is currently visible | 9974 | Like @kbd{C-c C-e}, but only export the text that is currently visible |
| 9975 | (i.e.@: not hidden by outline visibility). | 9975 | (i.e., not hidden by outline visibility). |
| 9976 | @orgcmd{C-u C-u C-c C-e,org-export} | 9976 | @orgcmd{C-u C-u C-c C-e,org-export} |
| 9977 | @vindex org-export-run-in-background | 9977 | @vindex org-export-run-in-background |
| 9978 | Call the exporter, but reverse the setting of | 9978 | Call the exporter, but reverse the setting of |
| 9979 | @code{org-export-run-in-background}, i.e.@: request background processing if | 9979 | @code{org-export-run-in-background}, i.e., request background processing if |
| 9980 | not set, or force processing in the current Emacs process if set. | 9980 | not set, or force processing in the current Emacs process if set. |
| 9981 | @end table | 9981 | @end table |
| 9982 | 9982 | ||
| @@ -9987,7 +9987,7 @@ not set, or force processing in the current Emacs process if set. | |||
| 9987 | @cindex UTF-8 export | 9987 | @cindex UTF-8 export |
| 9988 | 9988 | ||
| 9989 | ASCII export produces a simple and very readable version of an Org mode | 9989 | ASCII export produces a simple and very readable version of an Org mode |
| 9990 | file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file | 9990 | file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file |
| 9991 | with special characters and symbols available in these encodings. | 9991 | with special characters and symbols available in these encodings. |
| 9992 | 9992 | ||
| 9993 | @cindex region, active | 9993 | @cindex region, active |
| @@ -10179,7 +10179,7 @@ All lines between these markers are exported literally | |||
| 10179 | @cindex links, in HTML export | 10179 | @cindex links, in HTML export |
| 10180 | @cindex internal links, in HTML export | 10180 | @cindex internal links, in HTML export |
| 10181 | @cindex external links, in HTML export | 10181 | @cindex external links, in HTML export |
| 10182 | Internal links (@pxref{Internal links}) will continue to work in HTML. This | 10182 | Internal links (@pxref{Internal links}) will continue to work in HTML@. This |
| 10183 | includes automatic links created by radio targets (@pxref{Radio | 10183 | includes automatic links created by radio targets (@pxref{Radio |
| 10184 | targets}). Links to external files will still work if the target file is on | 10184 | targets}). Links to external files will still work if the target file is on |
| 10185 | the same @i{relative} path as the published Org file. Links to other | 10185 | the same @i{relative} path as the published Org file. Links to other |
| @@ -10919,7 +10919,7 @@ exported DocBook XML files invalid by not quoting DocBook code correctly. | |||
| 10919 | @cindex DocBook recursive sections | 10919 | @cindex DocBook recursive sections |
| 10920 | 10920 | ||
| 10921 | DocBook exporter exports Org files as articles using the @code{article} | 10921 | DocBook exporter exports Org files as articles using the @code{article} |
| 10922 | element in DocBook. Recursive sections, i.e.@: @code{section} elements, are | 10922 | element in DocBook. Recursive sections, i.e., @code{section} elements, are |
| 10923 | used in exported articles. Top level headlines in Org files are exported as | 10923 | used in exported articles. Top level headlines in Org files are exported as |
| 10924 | top level sections, and lower level headlines are exported as nested | 10924 | top level sections, and lower level headlines are exported as nested |
| 10925 | sections. The entire structure of Org files will be exported completely, no | 10925 | sections. The entire structure of Org files will be exported completely, no |
| @@ -11996,7 +11996,7 @@ time. | |||
| 11996 | 11996 | ||
| 11997 | @subsection Export of properties | 11997 | @subsection Export of properties |
| 11998 | 11998 | ||
| 11999 | The exporter also takes TODO state information into consideration, i.e.@: if a | 11999 | The exporter also takes TODO state information into consideration, i.e., if a |
| 12000 | task is marked as done it will have the corresponding attribute in | 12000 | task is marked as done it will have the corresponding attribute in |
| 12001 | TaskJuggler (@samp{complete 100}). Also it will export any property on a task | 12001 | TaskJuggler (@samp{complete 100}). Also it will export any property on a task |
| 12002 | resource or resource node which is known to TaskJuggler, such as | 12002 | resource or resource node which is known to TaskJuggler, such as |
| @@ -12048,7 +12048,7 @@ examples should illustrate this: | |||
| 12048 | @subsection Reports | 12048 | @subsection Reports |
| 12049 | 12049 | ||
| 12050 | @vindex org-export-taskjuggler-default-reports | 12050 | @vindex org-export-taskjuggler-default-reports |
| 12051 | TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource | 12051 | TaskJuggler can produce many kinds of reports (e.g., gantt chart, resource |
| 12052 | allocation, etc). The user defines what kind of reports should be generated | 12052 | allocation, etc). The user defines what kind of reports should be generated |
| 12053 | for a project in the TaskJuggler file. The exporter will automatically insert | 12053 | for a project in the TaskJuggler file. The exporter will automatically insert |
| 12054 | some default reports in the file. These defaults are defined in | 12054 | some default reports in the file. These defaults are defined in |
| @@ -12104,7 +12104,7 @@ files in the calendar application. Org mode can export calendar information | |||
| 12104 | in the standard iCalendar format. If you also want to have TODO entries | 12104 | in the standard iCalendar format. If you also want to have TODO entries |
| 12105 | included in the export, configure the variable | 12105 | included in the export, configure the variable |
| 12106 | @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT, | 12106 | @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT, |
| 12107 | and TODO items as VTODO. It will also create events from deadlines that are | 12107 | and TODO items as VTODO@. It will also create events from deadlines that are |
| 12108 | in non-TODO items. Deadlines and scheduling dates in TODO items will be used | 12108 | in non-TODO items. Deadlines and scheduling dates in TODO items will be used |
| 12109 | to set the start and due dates for the TODO entry@footnote{See the variables | 12109 | to set the start and due dates for the TODO entry@footnote{See the variables |
| 12110 | @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}. | 12110 | @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}. |
| @@ -12208,7 +12208,7 @@ configures one project, and may be in one of the two following forms: | |||
| 12208 | 12208 | ||
| 12209 | @lisp | 12209 | @lisp |
| 12210 | ("project-name" :property value :property value ...) | 12210 | ("project-name" :property value :property value ...) |
| 12211 | @r{i.e.@: a well-formed property list with alternating keys and values} | 12211 | @r{i.e., a well-formed property list with alternating keys and values} |
| 12212 | @r{or} | 12212 | @r{or} |
| 12213 | ("project-name" :components ("project-name" "project-name" ...)) | 12213 | ("project-name" :components ("project-name" "project-name" ...)) |
| 12214 | 12214 | ||
| @@ -12452,7 +12452,7 @@ something like @samp{[[file:foo.org][The foo]]} or simply | |||
| 12452 | @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link | 12452 | @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link |
| 12453 | becomes a link to @file{foo.html}. In this way, you can interlink the | 12453 | becomes a link to @file{foo.html}. In this way, you can interlink the |
| 12454 | pages of your "org web" project and the links will work as expected when | 12454 | pages of your "org web" project and the links will work as expected when |
| 12455 | you publish them to HTML. If you also publish the Org source file and want | 12455 | you publish them to HTML@. If you also publish the Org source file and want |
| 12456 | to link to that, use an @code{http:} link instead of a @code{file:} link, | 12456 | to link to that, use an @code{http:} link instead of a @code{file:} link, |
| 12457 | because @code{file:} links are converted to link to the corresponding | 12457 | because @code{file:} links are converted to link to the corresponding |
| 12458 | @file{html} file. | 12458 | @file{html} file. |
| @@ -12704,7 +12704,7 @@ This may be necessary in particular if files include other files via | |||
| 12704 | @cindex source code, working with | 12704 | @cindex source code, working with |
| 12705 | 12705 | ||
| 12706 | Source code can be included in Org mode documents using a @samp{src} block, | 12706 | Source code can be included in Org mode documents using a @samp{src} block, |
| 12707 | e.g.@: | 12707 | e.g.: |
| 12708 | 12708 | ||
| 12709 | @example | 12709 | @example |
| 12710 | #+BEGIN_SRC emacs-lisp | 12710 | #+BEGIN_SRC emacs-lisp |
| @@ -12852,7 +12852,7 @@ variable @code{org-src-fontify-natively}. | |||
| 12852 | It is possible to export the @emph{code} of code blocks, the @emph{results} | 12852 | It is possible to export the @emph{code} of code blocks, the @emph{results} |
| 12853 | of code block evaluation, @emph{both} the code and the results of code block | 12853 | of code block evaluation, @emph{both} the code and the results of code block |
| 12854 | evaluation, or @emph{none}. For most languages, the default exports code. | 12854 | evaluation, or @emph{none}. For most languages, the default exports code. |
| 12855 | However, for some languages (e.g.@: @code{ditaa}) the default exports the | 12855 | However, for some languages (e.g., @code{ditaa}) the default exports the |
| 12856 | results of code block evaluation. For information on exporting code block | 12856 | results of code block evaluation. For information on exporting code block |
| 12857 | bodies, see @ref{Literal examples}. | 12857 | bodies, see @ref{Literal examples}. |
| 12858 | 12858 | ||
| @@ -13737,7 +13737,7 @@ then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets | |||
| 13737 | the value of the Emacs variable @code{default-directory}. | 13737 | the value of the Emacs variable @code{default-directory}. |
| 13738 | 13738 | ||
| 13739 | When using @code{:dir}, you should supply a relative path for file output | 13739 | When using @code{:dir}, you should supply a relative path for file output |
| 13740 | (e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which | 13740 | (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which |
| 13741 | case that path will be interpreted relative to the default directory. | 13741 | case that path will be interpreted relative to the default directory. |
| 13742 | 13742 | ||
| 13743 | In other words, if you want your plot to go into a folder called @file{Work} | 13743 | In other words, if you want your plot to go into a folder called @file{Work} |
| @@ -14177,7 +14177,7 @@ No column name pre-processing takes place | |||
| 14177 | 14177 | ||
| 14178 | @item @code{yes} | 14178 | @item @code{yes} |
| 14179 | Column names are removed and reapplied as with @code{nil} even if the table | 14179 | Column names are removed and reapplied as with @code{nil} even if the table |
| 14180 | does not ``look like'' it has column names (i.e.@: the second row is not an | 14180 | does not ``look like'' it has column names (i.e., the second row is not an |
| 14181 | hline) | 14181 | hline) |
| 14182 | @end itemize | 14182 | @end itemize |
| 14183 | 14183 | ||
| @@ -14219,7 +14219,7 @@ variable indexing @xref{var, Indexable variable values}. | |||
| 14219 | @subsubsection @code{:shebang} | 14219 | @subsubsection @code{:shebang} |
| 14220 | 14220 | ||
| 14221 | Setting the @code{:shebang} header argument to a string value | 14221 | Setting the @code{:shebang} header argument to a string value |
| 14222 | (e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the | 14222 | (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the |
| 14223 | first line of any tangled file holding the code block, and the file | 14223 | first line of any tangled file holding the code block, and the file |
| 14224 | permissions of the tangled file are set to make it executable. | 14224 | permissions of the tangled file are set to make it executable. |
| 14225 | 14225 | ||
| @@ -14604,7 +14604,7 @@ option keyword is already complete, pressing @kbd{M-@key{TAB}} again | |||
| 14604 | will insert example settings for this keyword. | 14604 | will insert example settings for this keyword. |
| 14605 | @item | 14605 | @item |
| 14606 | In the line after @samp{#+STARTUP: }, complete startup keywords, | 14606 | In the line after @samp{#+STARTUP: }, complete startup keywords, |
| 14607 | i.e.@: valid keys for this line. | 14607 | i.e., valid keys for this line. |
| 14608 | @item | 14608 | @item |
| 14609 | Elsewhere, complete dictionary words using Ispell. | 14609 | Elsewhere, complete dictionary words using Ispell. |
| 14610 | @end itemize | 14610 | @end itemize |
| @@ -14657,7 +14657,7 @@ additional details. | |||
| 14657 | @vindex org-speed-commands-user | 14657 | @vindex org-speed-commands-user |
| 14658 | 14658 | ||
| 14659 | Single keys can be made to execute commands when the cursor is at the | 14659 | Single keys can be made to execute commands when the cursor is at the |
| 14660 | beginning of a headline, i.e.@: before the first star. Configure the variable | 14660 | beginning of a headline, i.e., before the first star. Configure the variable |
| 14661 | @code{org-use-speed-commands} to activate this feature. There is a | 14661 | @code{org-use-speed-commands} to activate this feature. There is a |
| 14662 | pre-defined list of commands, and you can add more such commands using the | 14662 | pre-defined list of commands, and you can add more such commands using the |
| 14663 | variable @code{org-speed-commands-user}. Speed keys do not only speed up | 14663 | variable @code{org-speed-commands-user}. Speed keys do not only speed up |
| @@ -14806,7 +14806,7 @@ buffer, most useful for specifying the allowed values of a property. | |||
| 14806 | @item #+SETUPFILE: file | 14806 | @item #+SETUPFILE: file |
| 14807 | This line defines a file that holds more in-buffer setup. Normally this is | 14807 | This line defines a file that holds more in-buffer setup. Normally this is |
| 14808 | entirely ignored. Only when the buffer is parsed for option-setting lines | 14808 | entirely ignored. Only when the buffer is parsed for option-setting lines |
| 14809 | (i.e.@: when starting Org mode for a file, when pressing @kbd{C-c C-c} in a | 14809 | (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a |
| 14810 | settings line, or when exporting), then the contents of this file are parsed | 14810 | settings line, or when exporting), then the contents of this file are parsed |
| 14811 | as if they had been included in the buffer. In particular, the file can be | 14811 | as if they had been included in the buffer. In particular, the file can be |
| 14812 | any other Org mode file with internal setup. You can visit the file the | 14812 | any other Org mode file with internal setup. You can visit the file the |
| @@ -15168,7 +15168,7 @@ example using the color @code{grey90} on a white background. | |||
| 15168 | Things become cleaner still if you skip all the even levels and use only odd | 15168 | Things become cleaner still if you skip all the even levels and use only odd |
| 15169 | levels 1, 3, 5..., effectively adding two stars to go from one outline level | 15169 | levels 1, 3, 5..., effectively adding two stars to go from one outline level |
| 15170 | to the next@footnote{When you need to specify a level for a property search | 15170 | to the next@footnote{When you need to specify a level for a property search |
| 15171 | or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this | 15171 | or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this |
| 15172 | way we get the outline view shown at the beginning of this section. In order | 15172 | way we get the outline view shown at the beginning of this section. In order |
| 15173 | to make the structure editing and export commands handle this convention | 15173 | to make the structure editing and export commands handle this convention |
| 15174 | correctly, configure the variable @code{org-odd-levels-only}, or set this on | 15174 | correctly, configure the variable @code{org-odd-levels-only}, or set this on |
| @@ -15259,7 +15259,7 @@ names for natural constants or units. Instead of defining your own | |||
| 15259 | constants in the variable @code{org-table-formula-constants}, install | 15259 | constants in the variable @code{org-table-formula-constants}, install |
| 15260 | the @file{constants} package which defines a large number of constants | 15260 | the @file{constants} package which defines a large number of constants |
| 15261 | and units, and lets you use unit prefixes like @samp{M} for | 15261 | and units, and lets you use unit prefixes like @samp{M} for |
| 15262 | @samp{Mega}, etc@. You will need version 2.0 of this package, available | 15262 | @samp{Mega}, etc. You will need version 2.0 of this package, available |
| 15263 | at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for | 15263 | at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for |
| 15264 | the function @code{constants-get}, which has to be autoloaded in your | 15264 | the function @code{constants-get}, which has to be autoloaded in your |
| 15265 | setup. See the installation instructions in the file | 15265 | setup. See the installation instructions in the file |
| @@ -15626,7 +15626,7 @@ the link description when the link is later inserted into an Org | |||
| 15626 | buffer with @kbd{C-c C-l}. | 15626 | buffer with @kbd{C-c C-l}. |
| 15627 | 15627 | ||
| 15628 | When it makes sense for your new link type, you may also define a function | 15628 | When it makes sense for your new link type, you may also define a function |
| 15629 | @code{org-PREFIX-complete-link} that implements special (e.g.@: completion) | 15629 | @code{org-PREFIX-complete-link} that implements special (e.g., completion) |
| 15630 | support for inserting such a link with @kbd{C-c C-l}. Such a function should | 15630 | support for inserting such a link with @kbd{C-c C-l}. Such a function should |
| 15631 | not accept any arguments, and return the full link with prefix. | 15631 | not accept any arguments, and return the full link with prefix. |
| 15632 | 15632 | ||
| @@ -15832,9 +15832,9 @@ When you are done, press @kbd{C-c C-c} in the table to get the converted | |||
| 15832 | table inserted between the two marker lines. | 15832 | table inserted between the two marker lines. |
| 15833 | 15833 | ||
| 15834 | Now let's assume you want to make the table header by hand, because you | 15834 | Now let's assume you want to make the table header by hand, because you |
| 15835 | want to control how columns are aligned, etc@. In this case we make sure | 15835 | want to control how columns are aligned, etc. In this case we make sure |
| 15836 | that the table translator skips the first 2 lines of the source | 15836 | that the table translator skips the first 2 lines of the source |
| 15837 | table, and tell the command to work as a @i{splice}, i.e.@: to not produce | 15837 | table, and tell the command to work as a @i{splice}, i.e., to not produce |
| 15838 | header and footer commands of the target table: | 15838 | header and footer commands of the target table: |
| 15839 | 15839 | ||
| 15840 | @example | 15840 | @example |
| @@ -15917,7 +15917,7 @@ hands processing over to the generic translator. Here is the entire code: | |||
| 15917 | 15917 | ||
| 15918 | As you can see, the properties passed into the function (variable | 15918 | As you can see, the properties passed into the function (variable |
| 15919 | @var{PARAMS}) are combined with the ones newly defined in the function | 15919 | @var{PARAMS}) are combined with the ones newly defined in the function |
| 15920 | (variable @var{PARAMS2}). The ones passed into the function (i.e.@: the | 15920 | (variable @var{PARAMS2}). The ones passed into the function (i.e., the |
| 15921 | ones set by the @samp{ORGTBL SEND} line) take precedence. So if you | 15921 | ones set by the @samp{ORGTBL SEND} line) take precedence. So if you |
| 15922 | would like to use the @LaTeX{} translator, but wanted the line endings to | 15922 | would like to use the @LaTeX{} translator, but wanted the line endings to |
| 15923 | be @samp{\\[2mm]} instead of the default @samp{\\}, you could just | 15923 | be @samp{\\[2mm]} instead of the default @samp{\\}, you could just |
| @@ -16086,7 +16086,7 @@ using @code{org-agenda-skip-function}. | |||
| 16086 | Let's say you want to produce a list of projects that contain a WAITING | 16086 | Let's say you want to produce a list of projects that contain a WAITING |
| 16087 | tag anywhere in the project tree. Let's further assume that you have | 16087 | tag anywhere in the project tree. Let's further assume that you have |
| 16088 | marked all tree headings that define a project with the TODO keyword | 16088 | marked all tree headings that define a project with the TODO keyword |
| 16089 | PROJECT. In this case you would run a TODO search for the keyword | 16089 | PROJECT@. In this case you would run a TODO search for the keyword |
| 16090 | PROJECT, but skip the match unless there is a WAITING tag anywhere in | 16090 | PROJECT, but skip the match unless there is a WAITING tag anywhere in |
| 16091 | the subtree belonging to the project line. | 16091 | the subtree belonging to the project line. |
| 16092 | 16092 | ||
| @@ -16179,7 +16179,7 @@ line in Emacs batch mode. This extracted information can be sent | |||
| 16179 | directly to a printer, or it can be read by a program that does further | 16179 | directly to a printer, or it can be read by a program that does further |
| 16180 | processing of the data. The first of these commands is the function | 16180 | processing of the data. The first of these commands is the function |
| 16181 | @code{org-batch-agenda}, that produces an agenda view and sends it as | 16181 | @code{org-batch-agenda}, that produces an agenda view and sends it as |
| 16182 | ASCII text to STDOUT. The command takes a single string as parameter. | 16182 | ASCII text to STDOUT@. The command takes a single string as parameter. |
| 16183 | If the string has length 1, it is used as a key to one of the commands | 16183 | If the string has length 1, it is used as a key to one of the commands |
| 16184 | you have configured in @code{org-agenda-custom-commands}, basically any | 16184 | you have configured in @code{org-agenda-custom-commands}, basically any |
| 16185 | key you can use after @kbd{C-c a}. For example, to directly print the | 16185 | key you can use after @kbd{C-c a}. For example, to directly print the |
| @@ -16292,7 +16292,7 @@ If WHICH is nil or `all', get all properties. If WHICH is | |||
| 16292 | @vindex org-use-property-inheritance | 16292 | @vindex org-use-property-inheritance |
| 16293 | @findex org-insert-property-drawer | 16293 | @findex org-insert-property-drawer |
| 16294 | @defun org-entry-get pom property &optional inherit | 16294 | @defun org-entry-get pom property &optional inherit |
| 16295 | Get value of PROPERTY for entry at point-or-marker POM. By default, | 16295 | Get value of PROPERTY for entry at point-or-marker POM@. By default, |
| 16296 | this only looks at properties defined locally in the entry. If INHERIT | 16296 | this only looks at properties defined locally in the entry. If INHERIT |
| 16297 | is non-nil and the entry does not have the property, then also check | 16297 | is non-nil and the entry does not have the property, then also check |
| 16298 | higher levels of the hierarchy. If INHERIT is the symbol | 16298 | higher levels of the hierarchy. If INHERIT is the symbol |
| @@ -16317,7 +16317,7 @@ Insert a property drawer for the current entry. Also | |||
| 16317 | @end defun | 16317 | @end defun |
| 16318 | 16318 | ||
| 16319 | @defun org-entry-put-multivalued-property pom property &rest values | 16319 | @defun org-entry-put-multivalued-property pom property &rest values |
| 16320 | Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of | 16320 | Set PROPERTY at point-or-marker POM to VALUES@. VALUES should be a list of |
| 16321 | strings. They will be concatenated, with spaces as separators. | 16321 | strings. They will be concatenated, with spaces as separators. |
| 16322 | @end defun | 16322 | @end defun |
| 16323 | 16323 | ||
| @@ -16374,7 +16374,7 @@ does not need to preserve point. After evaluation, the cursor will be | |||
| 16374 | moved to the end of the line (presumably of the headline of the | 16374 | moved to the end of the line (presumably of the headline of the |
| 16375 | processed entry) and search continues from there. Under some | 16375 | processed entry) and search continues from there. Under some |
| 16376 | circumstances, this may not produce the wanted results. For example, | 16376 | circumstances, this may not produce the wanted results. For example, |
| 16377 | if you have removed (e.g.@: archived) the current (sub)tree it could | 16377 | if you have removed (e.g., archived) the current (sub)tree it could |
| 16378 | mean that the next entry will be skipped entirely. In such cases, you | 16378 | mean that the next entry will be skipped entirely. In such cases, you |
| 16379 | can specify the position from where search should continue by making | 16379 | can specify the position from where search should continue by making |
| 16380 | FUNC set the variable `org-map-continue-from' to the desired buffer | 16380 | FUNC set the variable `org-map-continue-from' to the desired buffer |
diff --git a/doc/misc/pcl-cvs.texi b/doc/misc/pcl-cvs.texi index 92c309f5e98..993ddc22d43 100644 --- a/doc/misc/pcl-cvs.texi +++ b/doc/misc/pcl-cvs.texi | |||
| @@ -63,7 +63,7 @@ developing GNU and promoting software freedom.'' | |||
| 63 | @ifnottex | 63 | @ifnottex |
| 64 | @top PCL-CVS | 64 | @top PCL-CVS |
| 65 | 65 | ||
| 66 | This manual describes PCL-CVS, the GNU Emacs front-end to CVS. It | 66 | This manual describes PCL-CVS, the GNU Emacs front-end to CVS@. It |
| 67 | is nowhere near complete, so you are advised to use @kbd{M-x | 67 | is nowhere near complete, so you are advised to use @kbd{M-x |
| 68 | customize-group RET pcl-cvs @key{RET}} and to look at the documentation strings | 68 | customize-group RET pcl-cvs @key{RET}} and to look at the documentation strings |
| 69 | of the various commands and major modes for further information. | 69 | of the various commands and major modes for further information. |
| @@ -202,7 +202,7 @@ and cleanups. | |||
| 202 | the build and installation procedure. | 202 | the build and installation procedure. |
| 203 | 203 | ||
| 204 | @item | 204 | @item |
| 205 | @email{woods@@weird.com, Greg A.@: Woods} contributed code to implement | 205 | @email{woods@@weird.com, Greg A. Woods} contributed code to implement |
| 206 | the use of per-file diff buffers, and vendor join diffs with emerge and | 206 | the use of per-file diff buffers, and vendor join diffs with emerge and |
| 207 | ediff, as well as various and sundry bug fixes and cleanups. | 207 | ediff, as well as various and sundry bug fixes and cleanups. |
| 208 | 208 | ||
| @@ -236,7 +236,7 @@ there would be no new releases of PCL-CVS. | |||
| 236 | @cindex Sample session | 236 | @cindex Sample session |
| 237 | 237 | ||
| 238 | This document assumes that you know what CVS is, and that you at least | 238 | This document assumes that you know what CVS is, and that you at least |
| 239 | know the fundamental concepts of CVS. If that is not the case, you | 239 | know the fundamental concepts of CVS@. If that is not the case, you |
| 240 | should read the CVS documentation. Type @kbd{info -f cvs} or @kbd{man | 240 | should read the CVS documentation. Type @kbd{info -f cvs} or @kbd{man |
| 241 | cvs}. | 241 | cvs}. |
| 242 | 242 | ||
| @@ -476,7 +476,7 @@ This chapter describes all the commands that you can use in PCL-CVS. | |||
| 476 | @end iftex | 476 | @end iftex |
| 477 | @ifnottex | 477 | @ifnottex |
| 478 | The nodes in this menu contains explanations about all the commands that | 478 | The nodes in this menu contains explanations about all the commands that |
| 479 | you can use in PCL-CVS. They are grouped together by type. | 479 | you can use in PCL-CVS@. They are grouped together by type. |
| 480 | @end ifnottex | 480 | @end ifnottex |
| 481 | 481 | ||
| 482 | @menu | 482 | @menu |
| @@ -568,7 +568,7 @@ argument to the command (e.g., by typing | |||
| 568 | @cindex Command-line options to CVS | 568 | @cindex Command-line options to CVS |
| 569 | 569 | ||
| 570 | This section describes the convention used by nearly all PCL-CVS | 570 | This section describes the convention used by nearly all PCL-CVS |
| 571 | commands for setting optional flags sent to CVS. A single @kbd{C-u} | 571 | commands for setting optional flags sent to CVS@. A single @kbd{C-u} |
| 572 | prefix argument is used to cause the command to prompt for flags to be | 572 | prefix argument is used to cause the command to prompt for flags to be |
| 573 | used for the current invocation of the command only. Two @kbd{C-u} prefix | 573 | used for the current invocation of the command only. Two @kbd{C-u} prefix |
| 574 | arguments are used to prompt for flags which will be set permanently, for the | 574 | arguments are used to prompt for flags which will be set permanently, for the |
| @@ -582,7 +582,7 @@ and the file will be added. Subsequent @samp{cvs add} | |||
| 582 | commands will use the previously prevailing flags. | 582 | commands will use the previously prevailing flags. |
| 583 | 583 | ||
| 584 | As a second example, say you are about to perform a diff and want to see | 584 | As a second example, say you are about to perform a diff and want to see |
| 585 | the result in unified diff format, i.e. you'd like to pass the flag | 585 | the result in unified diff format, i.e., you'd like to pass the flag |
| 586 | @samp{-u} to both @samp{cvs diff} and @samp{diff}. You'd also like all | 586 | @samp{-u} to both @samp{cvs diff} and @samp{diff}. You'd also like all |
| 587 | subsequent diffs to use this flag. You can type @kbd{C-u C-u = -u @key{RET}} | 587 | subsequent diffs to use this flag. You can type @kbd{C-u C-u = -u @key{RET}} |
| 588 | and the diff will be performed, and the default flags will be set to | 588 | and the diff will be performed, and the default flags will be set to |
| @@ -789,8 +789,8 @@ risk of error, @kbd{C-c C-c} will ask for confirmation if the set of | |||
| 789 | selected files has changed between the first step and the last. You can | 789 | selected files has changed between the first step and the last. You can |
| 790 | change this last detail with @code{log-edit-confirm}. | 790 | change this last detail with @code{log-edit-confirm}. |
| 791 | 791 | ||
| 792 | As for the difference between @kbd{c} (i.e. @code{cvs-mode-commit}) and | 792 | As for the difference between @kbd{c} (i.e., @code{cvs-mode-commit}) and |
| 793 | @kbd{C} (i.e. @code{cvs-mode-commit-setup}) is that the first gets you | 793 | @kbd{C} (i.e., @code{cvs-mode-commit-setup}) is that the first gets you |
| 794 | straight to @samp{*cvs-commit*} without erasing it or changing anything | 794 | straight to @samp{*cvs-commit*} without erasing it or changing anything |
| 795 | to its content, while the second first erases @samp{*cvs-commit*} | 795 | to its content, while the second first erases @samp{*cvs-commit*} |
| 796 | and tries to initialize it with a sane default (it does that by either | 796 | and tries to initialize it with a sane default (it does that by either |
| @@ -1391,7 +1391,7 @@ Below is a partial list of currently known problems with PCL-CVS. | |||
| 1391 | 1391 | ||
| 1392 | @table @asis | 1392 | @table @asis |
| 1393 | @item Unexpected output from CVS | 1393 | @item Unexpected output from CVS |
| 1394 | Unexpected output from CVS may confuse PCL-CVS. It will create | 1394 | Unexpected output from CVS may confuse PCL-CVS@. It will create |
| 1395 | warning messages in the @samp{*cvs*} buffer alerting you to any parse errors. | 1395 | warning messages in the @samp{*cvs*} buffer alerting you to any parse errors. |
| 1396 | If you get these messages, please send a bug report to the email | 1396 | If you get these messages, please send a bug report to the email |
| 1397 | addresses listed above. Include the contents of the @samp{*cvs*} buffer, the | 1397 | addresses listed above. Include the contents of the @samp{*cvs*} buffer, the |
diff --git a/doc/misc/pgg.texi b/doc/misc/pgg.texi index 5aa9b1eb230..0ea0bbf84d1 100644 --- a/doc/misc/pgg.texi +++ b/doc/misc/pgg.texi | |||
| @@ -89,12 +89,12 @@ PGG requires at least one implementation of privacy guard system. | |||
| 89 | This document assumes that you have already obtained and installed them | 89 | This document assumes that you have already obtained and installed them |
| 90 | and that you are familiar with its basic functions. | 90 | and that you are familiar with its basic functions. |
| 91 | 91 | ||
| 92 | By default, PGG uses GnuPG. If you are new to such a system, I | 92 | By default, PGG uses GnuPG@. If you are new to such a system, I |
| 93 | recommend that you should look over the GNU Privacy Handbook (GPH) | 93 | recommend that you should look over the GNU Privacy Handbook (GPH) |
| 94 | which is available at @uref{http://www.gnupg.org/documentation/}. | 94 | which is available at @uref{http://www.gnupg.org/documentation/}. |
| 95 | 95 | ||
| 96 | When using GnuPG, we recommend the use of the @code{gpg-agent} | 96 | When using GnuPG, we recommend the use of the @code{gpg-agent} |
| 97 | program, which is distributed with versions 2.0 and later of GnuPG. | 97 | program, which is distributed with versions 2.0 and later of GnuPG@. |
| 98 | This is a daemon to manage private keys independently from any | 98 | This is a daemon to manage private keys independently from any |
| 99 | protocol, and provides the most secure way to input and cache your | 99 | protocol, and provides the most secure way to input and cache your |
| 100 | passphrases (@pxref{Caching passphrase}). By default, PGG will | 100 | passphrases (@pxref{Caching passphrase}). By default, PGG will |
diff --git a/doc/misc/rcirc.texi b/doc/misc/rcirc.texi index ac97db414a4..b72211111a7 100644 --- a/doc/misc/rcirc.texi +++ b/doc/misc/rcirc.texi | |||
| @@ -167,7 +167,7 @@ Since this is so common, you can use @key{TAB} to do nick completion. | |||
| 167 | Use the command @kbd{M-x irc} to connect using the defaults. | 167 | Use the command @kbd{M-x irc} to connect using the defaults. |
| 168 | @xref{Configuration}, if you want to change the defaults. | 168 | @xref{Configuration}, if you want to change the defaults. |
| 169 | 169 | ||
| 170 | Use @kbd{C-u M-x irc} if you don't want to use the defaults, eg. if you | 170 | Use @kbd{C-u M-x irc} if you don't want to use the defaults, e.g., if you |
| 171 | want to connect to a different network, or connect to the same network | 171 | want to connect to a different network, or connect to the same network |
| 172 | using a different nick. This will prompt you for four things: | 172 | using a different nick. This will prompt you for four things: |
| 173 | 173 | ||
| @@ -514,7 +514,7 @@ like @code{rcirc-default-nick}. | |||
| 514 | @cindex full name | 514 | @cindex full name |
| 515 | @cindex real name | 515 | @cindex real name |
| 516 | @cindex surname | 516 | @cindex surname |
| 517 | This variable is used to set your ``real name'' on IRC. It defaults | 517 | This variable is used to set your ``real name'' on IRC@. It defaults |
| 518 | to the name returned by @code{user-full-name}. If you want to hide | 518 | to the name returned by @code{user-full-name}. If you want to hide |
| 519 | your full name, you might want to set it to some pseudonym. | 519 | your full name, you might want to set it to some pseudonym. |
| 520 | 520 | ||
diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi index 1ffa2473b27..a6339e72de6 100644 --- a/doc/misc/reftex.texi +++ b/doc/misc/reftex.texi | |||
| @@ -272,7 +272,7 @@ of the Makefile. Basically, you need to change the path specifications | |||
| 272 | for Emacs Lisp files and info files. Also, enter the name of your Emacs | 272 | for Emacs Lisp files and info files. Also, enter the name of your Emacs |
| 273 | executable (usually either @samp{emacs} or @samp{xemacs}). | 273 | executable (usually either @samp{emacs} or @samp{xemacs}). |
| 274 | 274 | ||
| 275 | Then, type | 275 | Then, type |
| 276 | 276 | ||
| 277 | @example | 277 | @example |
| 278 | make | 278 | make |
| @@ -353,7 +353,7 @@ PostScript or HTML files. | |||
| 353 | @RefTeX{} needs to access all files which are part of a multifile | 353 | @RefTeX{} needs to access all files which are part of a multifile |
| 354 | document, and the BibTeX database files requested by the | 354 | document, and the BibTeX database files requested by the |
| 355 | @code{\bibliography} command. To find these files, @RefTeX{} will | 355 | @code{\bibliography} command. To find these files, @RefTeX{} will |
| 356 | require a search path, i.e. a list of directories to check. Normally | 356 | require a search path, i.e., a list of directories to check. Normally |
| 357 | this list is stored in the environment variables @code{TEXINPUTS} and | 357 | this list is stored in the environment variables @code{TEXINPUTS} and |
| 358 | @code{BIBINPUTS} which are also used by @RefTeX{}. However, on some | 358 | @code{BIBINPUTS} which are also used by @RefTeX{}. However, on some |
| 359 | systems these variables do not contain the full search path. If | 359 | systems these variables do not contain the full search path. If |
| @@ -736,14 +736,14 @@ keymap @code{reftex-toc-map} may be used. | |||
| 736 | @cindex Table of contents buffer, recentering | 736 | @cindex Table of contents buffer, recentering |
| 737 | @kindex C-c - | 737 | @kindex C-c - |
| 738 | If you call @code{reftex-toc} while the @file{*toc*} buffer already | 738 | If you call @code{reftex-toc} while the @file{*toc*} buffer already |
| 739 | exists, the cursor will immediately jump to the right place, i.e. the | 739 | exists, the cursor will immediately jump to the right place, i.e., the |
| 740 | section from which @code{reftex-toc} was called will be highlighted. | 740 | section from which @code{reftex-toc} was called will be highlighted. |
| 741 | The command @kbd{C-c -} (@code{reftex-toc-recenter}) will only redisplay | 741 | The command @kbd{C-c -} (@code{reftex-toc-recenter}) will only redisplay |
| 742 | the @file{*toc*} buffer and highlight the correct line without actually | 742 | the @file{*toc*} buffer and highlight the correct line without actually |
| 743 | selecting the @file{*toc*} window. This can be useful to quickly find | 743 | selecting the @file{*toc*} window. This can be useful to quickly find |
| 744 | out where in the document you currently are. You can also automate this | 744 | out where in the document you currently are. You can also automate this |
| 745 | by asking RefTeX to keep track of your current editing position in the | 745 | by asking RefTeX to keep track of your current editing position in the |
| 746 | TOC. The TOC window will then be updated whenever you stop typing for | 746 | TOC@. The TOC window will then be updated whenever you stop typing for |
| 747 | more than @code{reftex-idle-time} seconds. By default this works only | 747 | more than @code{reftex-idle-time} seconds. By default this works only |
| 748 | with the dedicated @file{*TOC*} frame. But you can also force automatic | 748 | with the dedicated @file{*TOC*} frame. But you can also force automatic |
| 749 | recentering of the TOC window on the current frame with | 749 | recentering of the TOC window on the current frame with |
| @@ -894,7 +894,7 @@ start a selection process and finally insert the complete | |||
| 894 | 894 | ||
| 895 | @vindex reftex-ref-macro-prompt | 895 | @vindex reftex-ref-macro-prompt |
| 896 | First, you can select which reference macro you want to use, | 896 | First, you can select which reference macro you want to use, |
| 897 | e.g. @samp{\ref} or @samp{\pageref}. Later in the process you have | 897 | e.g., @samp{\ref} or @samp{\pageref}. Later in the process you have |
| 898 | another chance to make this selection and you can therefore disable this | 898 | another chance to make this selection and you can therefore disable this |
| 899 | step by customizing @code{reftex-ref-macro-prompt} if you find it too | 899 | step by customizing @code{reftex-ref-macro-prompt} if you find it too |
| 900 | intrusive. @xref{Reference Styles}. | 900 | intrusive. @xref{Reference Styles}. |
| @@ -1021,7 +1021,7 @@ Cycle forward through active reference macros. The selected macro is | |||
| 1021 | displayed by the @samp{S<...>} indicator in the mode line of the | 1021 | displayed by the @samp{S<...>} indicator in the mode line of the |
| 1022 | selection buffer. This mechanism comes in handy if you are using | 1022 | selection buffer. This mechanism comes in handy if you are using |
| 1023 | @LaTeX{} packages like @code{varioref} or @code{fancyref} and want to | 1023 | @LaTeX{} packages like @code{varioref} or @code{fancyref} and want to |
| 1024 | use the special referencing macros they provide (e.g. @code{\vref} or | 1024 | use the special referencing macros they provide (e.g., @code{\vref} or |
| 1025 | @code{\fref}) instead of @code{\ref}. | 1025 | @code{\fref}) instead of @code{\ref}. |
| 1026 | 1026 | ||
| 1027 | @item V | 1027 | @item V |
| @@ -1102,7 +1102,7 @@ keymap @code{reftex-select-label-map} may be used. | |||
| 1102 | @vindex reftex-label-alist-builtin | 1102 | @vindex reftex-label-alist-builtin |
| 1103 | 1103 | ||
| 1104 | @RefTeX{} needs to be aware of the environments which can be referenced | 1104 | @RefTeX{} needs to be aware of the environments which can be referenced |
| 1105 | with a label (i.e. which carry their own counters). By default, @RefTeX{} | 1105 | with a label (i.e., which carry their own counters). By default, @RefTeX{} |
| 1106 | recognizes all labeled environments and macros discussed in @cite{The | 1106 | recognizes all labeled environments and macros discussed in @cite{The |
| 1107 | @LaTeX{} Companion by Goossens, Mittelbach & Samarin, Addison-Wesley | 1107 | @LaTeX{} Companion by Goossens, Mittelbach & Samarin, Addison-Wesley |
| 1108 | 1994.}. These are: | 1108 | 1994.}. These are: |
| @@ -1257,7 +1257,7 @@ to be used like this: | |||
| 1257 | 1257 | ||
| 1258 | So we need to tell @RefTeX{} that @code{theorem} and @code{axiom} are new | 1258 | So we need to tell @RefTeX{} that @code{theorem} and @code{axiom} are new |
| 1259 | labeled environments which define their own label categories. We can | 1259 | labeled environments which define their own label categories. We can |
| 1260 | either use Lisp to do this (e.g. in @file{.emacs}) or use the custom | 1260 | either use Lisp to do this (e.g., in @file{.emacs}) or use the custom |
| 1261 | library. With Lisp it would look like this | 1261 | library. With Lisp it would look like this |
| 1262 | 1262 | ||
| 1263 | @lisp | 1263 | @lisp |
| @@ -1712,7 +1712,7 @@ extra step for reference macro selection, you can disable it by | |||
| 1712 | customizing @code{reftex-ref-macro-prompt} and relying only on the | 1712 | customizing @code{reftex-ref-macro-prompt} and relying only on the |
| 1713 | selection facilities provided in the last step. | 1713 | selection facilities provided in the last step. |
| 1714 | 1714 | ||
| 1715 | In the last step, i.e. the label selection, two key bindings are | 1715 | In the last step, i.e., the label selection, two key bindings are |
| 1716 | provided to set the reference macro. Type @key{v} in order to cycle | 1716 | provided to set the reference macro. Type @key{v} in order to cycle |
| 1717 | forward through the list of available macros or @key{V} to cycle | 1717 | forward through the list of available macros or @key{V} to cycle |
| 1718 | backward. The mode line of the selection buffer shows the macro | 1718 | backward. The mode line of the selection buffer shows the macro |
| @@ -1723,11 +1723,11 @@ through them you should adapt the order of entries in the variable | |||
| 1723 | @code{reftex-ref-style-alist} to fit your liking. | 1723 | @code{reftex-ref-style-alist} to fit your liking. |
| 1724 | 1724 | ||
| 1725 | For each entry in @code{reftex-ref-style-alist} a function with the name | 1725 | For each entry in @code{reftex-ref-style-alist} a function with the name |
| 1726 | @code{reftex-<package>-<macro>} (e.g. @code{reftex-varioref-vref}) will | 1726 | @code{reftex-<package>-<macro>} (e.g., @code{reftex-varioref-vref}) will |
| 1727 | be created automatically by @RefTeX{}. These functions can be used | 1727 | be created automatically by @RefTeX{}. These functions can be used |
| 1728 | instead of @kbd{C-c )} and provide an alternative way of having your | 1728 | instead of @kbd{C-c )} and provide an alternative way of having your |
| 1729 | favorite referencing macro preselected and if cycling through the macros | 1729 | favorite referencing macro preselected and if cycling through the macros |
| 1730 | seems inconvenient to you.@footnote{You could e.g. bind | 1730 | seems inconvenient to you.@footnote{You could, e.g., bind |
| 1731 | @code{reftex-varioref-vref} to @kbd{C-c v} and | 1731 | @code{reftex-varioref-vref} to @kbd{C-c v} and |
| 1732 | @code{reftex-fancyref-fref} to @kbd{C-c f}.} | 1732 | @code{reftex-fancyref-fref} to @kbd{C-c f}.} |
| 1733 | 1733 | ||
| @@ -3059,7 +3059,7 @@ Specify the full search path directly in @RefTeX{}'s variables. | |||
| 3059 | 3059 | ||
| 3060 | @item | 3060 | @item |
| 3061 | Some @TeX{} systems provide stand-alone programs to do the file search just | 3061 | Some @TeX{} systems provide stand-alone programs to do the file search just |
| 3062 | like @TeX{} and @BibTeX{}. E.g. Thomas Esser's @code{teTeX} uses the | 3062 | like @TeX{} and @BibTeX{}. E.g., Thomas Esser's @code{teTeX} uses the |
| 3063 | @code{kpathsearch} library which provides the command @code{kpsewhich} | 3063 | @code{kpathsearch} library which provides the command @code{kpsewhich} |
| 3064 | to search for files. @RefTeX{} can be configured to use this | 3064 | to search for files. @RefTeX{} can be configured to use this |
| 3065 | program. Note that the exact syntax of the @code{kpsewhich} | 3065 | program. Note that the exact syntax of the @code{kpsewhich} |
| @@ -3353,7 +3353,7 @@ association with the @code{\documentclass} and @code{\usepackage} | |||
| 3353 | commands of a document (@pxref{Style Files,,,auctex}). Support for | 3353 | commands of a document (@pxref{Style Files,,,auctex}). Support for |
| 3354 | @RefTeX{} in such a style file is useful when the @LaTeX{} style | 3354 | @RefTeX{} in such a style file is useful when the @LaTeX{} style |
| 3355 | defines macros or environments connected with labels, citations, or the | 3355 | defines macros or environments connected with labels, citations, or the |
| 3356 | index. Many style files (e.g. @file{amsmath.el} or @file{natbib.el}) | 3356 | index. Many style files (e.g., @file{amsmath.el} or @file{natbib.el}) |
| 3357 | distributed with @AUCTeX{} already support @RefTeX{} in this | 3357 | distributed with @AUCTeX{} already support @RefTeX{} in this |
| 3358 | way. | 3358 | way. |
| 3359 | 3359 | ||
| @@ -3541,7 +3541,7 @@ document. @xref{AUCTeX}. | |||
| 3541 | @cindex @code{iso-cvt}, Emacs package | 3541 | @cindex @code{iso-cvt}, Emacs package |
| 3542 | @cindex Emacs packages, @code{iso-cvt} | 3542 | @cindex Emacs packages, @code{iso-cvt} |
| 3543 | When using packages which make the buffer representation of a file | 3543 | When using packages which make the buffer representation of a file |
| 3544 | different from its disk representation (e.g. x-symbol, isotex, | 3544 | different from its disk representation (e.g., x-symbol, isotex, |
| 3545 | iso-cvt) you may find that @RefTeX{}'s parsing information sometimes | 3545 | iso-cvt) you may find that @RefTeX{}'s parsing information sometimes |
| 3546 | reflects the disk state of a file. This happens only in @emph{unvisited} | 3546 | reflects the disk state of a file. This happens only in @emph{unvisited} |
| 3547 | parts of a multifile document, because @RefTeX{} visits these files | 3547 | parts of a multifile document, because @RefTeX{} visits these files |
| @@ -3555,7 +3555,7 @@ this: | |||
| 3555 | @vindex reftex-keep-temporary-buffers | 3555 | @vindex reftex-keep-temporary-buffers |
| 3556 | @code{(setq reftex-keep-temporary-buffers t)}@* | 3556 | @code{(setq reftex-keep-temporary-buffers t)}@* |
| 3557 | This implies that @RefTeX{} will load all parts of a multifile | 3557 | This implies that @RefTeX{} will load all parts of a multifile |
| 3558 | document into Emacs (i.e. there won't be any temporary buffers). | 3558 | document into Emacs (i.e., there won't be any temporary buffers). |
| 3559 | @item | 3559 | @item |
| 3560 | @vindex reftex-initialize-temporary-buffers | 3560 | @vindex reftex-initialize-temporary-buffers |
| 3561 | @code{(setq reftex-initialize-temporary-buffers t)}@* | 3561 | @code{(setq reftex-initialize-temporary-buffers t)}@* |
| @@ -3573,7 +3573,7 @@ See also the variable @code{reftex-refontify-context}. | |||
| 3573 | @cindex @code{pf}, LaTeX package | 3573 | @cindex @code{pf}, LaTeX package |
| 3574 | @cindex LaTeX packages, @code{pf} | 3574 | @cindex LaTeX packages, @code{pf} |
| 3575 | Some packages use an additional argument to a @code{\begin} macro | 3575 | Some packages use an additional argument to a @code{\begin} macro |
| 3576 | to specify a label. E.g. Lamport's @file{pf.sty} uses both | 3576 | to specify a label. E.g., Lamport's @file{pf.sty} uses both |
| 3577 | @example | 3577 | @example |
| 3578 | \step@{@var{label}@}@{@var{claim}@} and \begin@{step+@}@{@var{label}@} | 3578 | \step@{@var{label}@}@{@var{claim}@} and \begin@{step+@}@{@var{label}@} |
| 3579 | @var{claim} | 3579 | @var{claim} |
| @@ -3932,7 +3932,7 @@ commands always select the nearest entry with the correct new level. | |||
| 3932 | @end defopt | 3932 | @end defopt |
| 3933 | 3933 | ||
| 3934 | @defopt reftex-toc-max-level | 3934 | @defopt reftex-toc-max-level |
| 3935 | The maximum level of toc entries which will be included in the TOC. | 3935 | The maximum level of toc entries which will be included in the TOC@. |
| 3936 | Section headings with a bigger level will be ignored. In RefTeX, | 3936 | Section headings with a bigger level will be ignored. In RefTeX, |
| 3937 | chapters are level 1, sections level 2 etc. This variable can be | 3937 | chapters are level 1, sections level 2 etc. This variable can be |
| 3938 | changed from within the @file{*toc*} buffer with the @kbd{t} key. | 3938 | changed from within the @file{*toc*} buffer with the @kbd{t} key. |
| @@ -4138,7 +4138,7 @@ If an integer, use the nth argument of the macro. As a special case, | |||
| 4138 | 1000 means to get text after the last macro argument. | 4138 | 1000 means to get text after the last macro argument. |
| 4139 | @item | 4139 | @item |
| 4140 | If a string, use as regexp to search @emph{backward} from the label. | 4140 | If a string, use as regexp to search @emph{backward} from the label. |
| 4141 | Context is then the text following the end of the match. E.g. setting | 4141 | Context is then the text following the end of the match. E.g., setting |
| 4142 | this to @samp{\\caption[[@{]} will use the caption in a figure or table | 4142 | this to @samp{\\caption[[@{]} will use the caption in a figure or table |
| 4143 | environment. @samp{\\begin@{eqnarray@}\|\\\\} works for | 4143 | environment. @samp{\\begin@{eqnarray@}\|\\\\} works for |
| 4144 | eqnarrays. | 4144 | eqnarrays. |
| @@ -4166,7 +4166,7 @@ context: | |||
| 4166 | Label context is used in two ways by @RefTeX{}: For display in the label | 4166 | Label context is used in two ways by @RefTeX{}: For display in the label |
| 4167 | menu, and to derive a label string. If you want to use a different | 4167 | menu, and to derive a label string. If you want to use a different |
| 4168 | method for each of these, specify them as a dotted pair. | 4168 | method for each of these, specify them as a dotted pair. |
| 4169 | E.g. @code{(nil . t)} uses the text after the label (@code{nil}) for | 4169 | E.g., @code{(nil . t)} uses the text after the label (@code{nil}) for |
| 4170 | display, and text from the default position (@code{t}) to derive a label | 4170 | display, and text from the default position (@code{t}) to derive a label |
| 4171 | string. This is actually used for section labels. | 4171 | string. This is actually used for section labels. |
| 4172 | 4172 | ||
| @@ -4237,13 +4237,13 @@ Possible values for this option are: | |||
| 4237 | t @r{This means to trust any label prefixes found.} | 4237 | t @r{This means to trust any label prefixes found.} |
| 4238 | regexp @r{If a regexp, only prefixes matched by the regexp are trusted.} | 4238 | regexp @r{If a regexp, only prefixes matched by the regexp are trusted.} |
| 4239 | list @r{List of accepted prefixes, as strings. The colon is part of} | 4239 | list @r{List of accepted prefixes, as strings. The colon is part of} |
| 4240 | @r{the prefix, e.g. ("fn:" "eqn:" "item:").} | 4240 | @r{the prefix, e.g., ("fn:" "eqn:" "item:").} |
| 4241 | nil @r{Never trust a label prefix.} | 4241 | nil @r{Never trust a label prefix.} |
| 4242 | @end example | 4242 | @end example |
| 4243 | The only disadvantage of using this feature is that the label context | 4243 | The only disadvantage of using this feature is that the label context |
| 4244 | displayed in the label selection buffer along with each label is | 4244 | displayed in the label selection buffer along with each label is |
| 4245 | simply some text after the label definition. This is no problem if you | 4245 | simply some text after the label definition. This is no problem if you |
| 4246 | place labels keeping this in mind (e.g. @i{before} the equation, @i{at | 4246 | place labels keeping this in mind (e.g., @i{before} the equation, @i{at |
| 4247 | the beginning} of a fig/tab caption ...). Anyway, it is probably best | 4247 | the beginning} of a fig/tab caption ...). Anyway, it is probably best |
| 4248 | to use the regexp or the list value types to fine-tune this feature. | 4248 | to use the regexp or the list value types to fine-tune this feature. |
| 4249 | For example, if your document contains thousands of footnotes with | 4249 | For example, if your document contains thousands of footnotes with |
| @@ -4446,7 +4446,7 @@ Controls if @code{reftex-reference} prompts for the reference macro. | |||
| 4446 | If non-@code{nil}, should be a function which produces the string to | 4446 | If non-@code{nil}, should be a function which produces the string to |
| 4447 | insert as a reference. Note that the insertion format can also be | 4447 | insert as a reference. Note that the insertion format can also be |
| 4448 | changed with @code{reftex-label-alist}. This hook also is used by the | 4448 | changed with @code{reftex-label-alist}. This hook also is used by the |
| 4449 | special commands to insert e.g. @code{\vref} and @code{\fref} | 4449 | special commands to insert, e.g., @code{\vref} and @code{\fref} |
| 4450 | references, so even if you set this, your setting will be ignored by the | 4450 | references, so even if you set this, your setting will be ignored by the |
| 4451 | special commands. The function will be called with three arguments, the | 4451 | special commands. The function will be called with three arguments, the |
| 4452 | @var{label}, the @var{default format} which normally is | 4452 | @var{label}, the @var{default format} which normally is |
| @@ -4760,7 +4760,7 @@ The default can be selected with @key{RET} during selection or | |||
| 4760 | completion. Valid values of this variable are: | 4760 | completion. Valid values of this variable are: |
| 4761 | @example | 4761 | @example |
| 4762 | nil @r{Do not provide a default index} | 4762 | nil @r{Do not provide a default index} |
| 4763 | "tag" @r{The default index tag given as a string, e.g. "idx"} | 4763 | "tag" @r{The default index tag given as a string, e.g., "idx"} |
| 4764 | last @r{The last used index tag will be offered as default} | 4764 | last @r{The last used index tag will be offered as default} |
| 4765 | @end example | 4765 | @end example |
| 4766 | @end defopt | 4766 | @end defopt |
| @@ -4770,7 +4770,7 @@ Format of index entries when copied from inside math mode. When | |||
| 4770 | @code{reftex-index-selection-or-word} is executed inside @TeX{} math mode, | 4770 | @code{reftex-index-selection-or-word} is executed inside @TeX{} math mode, |
| 4771 | the index key copied from the buffer is processed with this format | 4771 | the index key copied from the buffer is processed with this format |
| 4772 | string through the @code{format} function. This can be used to add the | 4772 | string through the @code{format} function. This can be used to add the |
| 4773 | math delimiters (e.g. @samp{$}) to the string. Requires the | 4773 | math delimiters (e.g., @samp{$}) to the string. Requires the |
| 4774 | @file{texmathp.el} library which is part of @AUCTeX{}. | 4774 | @file{texmathp.el} library which is part of @AUCTeX{}. |
| 4775 | @end defopt | 4775 | @end defopt |
| 4776 | 4776 | ||
| @@ -5170,7 +5170,7 @@ Never refontify. | |||
| 5170 | @item t | 5170 | @item t |
| 5171 | Always refontify. | 5171 | Always refontify. |
| 5172 | @item 1 | 5172 | @item 1 |
| 5173 | Refontify when necessary, e.g. with old versions of the x-symbol | 5173 | Refontify when necessary, e.g., with old versions of the x-symbol |
| 5174 | package. | 5174 | package. |
| 5175 | @end table | 5175 | @end table |
| 5176 | The option is ignored when @code{reftex-use-fonts} is @code{nil}. | 5176 | The option is ignored when @code{reftex-use-fonts} is @code{nil}. |
| @@ -5418,7 +5418,7 @@ the TOC buffer promote/demote the section at point or all sections in | |||
| 5418 | the current region. | 5418 | the current region. |
| 5419 | @item | 5419 | @item |
| 5420 | New option @code{reftex-toc-split-windows-fraction} to set the size of | 5420 | New option @code{reftex-toc-split-windows-fraction} to set the size of |
| 5421 | the window used by the TOC. This makes the old variable | 5421 | the window used by the TOC@. This makes the old variable |
| 5422 | @code{reftex-toc-split-windows-horizontally-fraction} obsolete. | 5422 | @code{reftex-toc-split-windows-horizontally-fraction} obsolete. |
| 5423 | @item | 5423 | @item |
| 5424 | A dedicated frame can show the TOC with the current section | 5424 | A dedicated frame can show the TOC with the current section |
| @@ -5812,7 +5812,7 @@ Fixed bug with AUCTeX @code{TeX-master}. | |||
| 5812 | @itemize @bullet | 5812 | @itemize @bullet |
| 5813 | @item | 5813 | @item |
| 5814 | The selection now uses a recursive edit, much like minibuffer input. | 5814 | The selection now uses a recursive edit, much like minibuffer input. |
| 5815 | This removes all restrictions during selection. E.g. you can now | 5815 | This removes all restrictions during selection. E.g., you can now |
| 5816 | switch buffers at will, use the mouse etc. | 5816 | switch buffers at will, use the mouse etc. |
| 5817 | @item | 5817 | @item |
| 5818 | New option @code{reftex-highlight-selection}. | 5818 | New option @code{reftex-highlight-selection}. |
| @@ -5888,7 +5888,7 @@ When no BibTeX database files are specified, citations can also use | |||
| 5888 | @noindent @b{Version 3.11} | 5888 | @noindent @b{Version 3.11} |
| 5889 | @itemize @bullet | 5889 | @itemize @bullet |
| 5890 | @item | 5890 | @item |
| 5891 | Fixed bug which led to naked label in (e.g.) footnotes. | 5891 | Fixed bug which led to naked label in (e.g.@:) footnotes. |
| 5892 | @item | 5892 | @item |
| 5893 | Added scroll-other-window functions to RefTeX-Select. | 5893 | Added scroll-other-window functions to RefTeX-Select. |
| 5894 | @end itemize | 5894 | @end itemize |
diff --git a/doc/misc/remember.texi b/doc/misc/remember.texi index 1dd7d1b6153..f97d835e50c 100644 --- a/doc/misc/remember.texi +++ b/doc/misc/remember.texi | |||
| @@ -100,7 +100,7 @@ There are many different databases out there---and good ones---which | |||
| 100 | this mode is not trying to replace. Rather, it's how that data gets | 100 | this mode is not trying to replace. Rather, it's how that data gets |
| 101 | there that's the question. Most of the time, we just want to say | 101 | there that's the question. Most of the time, we just want to say |
| 102 | "Remember so-and-so's phone number, or that I have to buy dinner for the | 102 | "Remember so-and-so's phone number, or that I have to buy dinner for the |
| 103 | cats tonight." That's the FACT. How it's stored is really the | 103 | cats tonight." That's the FACT@. How it's stored is really the |
| 104 | computer's problem. But at this point in time, it's most definitely | 104 | computer's problem. But at this point in time, it's most definitely |
| 105 | also the user's problem, and sometimes so laboriously so that people | 105 | also the user's problem, and sometimes so laboriously so that people |
| 106 | just let data slip, rather than expend the effort to record it. | 106 | just let data slip, rather than expend the effort to record it. |
diff --git a/doc/misc/sc.texi b/doc/misc/sc.texi index a2fe0f68a74..d6d57421ec2 100644 --- a/doc/misc/sc.texi +++ b/doc/misc/sc.texi | |||
| @@ -120,7 +120,7 @@ sent. Supercite is re-initialized in each new reply buffer. | |||
| 120 | @cindex attribute, attributing | 120 | @cindex attribute, attributing |
| 121 | 121 | ||
| 122 | Typical usage is as follows. You want to reply or followup to a message | 122 | Typical usage is as follows. You want to reply or followup to a message |
| 123 | in your MUA. You will probably hit @kbd{r} (i.e., ``reply'') or @kbd{f} | 123 | in your MUA@. You will probably hit @kbd{r} (i.e., ``reply'') or @kbd{f} |
| 124 | (i.e., ``forward'') to begin composing the reply. In response, the MUA | 124 | (i.e., ``forward'') to begin composing the reply. In response, the MUA |
| 125 | will create a reply buffer and initialize the outgoing mail headers | 125 | will create a reply buffer and initialize the outgoing mail headers |
| 126 | appropriately. The body of the reply will usually be empty at this | 126 | appropriately. The body of the reply will usually be empty at this |
| @@ -165,7 +165,7 @@ reply or forward command. This command will actually perform citations | |||
| 165 | by calling a hook variable to which Supercite's top-level function | 165 | by calling a hook variable to which Supercite's top-level function |
| 166 | @code{sc-cite-original} has been added. When @code{sc-cite-original} is | 166 | @code{sc-cite-original} has been added. When @code{sc-cite-original} is |
| 167 | executed, the original message must be set up in a very specific way, | 167 | executed, the original message must be set up in a very specific way, |
| 168 | but this is handled automatically by the MUA. @xref{Hints to MUA | 168 | but this is handled automatically by the MUA@. @xref{Hints to MUA |
| 169 | Authors}.@refill | 169 | Authors}.@refill |
| 170 | 170 | ||
| 171 | @cindex info alist | 171 | @cindex info alist |
| @@ -202,7 +202,7 @@ When the original message is cited by @code{sc-cite-original}, it will | |||
| 202 | cited text and want to re-fill it, you must use an add-on package such | 202 | cited text and want to re-fill it, you must use an add-on package such |
| 203 | as @cite{filladapt} or @cite{gin-mode}. These packages can recognize | 203 | as @cite{filladapt} or @cite{gin-mode}. These packages can recognize |
| 204 | Supercited text and will fill them appropriately. Emacs's built-in | 204 | Supercited text and will fill them appropriately. Emacs's built-in |
| 205 | filling routines, e.g@. @code{fill-paragraph}, do not recognize cited | 205 | filling routines, e.g., @code{fill-paragraph}, do not recognize cited |
| 206 | text and will not re-fill them properly because it cannot guess the | 206 | text and will not re-fill them properly because it cannot guess the |
| 207 | @code{fill-prefix} being used. | 207 | @code{fill-prefix} being used. |
| 208 | @xref{Post-yank Formatting Commands}, for details.@refill | 208 | @xref{Post-yank Formatting Commands}, for details.@refill |
| @@ -213,7 +213,7 @@ beautifications on the cited original text, maintaining consistent and | |||
| 213 | informative citations throughout. Supercite tries to be as configurable | 213 | informative citations throughout. Supercite tries to be as configurable |
| 214 | as possible to allow for a wide range of personalized citation styles, | 214 | as possible to allow for a wide range of personalized citation styles, |
| 215 | but it is also immediately useful with the default configuration, once | 215 | but it is also immediately useful with the default configuration, once |
| 216 | it has been properly connected to your MUA. @xref{Getting Connected}, | 216 | it has been properly connected to your MUA@. @xref{Getting Connected}, |
| 217 | for more details.@refill | 217 | for more details.@refill |
| 218 | 218 | ||
| 219 | @node Citations | 219 | @node Citations |
| @@ -388,7 +388,7 @@ change @code{sc-citation-root-regexp} you should always also change | |||
| 388 | 388 | ||
| 389 | @dfn{Mail header information keys} are nuggets of information that | 389 | @dfn{Mail header information keys} are nuggets of information that |
| 390 | Supercite extracts from the various mail headers of the original | 390 | Supercite extracts from the various mail headers of the original |
| 391 | message, placed in the reply buffer by the MUA. Information is kept in | 391 | message, placed in the reply buffer by the MUA@. Information is kept in |
| 392 | the @dfn{Info Alist} as key-value pairs, and can be retrieved for use in | 392 | the @dfn{Info Alist} as key-value pairs, and can be retrieved for use in |
| 393 | various places within Supercite, such as in header rewrite functions and | 393 | various places within Supercite, such as in header rewrite functions and |
| 394 | attribution selection. Other bits of data, composed and created by | 394 | attribution selection. Other bits of data, composed and created by |
| @@ -532,7 +532,7 @@ beginning at zero. | |||
| 532 | @cindex header rewrite functions, built-in | 532 | @cindex header rewrite functions, built-in |
| 533 | 533 | ||
| 534 | Below are examples of the various built-in header rewrite functions. | 534 | Below are examples of the various built-in header rewrite functions. |
| 535 | Please note the following:@: first, the text which appears in the | 535 | Please note the following: first, the text which appears in the |
| 536 | examples below as @var{infokey} indicates that the corresponding value | 536 | examples below as @var{infokey} indicates that the corresponding value |
| 537 | of the info key from the info alist will be inserted there. | 537 | of the info key from the info alist will be inserted there. |
| 538 | (@pxref{Information Keys and the Info Alist}). For example, in @code{sc-header-on-said} | 538 | (@pxref{Information Keys and the Info Alist}). For example, in @code{sc-header-on-said} |
| @@ -1132,8 +1132,8 @@ Each element in this list contains lists of the following form: | |||
| 1132 | 1132 | ||
| 1133 | @example | 1133 | @example |
| 1134 | @group | 1134 | @group |
| 1135 | (@var{infokey} ((@var{regexp} @. @var{attribution}) | 1135 | (@var{infokey} ((@var{regexp} . @var{attribution}) |
| 1136 | (@var{regexp} @. @var{attribution}) | 1136 | (@var{regexp} . @var{attribution}) |
| 1137 | (@dots{}))) | 1137 | (@dots{}))) |
| 1138 | @end group | 1138 | @end group |
| 1139 | @end example | 1139 | @end example |
| @@ -1240,7 +1240,7 @@ post-selection hook, the local variables @code{attribution} and | |||
| 1240 | variables in your hook functions, you change the attribution and | 1240 | variables in your hook functions, you change the attribution and |
| 1241 | citation strings used by Supercite. One possible use of this would be | 1241 | citation strings used by Supercite. One possible use of this would be |
| 1242 | to override any automatically derived attribution string when it is only | 1242 | to override any automatically derived attribution string when it is only |
| 1243 | one character long; e.g. you prefer to use @code{"initials"} but the | 1243 | one character long; e.g., you prefer to use @code{"initials"} but the |
| 1244 | author only has one name.@refill | 1244 | author only has one name.@refill |
| 1245 | 1245 | ||
| 1246 | @node Author Names | 1246 | @node Author Names |
| @@ -1284,7 +1284,7 @@ is used for this purpose. As implied by its name, this variable is an | |||
| 1284 | association list, where each element is a cons cell of the form: | 1284 | association list, where each element is a cons cell of the form: |
| 1285 | 1285 | ||
| 1286 | @example | 1286 | @example |
| 1287 | (@var{regexp} @. @var{position}) | 1287 | (@var{regexp} . @var{position}) |
| 1288 | @end example | 1288 | @end example |
| 1289 | 1289 | ||
| 1290 | @noindent | 1290 | @noindent |
| @@ -1295,7 +1295,7 @@ Thus to strip out all titles of ``Dr.'', ``Mr.'', etc. from the name, | |||
| 1295 | @code{sc-name-filter-alist} would have an entry such as: | 1295 | @code{sc-name-filter-alist} would have an entry such as: |
| 1296 | 1296 | ||
| 1297 | @example | 1297 | @example |
| 1298 | ("^\\(Mr\\|Mrs\\|Ms\\|Dr\\)[.]?$" @. 0) | 1298 | ("^\\(Mr\\|Mrs\\|Ms\\|Dr\\)[.]?$" . 0) |
| 1299 | @end example | 1299 | @end example |
| 1300 | 1300 | ||
| 1301 | @noindent | 1301 | @noindent |
| @@ -1486,8 +1486,8 @@ consulted to find the frame to use (@code{sc-cite-frame-alist}, | |||
| 1486 | respectively). These frames can contain alists of the form: | 1486 | respectively). These frames can contain alists of the form: |
| 1487 | 1487 | ||
| 1488 | @example | 1488 | @example |
| 1489 | ((@var{infokey} (@var{regexp} @. @var{frame}) (@var{regexp} @. @var{frame}) @dots{}) | 1489 | ((@var{infokey} (@var{regexp} . @var{frame}) (@var{regexp} . @var{frame}) @dots{}) |
| 1490 | (@var{infokey} (@var{regexp} @. @var{frame}) (@var{regexp} @. @var{frame}) @dots{}) | 1490 | (@var{infokey} (@var{regexp} . @var{frame}) (@var{regexp} . @var{frame}) @dots{}) |
| 1491 | (@dots{})) | 1491 | (@dots{})) |
| 1492 | @end example | 1492 | @end example |
| 1493 | 1493 | ||
| @@ -1819,7 +1819,7 @@ steps: | |||
| 1819 | @item | 1819 | @item |
| 1820 | Insert the original message, including the mail headers into the reply | 1820 | Insert the original message, including the mail headers into the reply |
| 1821 | buffer. At this point you should not modify the raw text in any way | 1821 | buffer. At this point you should not modify the raw text in any way |
| 1822 | (except for any necessary decoding, e.g. of quoted-printable text), and | 1822 | (except for any necessary decoding, e.g., of quoted-printable text), and |
| 1823 | you should place all the original headers into the body of the reply. | 1823 | you should place all the original headers into the body of the reply. |
| 1824 | This means that many of the mail headers will be duplicated, one copy | 1824 | This means that many of the mail headers will be duplicated, one copy |
| 1825 | above the @code{mail-header-separator} line and one copy below, however | 1825 | above the @code{mail-header-separator} line and one copy below, however |
diff --git a/doc/misc/sem-user.texi b/doc/misc/sem-user.texi index 9d6fb11db50..f483c899bf2 100644 --- a/doc/misc/sem-user.texi +++ b/doc/misc/sem-user.texi | |||
| @@ -59,7 +59,7 @@ minor modes. The variable @code{semantic-default-submodes} determines | |||
| 59 | which auxiliary modes are enabled; the defaults are SemanticDB mode | 59 | which auxiliary modes are enabled; the defaults are SemanticDB mode |
| 60 | (@pxref{SemanticDB}) and Global Semantic Idle Scheduler mode | 60 | (@pxref{SemanticDB}) and Global Semantic Idle Scheduler mode |
| 61 | (@pxref{Idle Scheduler}). You can also toggle the auxiliary minor | 61 | (@pxref{Idle Scheduler}). You can also toggle the auxiliary minor |
| 62 | modes separately, using their mode functions (e.g. @kbd{M-x | 62 | modes separately, using their mode functions (e.g., @kbd{M-x |
| 63 | semanticdb-minor-mode}), or via the @samp{Development} menu. The | 63 | semanticdb-minor-mode}), or via the @samp{Development} menu. The |
| 64 | various auxiliary minor modes are described in the following sections. | 64 | various auxiliary minor modes are described in the following sections. |
| 65 | 65 | ||
| @@ -105,7 +105,7 @@ valid mode symbols are: | |||
| 105 | Semantic mode provides a number of commands for navigating, querying, | 105 | Semantic mode provides a number of commands for navigating, querying, |
| 106 | and editing source code in a language-aware manner. These commands | 106 | and editing source code in a language-aware manner. These commands |
| 107 | generally act on @dfn{tags}, which are the source-code units deemed | 107 | generally act on @dfn{tags}, which are the source-code units deemed |
| 108 | ``important'' by the present programming language (e.g. functions in | 108 | ``important'' by the present programming language (e.g., functions in |
| 109 | the C programming language). | 109 | the C programming language). |
| 110 | 110 | ||
| 111 | These commands may be used in any buffer that has been parsed by | 111 | These commands may be used in any buffer that has been parsed by |
diff --git a/doc/misc/ses.texi b/doc/misc/ses.texi index cccd74dec0f..fecba99952f 100644 --- a/doc/misc/ses.texi +++ b/doc/misc/ses.texi | |||
| @@ -912,7 +912,7 @@ You can edit the data area, but don't insert or delete any newlines | |||
| 912 | except in the local-variables part, since @acronym{SES} locates things by | 912 | except in the local-variables part, since @acronym{SES} locates things by |
| 913 | counting newlines. Use @kbd{C-x C-e} at the end of a line to install | 913 | counting newlines. Use @kbd{C-x C-e} at the end of a line to install |
| 914 | your edits into the spreadsheet data structures (this does not update | 914 | your edits into the spreadsheet data structures (this does not update |
| 915 | the print area, use e.g. @kbd{C-c C-l} for that). | 915 | the print area, use, e.g., @kbd{C-c C-l} for that). |
| 916 | 916 | ||
| 917 | The data area is maintained as an image of spreadsheet data | 917 | The data area is maintained as an image of spreadsheet data |
| 918 | structures that area stored in buffer-local variables. If the data | 918 | structures that area stored in buffer-local variables. If the data |
diff --git a/doc/misc/smtpmail.texi b/doc/misc/smtpmail.texi index 4e4df3f0bbb..67824afb898 100644 --- a/doc/misc/smtpmail.texi +++ b/doc/misc/smtpmail.texi | |||
| @@ -101,7 +101,7 @@ spool, then. | |||
| 101 | @cindex IMAP | 101 | @cindex IMAP |
| 102 | When your computer is not always connected to the internet, you | 102 | When your computer is not always connected to the internet, you |
| 103 | must get the mail from the remote mail host using a protocol such as | 103 | must get the mail from the remote mail host using a protocol such as |
| 104 | POP3 or IMAP. POP3 essentially downloads all your mail from the mail | 104 | POP3 or IMAP@. POP3 essentially downloads all your mail from the mail |
| 105 | host to your computer. The mail is stored in some file on your | 105 | host to your computer. The mail is stored in some file on your |
| 106 | computer, and again, all your MUA has to do is read mail from the | 106 | computer, and again, all your MUA has to do is read mail from the |
| 107 | spool. | 107 | spool. |
| @@ -219,7 +219,7 @@ The following example illustrates what you could put in | |||
| 219 | @cindex user name | 219 | @cindex user name |
| 220 | Most SMTP servers require clients to authenticate themselves before | 220 | Most SMTP servers require clients to authenticate themselves before |
| 221 | they are allowed to send mail. Authentication usually involves | 221 | they are allowed to send mail. Authentication usually involves |
| 222 | supplying a user name and password. | 222 | supplying a user name and password. |
| 223 | 223 | ||
| 224 | If you have not configured anything, then the first time you try to | 224 | If you have not configured anything, then the first time you try to |
| 225 | send mail via a server, Emacs (version 24.1 and later) prompts you | 225 | send mail via a server, Emacs (version 24.1 and later) prompts you |
| @@ -260,7 +260,7 @@ file, @pxref{Top,,auth-source, auth, Emacs auth-source Library}. | |||
| 260 | The process by which the SMTP library authenticates you to the server | 260 | The process by which the SMTP library authenticates you to the server |
| 261 | is known as ``Simple Authentication and Security Layer'' (SASL). | 261 | is known as ``Simple Authentication and Security Layer'' (SASL). |
| 262 | There are various SASL mechanisms, and this library supports three of | 262 | There are various SASL mechanisms, and this library supports three of |
| 263 | them: CRAM-MD5, PLAIN, and LOGIN. It tries each of them, in that order, | 263 | them: CRAM-MD5, PLAIN, and LOGIN@. It tries each of them, in that order, |
| 264 | until one succeeds. The first uses a form of encryption to obscure | 264 | until one succeeds. The first uses a form of encryption to obscure |
| 265 | your password, while the other two do not. | 265 | your password, while the other two do not. |
| 266 | 266 | ||
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index 708478ca8e9..4918321b171 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi | |||
| @@ -716,7 +716,7 @@ This is another method from the Kerberos suite. It behaves like @option{su}. | |||
| 716 | @cindex plink method | 716 | @cindex plink method |
| 717 | 717 | ||
| 718 | This method is mostly interesting for Windows users using the PuTTY | 718 | This method is mostly interesting for Windows users using the PuTTY |
| 719 | implementation of SSH. It uses @samp{plink -ssh} to log in to the | 719 | implementation of SSH@. It uses @samp{plink -ssh} to log in to the |
| 720 | remote host. | 720 | remote host. |
| 721 | 721 | ||
| 722 | This supports the @samp{-P} argument. | 722 | This supports the @samp{-P} argument. |
| @@ -1006,7 +1006,7 @@ XP, MS Windows Vista, and MS Windows 7. | |||
| 1006 | The first directory in the localname must be a share name on the remote | 1006 | The first directory in the localname must be a share name on the remote |
| 1007 | host. Remember that the @code{$} character, in which default shares | 1007 | host. Remember that the @code{$} character, in which default shares |
| 1008 | usually end, must be written @code{$$} due to environment variable | 1008 | usually end, must be written @code{$$} due to environment variable |
| 1009 | substitution in file names. If no share name is given (i.e. remote | 1009 | substitution in file names. If no share name is given (i.e., remote |
| 1010 | directory @code{/}), all available shares are listed. | 1010 | directory @code{/}), all available shares are listed. |
| 1011 | 1011 | ||
| 1012 | Since authorization is done on share level, you will always be | 1012 | Since authorization is done on share level, you will always be |
| @@ -1053,7 +1053,7 @@ name. | |||
| 1053 | 1053 | ||
| 1054 | The connection methods described in this section are based on GVFS | 1054 | The connection methods described in this section are based on GVFS |
| 1055 | @uref{http://en.wikipedia.org/wiki/GVFS}. Via GVFS, the remote | 1055 | @uref{http://en.wikipedia.org/wiki/GVFS}. Via GVFS, the remote |
| 1056 | filesystem is mounted locally through FUSE. @value{tramp} uses | 1056 | filesystem is mounted locally through FUSE@. @value{tramp} uses |
| 1057 | this local mounted directory internally. | 1057 | this local mounted directory internally. |
| 1058 | 1058 | ||
| 1059 | The communication with GVFS is implemented via D-Bus messages. | 1059 | The communication with GVFS is implemented via D-Bus messages. |
| @@ -1093,7 +1093,7 @@ FUSE, it also needs the SYNCE-GVFS plugin. | |||
| 1093 | 1093 | ||
| 1094 | @defopt tramp-gvfs-methods | 1094 | @defopt tramp-gvfs-methods |
| 1095 | This customer option, a list, defines the external methods which | 1095 | This customer option, a list, defines the external methods which |
| 1096 | shall be used with GVFS. Per default, these are @option{dav}, | 1096 | shall be used with GVFS@. Per default, these are @option{dav}, |
| 1097 | @option{davs}, @option{obex} and @option{synce}. Other possible | 1097 | @option{davs}, @option{obex} and @option{synce}. Other possible |
| 1098 | values are @option{ftp}, @option{sftp} and @option{smb}. | 1098 | values are @option{ftp}, @option{sftp} and @option{smb}. |
| 1099 | @end defopt | 1099 | @end defopt |
| @@ -2939,7 +2939,7 @@ to @code{nil}, @ref{Filename completion}. | |||
| 2939 | 2939 | ||
| 2940 | Disable version control. If you access remote files which are not | 2940 | Disable version control. If you access remote files which are not |
| 2941 | under version control, a lot of check operations can be avoided by | 2941 | under version control, a lot of check operations can be avoided by |
| 2942 | disabling VC. This can be achieved by | 2942 | disabling VC@. This can be achieved by |
| 2943 | 2943 | ||
| 2944 | @lisp | 2944 | @lisp |
| 2945 | (setq vc-ignore-dir-regexp | 2945 | (setq vc-ignore-dir-regexp |
| @@ -3268,7 +3268,7 @@ local host as @samp{root} user, is possible just by @kbd{C-x C-f | |||
| 3268 | 3268 | ||
| 3269 | @item Use configuration possibilities of your method: | 3269 | @item Use configuration possibilities of your method: |
| 3270 | 3270 | ||
| 3271 | Several connection methods (i.e. the programs used) offer powerful | 3271 | Several connection methods (i.e., the programs used) offer powerful |
| 3272 | configuration possibilities (@pxref{Customizing Completion}). In the | 3272 | configuration possibilities (@pxref{Customizing Completion}). In the |
| 3273 | given case, this could be @file{~/.ssh/config}: | 3273 | given case, this could be @file{~/.ssh/config}: |
| 3274 | 3274 | ||
diff --git a/doc/misc/url.texi b/doc/misc/url.texi index 90ab7f5554f..f42007348ee 100644 --- a/doc/misc/url.texi +++ b/doc/misc/url.texi | |||
| @@ -137,7 +137,7 @@ Given a parsed URI, this function returns the corresponding URI string. | |||
| 137 | @cindex parsed URI | 137 | @cindex parsed URI |
| 138 | The return value of @code{url-generic-parse-url}, and the argument | 138 | The return value of @code{url-generic-parse-url}, and the argument |
| 139 | expected by @code{url-recreate-url}, is a @dfn{parsed URI}: a CL | 139 | expected by @code{url-recreate-url}, is a @dfn{parsed URI}: a CL |
| 140 | structure whose slots hold the various components of the URI. | 140 | structure whose slots hold the various components of the URI@. |
| 141 | @xref{top,the CL Manual,,cl,GNU Emacs Common Lisp Emulation}, for | 141 | @xref{top,the CL Manual,,cl,GNU Emacs Common Lisp Emulation}, for |
| 142 | details about CL structures. Most of the other functions in the | 142 | details about CL structures. Most of the other functions in the |
| 143 | @code{url} library act on parsed URIs. | 143 | @code{url} library act on parsed URIs. |
| @@ -154,7 +154,7 @@ details about CL structures. Most of the other functions in the | |||
| 154 | 154 | ||
| 155 | @table @code | 155 | @table @code |
| 156 | @item type | 156 | @item type |
| 157 | The URI scheme (a string, e.g.@: @code{http}). @xref{Supported URL | 157 | The URI scheme (a string, e.g., @code{http}). @xref{Supported URL |
| 158 | Types}, for a list of schemes that the @code{url} library knows how to | 158 | Types}, for a list of schemes that the @code{url} library knows how to |
| 159 | process. This slot can also be @code{nil}, if the URI is not fully | 159 | process. This slot can also be @code{nil}, if the URI is not fully |
| 160 | specified. | 160 | specified. |
| @@ -190,7 +190,7 @@ component specifies a ``secondary resource'', such as a section of a | |||
| 190 | webpage. | 190 | webpage. |
| 191 | 191 | ||
| 192 | @item fullness | 192 | @item fullness |
| 193 | This is @code{t} if the URI is fully specified, i.e.@: the | 193 | This is @code{t} if the URI is fully specified, i.e., the |
| 194 | hierarchical components of the URI (the hostname and/or username | 194 | hierarchical components of the URI (the hostname and/or username |
| 195 | and/or password) are preceded by @samp{//}. | 195 | and/or password) are preceded by @samp{//}. |
| 196 | @end table | 196 | @end table |
| @@ -239,7 +239,7 @@ percent-encoded in accordance with RFC 3986. | |||
| 239 | @defun url-encode-url url-string | 239 | @defun url-encode-url url-string |
| 240 | This function return a properly URI-encoded version of | 240 | This function return a properly URI-encoded version of |
| 241 | @var{url-string}. It also performs @dfn{URI normalization}, | 241 | @var{url-string}. It also performs @dfn{URI normalization}, |
| 242 | e.g.@: converting the scheme component to lowercase if it was | 242 | e.g., converting the scheme component to lowercase if it was |
| 243 | previously uppercase. | 243 | previously uppercase. |
| 244 | @end defun | 244 | @end defun |
| 245 | 245 | ||
| @@ -278,7 +278,7 @@ carriage returns and line feeds, which are normally forbidden in URIs. | |||
| 278 | @chapter Retrieving URLs | 278 | @chapter Retrieving URLs |
| 279 | 279 | ||
| 280 | The @code{url} library defines the following three functions for | 280 | The @code{url} library defines the following three functions for |
| 281 | retrieving the data specified by a URL. The actual retrieval protocol | 281 | retrieving the data specified by a URL@. The actual retrieval protocol |
| 282 | depends on the URL's URI scheme, and is performed by lower-level | 282 | depends on the URL's URI scheme, and is performed by lower-level |
| 283 | scheme-specific functions. (Those lower-level functions are not | 283 | scheme-specific functions. (Those lower-level functions are not |
| 284 | documented here, and generally should not be called directly.) | 284 | documented here, and generally should not be called directly.) |
| @@ -385,7 +385,7 @@ The @code{http} scheme refers to the Hypertext Transfer Protocol. The | |||
| 385 | Its default port is 80. | 385 | Its default port is 80. |
| 386 | 386 | ||
| 387 | The @code{https} scheme is a secure version of @code{http}, with | 387 | The @code{https} scheme is a secure version of @code{http}, with |
| 388 | transmission via SSL. It is defined in RFC 2069, and its default port | 388 | transmission via SSL@. It is defined in RFC 2069, and its default port |
| 389 | is 443. When using @code{https}, the @code{url} library performs SSL | 389 | is 443. When using @code{https}, the @code{url} library performs SSL |
| 390 | encryption via the @code{ssl} library, by forcing the @code{ssl} | 390 | encryption via the @code{ssl} library, by forcing the @code{ssl} |
| 391 | gateway method to be used. @xref{Gateways in general}. | 391 | gateway method to be used. @xref{Gateways in general}. |
| @@ -485,7 +485,7 @@ HTTP supports an @samp{OPTIONS} method describing things supported by | |||
| 485 | the URL@. | 485 | the URL@. |
| 486 | 486 | ||
| 487 | @defun url-http-options url | 487 | @defun url-http-options url |
| 488 | Returns a property list describing options available for URL. The | 488 | Returns a property list describing options available for URL@. The |
| 489 | property list members are: | 489 | property list members are: |
| 490 | 490 | ||
| 491 | @table @code | 491 | @table @code |
| @@ -583,7 +583,7 @@ A @code{mailto} URL specifies an email message to be sent to a given | |||
| 583 | email address. For example, @samp{mailto:foo@@bar.com} specifies | 583 | email address. For example, @samp{mailto:foo@@bar.com} specifies |
| 584 | sending a message to @samp{foo@@bar.com}. The ``retrieval method'' | 584 | sending a message to @samp{foo@@bar.com}. The ``retrieval method'' |
| 585 | for such URLs is to open a mail composition buffer in which the | 585 | for such URLs is to open a mail composition buffer in which the |
| 586 | appropriate content (e.g.@: the recipient address) has been filled in. | 586 | appropriate content (e.g., the recipient address) has been filled in. |
| 587 | 587 | ||
| 588 | As defined in RFC 2368, a @code{mailto} URL has the form | 588 | As defined in RFC 2368, a @code{mailto} URL has the form |
| 589 | 589 | ||
| @@ -652,7 +652,7 @@ tunneled through SSL and has default port 563. | |||
| 652 | @vindex NNTPSERVER | 652 | @vindex NNTPSERVER |
| 653 | @defopt url-news-server | 653 | @defopt url-news-server |
| 654 | This variable specifies the default news server from which to fetch | 654 | This variable specifies the default news server from which to fetch |
| 655 | news, if no server was specified in the URL. The default value, | 655 | news, if no server was specified in the URL@. The default value, |
| 656 | @code{nil}, means to use the server specified by the standard | 656 | @code{nil}, means to use the server specified by the standard |
| 657 | environment variable @samp{NNTPSERVER}, or @samp{news} if that | 657 | environment variable @samp{NNTPSERVER}, or @samp{news} if that |
| 658 | environment variable is unset. | 658 | environment variable is unset. |
diff --git a/doc/misc/vip.texi b/doc/misc/vip.texi index 0d9bb286330..4e85da70ca2 100644 --- a/doc/misc/vip.texi +++ b/doc/misc/vip.texi | |||
| @@ -53,13 +53,13 @@ concentrate mainly on differences from Vi, especially features unique to | |||
| 53 | VIP. | 53 | VIP. |
| 54 | 54 | ||
| 55 | It is recommended that you read nodes on survey and on customization before | 55 | It is recommended that you read nodes on survey and on customization before |
| 56 | you start using VIP. Other nodes may be visited as needed. | 56 | you start using VIP@. Other nodes may be visited as needed. |
| 57 | 57 | ||
| 58 | Comments and bug reports are welcome. Please send messages to | 58 | Comments and bug reports are welcome. Please send messages to |
| 59 | @code{ms@@Sail.Stanford.Edu} if you are outside of Japan and to | 59 | @code{ms@@Sail.Stanford.Edu} if you are outside of Japan and to |
| 60 | @code{masahiko@@sato.riec.tohoku.junet} if you are in Japan.@refill | 60 | @code{masahiko@@sato.riec.tohoku.junet} if you are in Japan.@refill |
| 61 | 61 | ||
| 62 | @insertcopying | 62 | @insertcopying |
| 63 | 63 | ||
| 64 | @end ifnottex | 64 | @end ifnottex |
| 65 | 65 | ||
| @@ -83,7 +83,7 @@ concentrate mainly on differences from Vi, especially features unique to | |||
| 83 | VIP. | 83 | VIP. |
| 84 | 84 | ||
| 85 | It is recommended that you read chapters on survey and on customization | 85 | It is recommended that you read chapters on survey and on customization |
| 86 | before you start using VIP. Other chapters may be used as future | 86 | before you start using VIP@. Other chapters may be used as future |
| 87 | references. | 87 | references. |
| 88 | 88 | ||
| 89 | Comments and bug reports are welcome. Please send messages to | 89 | Comments and bug reports are welcome. Please send messages to |
| @@ -263,7 +263,7 @@ emacs mode vi mode insert mode | |||
| 263 | 263 | ||
| 264 | @kindex 032 @kbd{C-z} (@code{vip-change-mode-to-vi}) | 264 | @kindex 032 @kbd{C-z} (@code{vip-change-mode-to-vi}) |
| 265 | 265 | ||
| 266 | You will be in this mode just after you loaded VIP. You can do all | 266 | You will be in this mode just after you loaded VIP@. You can do all |
| 267 | normal Emacs editing in this mode. Note that the key @kbd{C-z} is globally | 267 | normal Emacs editing in this mode. Note that the key @kbd{C-z} is globally |
| 268 | bound to @code{vip-change-mode-to-vi}. So, if you type @kbd{C-z} in this mode | 268 | bound to @code{vip-change-mode-to-vi}. So, if you type @kbd{C-z} in this mode |
| 269 | then you will be in vi mode.@refill | 269 | then you will be in vi mode.@refill |
| @@ -688,7 +688,7 @@ Replace. | |||
| 688 | @chapter Vi Commands | 688 | @chapter Vi Commands |
| 689 | 689 | ||
| 690 | This chapter describes Vi commands other than Ex commands implemented in | 690 | This chapter describes Vi commands other than Ex commands implemented in |
| 691 | VIP. Except for the last section which discusses insert mode, all the | 691 | VIP@. Except for the last section which discusses insert mode, all the |
| 692 | commands described in this chapter are to be used in vi mode. | 692 | commands described in this chapter are to be used in vi mode. |
| 693 | 693 | ||
| 694 | @menu | 694 | @menu |
| @@ -1716,7 +1716,7 @@ character @samp{|}. | |||
| 1716 | @end menu | 1716 | @end menu |
| 1717 | @node Ex Command Reference, Customization, Ex Commands, Ex Commands | 1717 | @node Ex Command Reference, Customization, Ex Commands, Ex Commands |
| 1718 | @section Ex Command Reference | 1718 | @section Ex Command Reference |
| 1719 | In this section we briefly explain all the Ex commands supported by VIP. | 1719 | In this section we briefly explain all the Ex commands supported by VIP@. |
| 1720 | Most Ex commands expect @var{address} as their argument, and they use | 1720 | Most Ex commands expect @var{address} as their argument, and they use |
| 1721 | default addresses if they are not explicitly given. In the following, such | 1721 | default addresses if they are not explicitly given. In the following, such |
| 1722 | default addresses will be shown in parentheses. | 1722 | default addresses will be shown in parentheses. |
| @@ -1875,7 +1875,7 @@ customizing VIP. | |||
| 1875 | @node Customizing Constants, Customizing Key Bindings, Customization, Customization | 1875 | @node Customizing Constants, Customizing Key Bindings, Customization, Customization |
| 1876 | @section Customizing Constants | 1876 | @section Customizing Constants |
| 1877 | An easy way to customize VIP is to change the values of constants used | 1877 | An easy way to customize VIP is to change the values of constants used |
| 1878 | in VIP. Here is the list of the constants used in VIP and their default | 1878 | in VIP@. Here is the list of the constants used in VIP and their default |
| 1879 | values. | 1879 | values. |
| 1880 | 1880 | ||
| 1881 | @table @code | 1881 | @table @code |
diff --git a/doc/misc/viper.texi b/doc/misc/viper.texi index 94f7e53ce8c..5fb1f92363a 100644 --- a/doc/misc/viper.texi +++ b/doc/misc/viper.texi | |||
| @@ -208,7 +208,7 @@ A buffer has a distinguished position called the @dfn{point}. | |||
| 208 | A @dfn{point} is always between 2 characters, and is @dfn{looking at} | 208 | A @dfn{point} is always between 2 characters, and is @dfn{looking at} |
| 209 | the right hand character. The cursor is positioned on the right hand | 209 | the right hand character. The cursor is positioned on the right hand |
| 210 | character. Thus, when the @dfn{point} is looking at the end-of-line, | 210 | character. Thus, when the @dfn{point} is looking at the end-of-line, |
| 211 | the cursor is on the end-of-line character, i.e.@: beyond the last | 211 | the cursor is on the end-of-line character, i.e., beyond the last |
| 212 | character on the line. This is the default Emacs behavior.@refill | 212 | character on the line. This is the default Emacs behavior.@refill |
| 213 | 213 | ||
| 214 | The default settings of Viper try to mimic the behavior of Vi, preventing | 214 | The default settings of Viper try to mimic the behavior of Vi, preventing |
| @@ -301,7 +301,7 @@ You can also turn Viper on and off at any time while in Vi command mode. | |||
| 301 | more information.@refill | 301 | more information.@refill |
| 302 | 302 | ||
| 303 | Emacs uses Control and Meta modifiers. These are denoted as C and M, | 303 | Emacs uses Control and Meta modifiers. These are denoted as C and M, |
| 304 | e.g.@: @kbd{^Z} as @kbd{C-z} and @kbd{Meta-x} as @kbd{M-x}. The Meta key is | 304 | e.g., @kbd{^Z} as @kbd{C-z} and @kbd{Meta-x} as @kbd{M-x}. The Meta key is |
| 305 | usually located on each side of the Space bar; it is used in a manner | 305 | usually located on each side of the Space bar; it is used in a manner |
| 306 | similar to the Control key, e.g., @kbd{M-x} means typing @kbd{x} while | 306 | similar to the Control key, e.g., @kbd{M-x} means typing @kbd{x} while |
| 307 | holding the Meta key down. For keyboards that do not have a Meta key, | 307 | holding the Meta key down. For keyboards that do not have a Meta key, |
| @@ -2681,7 +2681,7 @@ just left. This lets one use these functions in a multi-frame | |||
| 2681 | configuration. However, this may require some getting used to. For | 2681 | configuration. However, this may require some getting used to. For |
| 2682 | instance, if you are typing in a frame, A, and then move the mouse to frame | 2682 | instance, if you are typing in a frame, A, and then move the mouse to frame |
| 2683 | B and click to invoke mouse search, search (or insertion) will be performed | 2683 | B and click to invoke mouse search, search (or insertion) will be performed |
| 2684 | in frame A. To perform search/insertion in frame B, you will first have to | 2684 | in frame A@. To perform search/insertion in frame B, you will first have to |
| 2685 | shift focus there, which doesn't happen until you type a character or | 2685 | shift focus there, which doesn't happen until you type a character or |
| 2686 | perform some other action in frame B---mouse search doesn't shift focus. | 2686 | perform some other action in frame B---mouse search doesn't shift focus. |
| 2687 | 2687 | ||
| @@ -3670,7 +3670,7 @@ Join <count> lines (default 2). | |||
| 3670 | @item :[x,y]s/<pat>/<repl>/<f> | 3670 | @item :[x,y]s/<pat>/<repl>/<f> |
| 3671 | Substitute (on lines x through y) the pattern | 3671 | Substitute (on lines x through y) the pattern |
| 3672 | <pat> (default the last pattern) with <repl>. Useful | 3672 | <pat> (default the last pattern) with <repl>. Useful |
| 3673 | flags <f> are @samp{g} for @samp{global} (i.e.@: change every | 3673 | flags <f> are @samp{g} for @samp{global} (i.e., change every |
| 3674 | non-overlapping occurrence of <pat>) and @samp{c} for | 3674 | non-overlapping occurrence of <pat>) and @samp{c} for |
| 3675 | @samp{confirm} (type @samp{y} to confirm a particular | 3675 | @samp{confirm} (type @samp{y} to confirm a particular |
| 3676 | substitution, else @samp{n} ). Instead of @kbd{/} any | 3676 | substitution, else @samp{n} ). Instead of @kbd{/} any |
| @@ -3694,7 +3694,7 @@ Same as @kbd{:copy}. | |||
| 3694 | @item :[x,y]move [z] | 3694 | @item :[x,y]move [z] |
| 3695 | Move text between @kbd{x} and @kbd{y} to the position after @kbd{z}. | 3695 | Move text between @kbd{x} and @kbd{y} to the position after @kbd{z}. |
| 3696 | @item & | 3696 | @item & |
| 3697 | Repeat latest Ex substitute command, e.g. | 3697 | Repeat latest Ex substitute command, e.g., |
| 3698 | @kbd{:s/wrong/right}. | 3698 | @kbd{:s/wrong/right}. |
| 3699 | @item :x,yp | 3699 | @item :x,yp |
| 3700 | @itemx :g/Pat/p | 3700 | @itemx :g/Pat/p |
| @@ -3794,7 +3794,7 @@ Search in the tags file where <name> is defined (file, line), and go to it. | |||
| 3794 | @item :[x,y]s/<pat>/<repl>/<f> | 3794 | @item :[x,y]s/<pat>/<repl>/<f> |
| 3795 | Substitute (on lines x through y) the pattern <pat> (default the last | 3795 | Substitute (on lines x through y) the pattern <pat> (default the last |
| 3796 | pattern) with <repl>. Useful | 3796 | pattern) with <repl>. Useful |
| 3797 | flags <f> are @samp{g} for @samp{global} (i.e.@: change every | 3797 | flags <f> are @samp{g} for @samp{global} (i.e., change every |
| 3798 | non-overlapping occurrence of <pat>) and @samp{c} for | 3798 | non-overlapping occurrence of <pat>) and @samp{c} for |
| 3799 | @samp{confirm} (type @samp{y} to confirm a particular | 3799 | @samp{confirm} (type @samp{y} to confirm a particular |
| 3800 | substitution, else @samp{n}). Instead of @kbd{/} any | 3800 | substitution, else @samp{n}). Instead of @kbd{/} any |
| @@ -3804,7 +3804,7 @@ delimiter. | |||
| 3804 | Note: @emph{The newline character (inserted as @kbd{C-qC-j}) | 3804 | Note: @emph{The newline character (inserted as @kbd{C-qC-j}) |
| 3805 | can be used in <repl>}. | 3805 | can be used in <repl>}. |
| 3806 | @item & | 3806 | @item & |
| 3807 | Repeat latest Ex substitute command, e.g.@: @kbd{:s/wrong/right}. | 3807 | Repeat latest Ex substitute command, e.g., @kbd{:s/wrong/right}. |
| 3808 | @item :global /<pattern>/<ex-command> | 3808 | @item :global /<pattern>/<ex-command> |
| 3809 | @itemx :g /<pattern>/<ex-command> | 3809 | @itemx :g /<pattern>/<ex-command> |
| 3810 | Execute <ex-command> on all lines that match <pattern>. | 3810 | Execute <ex-command> on all lines that match <pattern>. |
| @@ -4476,12 +4476,12 @@ dxc@@xprt.net (David X Callaway), | |||
| 4476 | edmonds@@edmonds.home.cs.ubc.ca (Brian Edmonds), | 4476 | edmonds@@edmonds.home.cs.ubc.ca (Brian Edmonds), |
| 4477 | gin@@mo.msk.ru (Golubev I.N.), | 4477 | gin@@mo.msk.ru (Golubev I.N.), |
| 4478 | gviswana@@cs.wisc.edu (Guhan Viswanathan), | 4478 | gviswana@@cs.wisc.edu (Guhan Viswanathan), |
| 4479 | gvr@@halcyon.com (George V.@: Reilly), | 4479 | gvr@@halcyon.com (George V. Reilly), |
| 4480 | hatazaki@@bach.convex.com (Takao Hatazaki), | 4480 | hatazaki@@bach.convex.com (Takao Hatazaki), |
| 4481 | hpz@@ibmhpz.aug.ipp-garching.mpg.de (Hans-Peter Zehrfeld), | 4481 | hpz@@ibmhpz.aug.ipp-garching.mpg.de (Hans-Peter Zehrfeld), |
| 4482 | irie@@t.email.ne.jp (Irie Tetsuya), | 4482 | irie@@t.email.ne.jp (Irie Tetsuya), |
| 4483 | jackr@@dblues.engr.sgi.com (Jack Repenning), | 4483 | jackr@@dblues.engr.sgi.com (Jack Repenning), |
| 4484 | jamesm@@bga.com (D.J.@: Miller II), | 4484 | jamesm@@bga.com (D.J. Miller II), |
| 4485 | jjm@@hplb.hpl.hp.com (Jean-Jacques Moreau), | 4485 | jjm@@hplb.hpl.hp.com (Jean-Jacques Moreau), |
| 4486 | jl@@cse.ogi.edu (John Launchbury), | 4486 | jl@@cse.ogi.edu (John Launchbury), |
| 4487 | jobrien@@hchp.org (John O'Brien), | 4487 | jobrien@@hchp.org (John O'Brien), |
diff --git a/doc/misc/widget.texi b/doc/misc/widget.texi index 24fe3e63ac9..4152b52250c 100644 --- a/doc/misc/widget.texi +++ b/doc/misc/widget.texi | |||
| @@ -663,7 +663,7 @@ in the buffer with a positive tabbing order, or @code{nil} | |||
| 663 | 663 | ||
| 664 | @vindex parent@r{ keyword} | 664 | @vindex parent@r{ keyword} |
| 665 | @item :parent | 665 | @item :parent |
| 666 | The parent of a nested widget (e.g.@: a @code{menu-choice} item or an | 666 | The parent of a nested widget (e.g., a @code{menu-choice} item or an |
| 667 | element of a @code{editable-list} widget). | 667 | element of a @code{editable-list} widget). |
| 668 | 668 | ||
| 669 | @vindex sibling-args@r{ keyword} | 669 | @vindex sibling-args@r{ keyword} |
| @@ -813,7 +813,7 @@ Face used for highlighting the editable field. Default is | |||
| 813 | 813 | ||
| 814 | @vindex secret@r{ keyword} | 814 | @vindex secret@r{ keyword} |
| 815 | @item :secret | 815 | @item :secret |
| 816 | Character used to display the value. You can set this to e.g.@: @code{?*} | 816 | Character used to display the value. You can set this to, e.g., @code{?*} |
| 817 | if the field contains a password or other secret information. By | 817 | if the field contains a password or other secret information. By |
| 818 | default, this is @code{nil}, and the value is not secret. | 818 | default, this is @code{nil}, and the value is not secret. |
| 819 | 819 | ||
| @@ -918,8 +918,8 @@ Insert a literal @samp{%}. | |||
| 918 | 918 | ||
| 919 | @vindex button-args@r{ keyword} | 919 | @vindex button-args@r{ keyword} |
| 920 | @item :button-args | 920 | @item :button-args |
| 921 | A list of keywords to pass to the radio buttons. Useful for setting | 921 | A list of keywords to pass to the radio buttons. Useful for setting, |
| 922 | e.g.@: the @samp{:help-echo} for each button. | 922 | e.g., the @samp{:help-echo} for each button. |
| 923 | 923 | ||
| 924 | @vindex buttons@r{ keyword} | 924 | @vindex buttons@r{ keyword} |
| 925 | @item :buttons | 925 | @item :buttons |
| @@ -1068,12 +1068,12 @@ Usually a checklist will only match if the items are in the exact | |||
| 1068 | sequence given in the specification. By setting @code{:greedy} to | 1068 | sequence given in the specification. By setting @code{:greedy} to |
| 1069 | non-@code{nil}, it will allow the items to come in any sequence. | 1069 | non-@code{nil}, it will allow the items to come in any sequence. |
| 1070 | However, if you extract the value they will be in the sequence given | 1070 | However, if you extract the value they will be in the sequence given |
| 1071 | in the checklist, i.e.@: the original sequence is forgotten. | 1071 | in the checklist, i.e., the original sequence is forgotten. |
| 1072 | 1072 | ||
| 1073 | @vindex button-args@r{ keyword} | 1073 | @vindex button-args@r{ keyword} |
| 1074 | @item :button-args | 1074 | @item :button-args |
| 1075 | A list of keywords to pass to the checkboxes. Useful for setting | 1075 | A list of keywords to pass to the checkboxes. Useful for setting, |
| 1076 | e.g.@: the @samp{:help-echo} for each checkbox. | 1076 | e.g., the @samp{:help-echo} for each checkbox. |
| 1077 | 1077 | ||
| 1078 | @vindex buttons@r{ keyword} | 1078 | @vindex buttons@r{ keyword} |
| 1079 | @item :buttons | 1079 | @item :buttons |
| @@ -1464,7 +1464,7 @@ property @var{property}. | |||
| 1464 | @end defun | 1464 | @end defun |
| 1465 | 1465 | ||
| 1466 | Occasionally it can be useful to know which kind of widget you have, | 1466 | Occasionally it can be useful to know which kind of widget you have, |
| 1467 | i.e.@: the name of the widget type you gave when the widget was created. | 1467 | i.e., the name of the widget type you gave when the widget was created. |
| 1468 | 1468 | ||
| 1469 | @defun widget-type widget | 1469 | @defun widget-type widget |
| 1470 | Return the name of @var{widget}, a symbol. | 1470 | Return the name of @var{widget}, a symbol. |
diff --git a/doc/misc/woman.texi b/doc/misc/woman.texi index 7f72b5faafb..16fb83ad18f 100644 --- a/doc/misc/woman.texi +++ b/doc/misc/woman.texi | |||
| @@ -385,7 +385,7 @@ configuration file named (by default) @file{man.conf} (or something very | |||
| 385 | similar), which seems to be the standard mechanism under GNU/Linux, then | 385 | similar), which seems to be the standard mechanism under GNU/Linux, then |
| 386 | it parses that. To be precise, ``something very similar'' means | 386 | it parses that. To be precise, ``something very similar'' means |
| 387 | starting with @samp{man} and ending with @samp{.conf} and possibly more | 387 | starting with @samp{man} and ending with @samp{.conf} and possibly more |
| 388 | lowercase letters, e.g.@: @file{manual.configuration}. | 388 | lowercase letters, e.g., @file{manual.configuration}. |
| 389 | The search path and/or precise full path name for this file are set by | 389 | The search path and/or precise full path name for this file are set by |
| 390 | the value of the customizable user option @code{woman-man.conf-path}. | 390 | the value of the customizable user option @code{woman-man.conf-path}. |
| 391 | If all else fails, WoMan uses a plausible default man search path. | 391 | If all else fails, WoMan uses a plausible default man search path. |
| @@ -414,7 +414,7 @@ files that it can access, which can be very slow, especially if a | |||
| 414 | network is involved. For this reason, it caches various amounts of | 414 | network is involved. For this reason, it caches various amounts of |
| 415 | information, after which retrieving it from the cache is very fast. If | 415 | information, after which retrieving it from the cache is very fast. If |
| 416 | the cache ever gets out of synchronism with reality, running the | 416 | the cache ever gets out of synchronism with reality, running the |
| 417 | @code{woman} command with a prefix argument (e.g.@: @kbd{C-u M-x woman}) | 417 | @code{woman} command with a prefix argument (e.g., @kbd{C-u M-x woman}) |
| 418 | will force it to rebuild its cache. This is necessary only if the names | 418 | will force it to rebuild its cache. This is necessary only if the names |
| 419 | or locations of any man files change; it is not necessary if only their | 419 | or locations of any man files change; it is not necessary if only their |
| 420 | contents change. It would always be necessary if such a change occurred | 420 | contents change. It would always be necessary if such a change occurred |
| @@ -485,7 +485,7 @@ You can also bind the variable @code{woman-use-topic-at-point} locally | |||
| 485 | to a non-@code{nil} value (using @code{let}), in which case | 485 | to a non-@code{nil} value (using @code{let}), in which case |
| 486 | @code{woman} will can use the suggested topic without confirmation if | 486 | @code{woman} will can use the suggested topic without confirmation if |
| 487 | possible. This may be useful to provide special private key bindings, | 487 | possible. This may be useful to provide special private key bindings, |
| 488 | e.g.@: this key binding for @kbd{C-c w} runs WoMan on the topic at | 488 | e.g., this key binding for @kbd{C-c w} runs WoMan on the topic at |
| 489 | point without seeking confirmation: | 489 | point without seeking confirmation: |
| 490 | 490 | ||
| 491 | @lisp | 491 | @lisp |
| @@ -511,7 +511,7 @@ The filename interface is accessed principally via the extended command | |||
| 511 | all (provided WoMan is installed and loaded or set up to autoload). | 511 | all (provided WoMan is installed and loaded or set up to autoload). |
| 512 | This command can be used to browse any accessible man file, regardless | 512 | This command can be used to browse any accessible man file, regardless |
| 513 | of its filename or location. If the file is compressed then automatic | 513 | of its filename or location. If the file is compressed then automatic |
| 514 | file decompression must already be turned on (e.g.@: see the | 514 | file decompression must already be turned on (e.g., see the |
| 515 | @samp{Help->Options} submenu)---it is turned on automatically only by | 515 | @samp{Help->Options} submenu)---it is turned on automatically only by |
| 516 | the @code{woman} topic interface. | 516 | the @code{woman} topic interface. |
| 517 | 517 | ||
| @@ -554,7 +554,7 @@ primarily used internally by WoMan. | |||
| 554 | 554 | ||
| 555 | Emacs provides an interface to detect automatically the format of a file | 555 | Emacs provides an interface to detect automatically the format of a file |
| 556 | and decode it when it is visited. It is used primarily by the | 556 | and decode it when it is visited. It is used primarily by the |
| 557 | facilities for editing rich (i.e.@: formatted) text, as a way to store | 557 | facilities for editing rich (i.e., formatted) text, as a way to store |
| 558 | formatting information transparently as @acronym{ASCII} markup. WoMan can in | 558 | formatting information transparently as @acronym{ASCII} markup. WoMan can in |
| 559 | principle use this interface, but it must be configured explicitly. | 559 | principle use this interface, but it must be configured explicitly. |
| 560 | 560 | ||
| @@ -686,7 +686,7 @@ described by @code{Man-see-also-regexp}. | |||
| 686 | 686 | ||
| 687 | Man pages usually contain a ``SEE ALSO'' section containing references | 687 | Man pages usually contain a ``SEE ALSO'' section containing references |
| 688 | to other man pages. If these man pages are installed then WoMan can | 688 | to other man pages. If these man pages are installed then WoMan can |
| 689 | easily be directed to follow the reference, i.e.@: to find and format the | 689 | easily be directed to follow the reference, i.e., to find and format the |
| 690 | man page. When the mouse is passed over a correctly formatted reference | 690 | man page. When the mouse is passed over a correctly formatted reference |
| 691 | it is highlighted, in which case clicking the middle button | 691 | it is highlighted, in which case clicking the middle button |
| 692 | @kbd{Mouse-2} will cause WoMan to follow the reference. Alternatively, | 692 | @kbd{Mouse-2} will cause WoMan to follow the reference. Alternatively, |
| @@ -763,13 +763,13 @@ item had been used. | |||
| 763 | @kindex q | 763 | @kindex q |
| 764 | @findex Man-quit | 764 | @findex Man-quit |
| 765 | Bury the buffer containing the current man page (@code{Man-quit}), | 765 | Bury the buffer containing the current man page (@code{Man-quit}), |
| 766 | i.e.@: move it to the bottom of the buffer stack. | 766 | i.e., move it to the bottom of the buffer stack. |
| 767 | 767 | ||
| 768 | @item k | 768 | @item k |
| 769 | @kindex k | 769 | @kindex k |
| 770 | @findex Man-kill | 770 | @findex Man-kill |
| 771 | Kill the buffer containing the current man page (@code{Man-kill}), | 771 | Kill the buffer containing the current man page (@code{Man-kill}), |
| 772 | i.e.@: delete it completely so that it can be retrieved only by formatting | 772 | i.e., delete it completely so that it can be retrieved only by formatting |
| 773 | the page again. | 773 | the page again. |
| 774 | 774 | ||
| 775 | @item M-p | 775 | @item M-p |
| @@ -786,7 +786,7 @@ Find the next WoMan buffer (@code{WoMan-next-manpage}). | |||
| 786 | @kindex R | 786 | @kindex R |
| 787 | @findex woman-reformat-last-file | 787 | @findex woman-reformat-last-file |
| 788 | Call WoMan to reformat the last man page formatted by WoMan | 788 | Call WoMan to reformat the last man page formatted by WoMan |
| 789 | (@code{woman-reformat-last-file}), e.g.@: after changing the fill column. | 789 | (@code{woman-reformat-last-file}), e.g., after changing the fill column. |
| 790 | @end table | 790 | @end table |
| 791 | 791 | ||
| 792 | 792 | ||
| @@ -862,7 +862,7 @@ All WoMan user options are customizable, and it is recommended to | |||
| 862 | change them only via the standard Emacs customization facilities. | 862 | change them only via the standard Emacs customization facilities. |
| 863 | WoMan defines a top-level customization group called @code{WoMan} | 863 | WoMan defines a top-level customization group called @code{WoMan} |
| 864 | under the parent group @code{Help}. It can be accessed either via the | 864 | under the parent group @code{Help}. It can be accessed either via the |
| 865 | standard Emacs facilities, e.g.@: via the @samp{Help->Customize} | 865 | standard Emacs facilities, e.g., via the @samp{Help->Customize} |
| 866 | submenu, or via the WoMan major mode menu. | 866 | submenu, or via the WoMan major mode menu. |
| 867 | 867 | ||
| 868 | The top-level WoMan group contains only a few general options and three | 868 | The top-level WoMan group contains only a few general options and three |
| @@ -874,7 +874,7 @@ customization should be possible via existing user options. | |||
| 874 | @vtable @code | 874 | @vtable @code |
| 875 | @item woman-show-log | 875 | @item woman-show-log |
| 876 | A boolean value that defaults to @code{nil}. If non-@code{nil} then show the | 876 | A boolean value that defaults to @code{nil}. If non-@code{nil} then show the |
| 877 | @code{*WoMan-Log*} buffer if appropriate, i.e.@: if any warning messages | 877 | @code{*WoMan-Log*} buffer if appropriate, i.e., if any warning messages |
| 878 | are written to it. @xref{Log, , The *WoMan-Log* Buffer}. | 878 | are written to it. @xref{Log, , The *WoMan-Log* Buffer}. |
| 879 | 879 | ||
| 880 | @item woman-pre-format-hook | 880 | @item woman-pre-format-hook |
| @@ -960,13 +960,13 @@ is | |||
| 960 | @end lisp | 960 | @end lisp |
| 961 | 961 | ||
| 962 | Any environment variables (names of which must have the Unix-style form | 962 | Any environment variables (names of which must have the Unix-style form |
| 963 | @code{$NAME}, e.g.@: @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR}, | 963 | @code{$NAME}, e.g., @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR}, |
| 964 | regardless of platform) are evaluated first but each element must | 964 | regardless of platform) are evaluated first but each element must |
| 965 | evaluate to a @emph{single} directory name. Trailing @file{/}s are | 965 | evaluate to a @emph{single} directory name. Trailing @file{/}s are |
| 966 | ignored. (Specific directories in @code{woman-path} are also searched.) | 966 | ignored. (Specific directories in @code{woman-path} are also searched.) |
| 967 | 967 | ||
| 968 | On Microsoft platforms I recommend including drive letters explicitly, | 968 | On Microsoft platforms I recommend including drive letters explicitly, |
| 969 | e.g. | 969 | e.g.: |
| 970 | 970 | ||
| 971 | @lisp | 971 | @lisp |
| 972 | ("C:/Cygwin/usr/man" "C:/usr/man" "C:/usr/local/man") | 972 | ("C:/Cygwin/usr/man" "C:/usr/man" "C:/usr/local/man") |
| @@ -1010,7 +1010,7 @@ and unreadable files are ignored. The default value on MS-DOS is | |||
| 1010 | and on other platforms is @code{nil}. | 1010 | and on other platforms is @code{nil}. |
| 1011 | 1011 | ||
| 1012 | Any environment variables (names of which must have the Unix-style form | 1012 | Any environment variables (names of which must have the Unix-style form |
| 1013 | @code{$NAME}, e.g.@: @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR}, | 1013 | @code{$NAME}, e.g., @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR}, |
| 1014 | regardless of platform) are evaluated first but each element must | 1014 | regardless of platform) are evaluated first but each element must |
| 1015 | evaluate to a @emph{single} directory name (regexp, see above). For | 1015 | evaluate to a @emph{single} directory name (regexp, see above). For |
| 1016 | example | 1016 | example |
| @@ -1064,7 +1064,7 @@ suppresses this action. The ``standard'' non-@code{nil} filename is | |||
| 1064 | 1064 | ||
| 1065 | @item woman-dired-keys | 1065 | @item woman-dired-keys |
| 1066 | A list of @code{dired} mode keys to be defined to run WoMan on the | 1066 | A list of @code{dired} mode keys to be defined to run WoMan on the |
| 1067 | current file, e.g.@: @code{("w" "W")} or any non-@code{nil} atom to | 1067 | current file, e.g., @code{("w" "W")} or any non-@code{nil} atom to |
| 1068 | automatically define @kbd{w} and @kbd{W} if they are unbound, or | 1068 | automatically define @kbd{w} and @kbd{W} if they are unbound, or |
| 1069 | @code{nil} to do nothing. Default is @code{t}. | 1069 | @code{nil} to do nothing. Default is @code{t}. |
| 1070 | 1070 | ||
| @@ -1229,7 +1229,7 @@ WoMan provides partial experimental support for special symbols, | |||
| 1229 | initially only for MS-Windows and only for MS-Windows fonts. This | 1229 | initially only for MS-Windows and only for MS-Windows fonts. This |
| 1230 | includes both non-@acronym{ASCII} characters from the main text font and use | 1230 | includes both non-@acronym{ASCII} characters from the main text font and use |
| 1231 | of a separate symbol font. Later, support will be added for other font | 1231 | of a separate symbol font. Later, support will be added for other font |
| 1232 | types (e.g.@: @code{bdf} fonts) and for the X Window System. In Emacs | 1232 | types (e.g., @code{bdf} fonts) and for the X Window System. In Emacs |
| 1233 | 20.7, the current support works partially under Windows 9x but may not | 1233 | 20.7, the current support works partially under Windows 9x but may not |
| 1234 | work on any other platform. | 1234 | work on any other platform. |
| 1235 | 1235 | ||
| @@ -1312,7 +1312,7 @@ is output. | |||
| 1312 | @cindex reporting bugs | 1312 | @cindex reporting bugs |
| 1313 | @cindex bugs, reporting | 1313 | @cindex bugs, reporting |
| 1314 | 1314 | ||
| 1315 | If WoMan fails completely, or formats a file incorrectly (i.e.@: | 1315 | If WoMan fails completely, or formats a file incorrectly (i.e., |
| 1316 | obviously wrongly or significantly differently from @code{man}) or | 1316 | obviously wrongly or significantly differently from @code{man}) or |
| 1317 | inelegantly, then please | 1317 | inelegantly, then please |
| 1318 | 1318 | ||