diff options
Diffstat (limited to 'doc/misc')
45 files changed, 648 insertions, 648 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). Similarly, the auth-source library supports multiple storage backend, currently either the classic ``netrc'' backend, examples of which you -can see later in this document, or the Secret Service API. This is +can see later in this document, or the Secret Service API@. This is done with EIEIO-based backends and you can write your own if you want. @node Help for users @@ -213,7 +213,7 @@ machine yourmachine.com:80 port http login testuser password testpass @end example This will match any realm and authentication method (basic or digest) -over HTTP. HTTPS is set up similarly. If you want finer controls, +over HTTP@. HTTPS is set up similarly. If you want finer controls, explore the url-auth source code and variables. For Tramp authentication, use: @@ -238,7 +238,7 @@ KDE Wallet (these are GNOME and KDE packages respectively and should be available on most modern GNU/Linux systems). The auth-source library uses the @file{secrets.el} library to connect -through the Secret Service API. You can also use that library in +through the Secret Service API@. You can also use that library in other packages, it's not exclusive to auth-source. @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} or @kbd{C-h}. This means that entering an empty string will simply assume that you are finished. Typing quit on the other hand terminates the loop but also the rest of the -skeleton, e.g. an ``else'' clause is skipped. Only a syntactically necessary +skeleton, e.g., an ``else'' clause is skipped. Only a syntactically necessary termination still gets inserted. @@ -147,8 +147,8 @@ reindent the wrapped code for you. Skeleton commands take an optional numeric prefix argument (@pxref{(emacs)Arguments}). This is interpreted in two different ways depending -on whether the prefix is positive, i.e. forwards oriented or negative, -i.e. backwards oriented. +on whether the prefix is positive, i.e., forwards oriented, or negative, +i.e., backwards oriented. A positive prefix means to wrap the skeleton around that many following words. This is accomplished by putting the words there where @@ -178,7 +178,7 @@ ignored. If, on the other hand, you marked in alphabetical order the points [] A C B, and call a skeleton command with @kbd{M-- 3}, you will wrap the text from -point to A, then the text from A to C and finally the text from C to B. This +point to A, then the text from A to C and finally the text from C to B@. This is done because the regions overlap and Emacs would be helplessly lost if it tried to follow the order in which you marked these points. @@ -241,10 +241,10 @@ put at these places. Point is left at first @code{_} where nothing is wrapped. Indent line according to major mode. When following element is @code{_}, and there is a interregion that will be wrapped here, indent that interregion. @item @code{&} -Logical and. Iff preceding element moved point, i.e. usually inserted +Logical and. Iff preceding element moved point, i.e., usually inserted something, do following element. @item @code{|} -Logical xor. Iff preceding element didn't move point, i.e. usually inserted +Logical xor. Iff preceding element didn't move point, i.e., usually inserted nothing, do following element. @item @code{-@var{number}} Delete preceding number characters. Depends on value of @@ -376,7 +376,7 @@ be inserted. can simply insert some text, indeed, it can be skeleton command (@pxref{Using Skeletons}). It can be a lambda function which will for example conditionally call another function. Or it can even reset the mode for the buffer. If you -want to perform several such actions in order, you use a vector, i.e. several +want to perform several such actions in order, you use a vector, i.e., several of the above elements between square brackets (@samp{[@r{@dots{}}]}). By default C and C++ headers insert a definition of a symbol derived from @@ -402,12 +402,12 @@ define-auto-insert}. @vindex auto-insert The variable @code{auto-insert} says what to do when @code{auto-insert} is -called non-interactively, e.g. when a newly found file is empty (see above): +called non-interactively, e.g., when a newly found file is empty (see above): @table @asis @item @code{nil} Do nothing. @item @code{t} -Insert something if possible, i.e. there is a matching entry in +Insert something if possible, i.e., there is a matching entry in @code{auto-insert-alist}. @item other 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 @kbd{M-x copyright-update} looks for a copyright notice in the first @code{copyright-limit} characters of the buffer and updates it when necessary. The current year (variable @code{copyright-current-year}) is added to the -existing ones, in the same format as the preceding year, i.e. 1994, '94 or 94. +existing ones, in the same format as the preceding year, i.e., 1994, '94 or 94. If a dash-separated year list up to last year is found, that is extended to current year, else the year is added separated by a comma. Or it replaces them when this is called with a prefix argument. If a header referring to a @@ -492,7 +492,7 @@ intended for resource files, which are only meant to be read in. @vindex executable-insert The variable @code{executable-insert} says what to do when -@code{executable-set-magic} is called non-interactively, e.g. when file has no +@code{executable-set-magic} is called non-interactively, e.g., when file has no or the wrong magic number: @table @asis @item @code{nil} diff --git a/doc/misc/calc.texi b/doc/misc/calc.texi index 2b198575bcb..14e34f53c7f 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, this manual ought to be readable even if you don't know or use Emacs regularly. -This manual is divided into three major parts:@: the ``Getting +This manual is divided into three major parts: the ``Getting Started'' chapter you are reading now, the Calc tutorial, and the Calc reference manual. @c [when-split] @@ -1186,7 +1186,7 @@ since the large integer arithmetic was there anyway it seemed only fair to give the user direct access to it, which in turn made it practical to support fractions as well as floats. All these features inspired me to look around for other data types that might be worth -having. +having. Around this time, my friend Rick Koshi showed me his nifty new HP-28 calculator. It allowed the user to manipulate formulas as well as @@ -5693,7 +5693,7 @@ on the stack, we want to be able to type @kbd{*} and get the result rearranged. (This one is rather tricky; the solution at the end of this chapter uses 6 rewrite rules. Hint: The @samp{constant(x)} condition tests whether @samp{x} is a number.) @xref{Rewrites Answer -6, 6}. (@bullet{}) +6, 6}. (@bullet{}) Just for kicks, try adding the rule @code{2+3 := 6} to @code{EvalRules}. What happens? (Be sure to remove this rule afterward, or you might get @@ -8697,7 +8697,7 @@ Multiplying by the conjugate helps because @expr{(a+b) (a-b) = a^2 - b^2}. @smallexample @group ___ -1: V 2 +1: V 2 . a r a*(b+c) := a*b + a*c @@ -10518,7 +10518,7 @@ Integers, fractions, and floats are various ways of describing real numbers. HMS forms also for many purposes act as real numbers. These types can be combined to form complex numbers, modulo forms, error forms, or interval forms. (But these last four types cannot be combined -arbitrarily:@: error forms may not contain modulo forms, for example.) +arbitrarily: error forms may not contain modulo forms, for example.) Finally, all these types of numbers may be combined into vectors, matrices, or algebraic formulas. @@ -11010,7 +11010,7 @@ You can use the @kbd{v p} (@code{calc-pack}) and @kbd{v u} of a date form. @xref{Packing and Unpacking}. Date forms can go arbitrarily far into the future or past. Negative -year numbers represent years BC. Calc uses a combination of the +year numbers represent years BC@. Calc uses a combination of the Gregorian and Julian calendars, following the history of Great Britain and the British colonies. This is the same calendar that is used by the @code{cal} program in most Unix implementations. @@ -11022,7 +11022,7 @@ Julius Caesar in the year 46 BC as an attempt to fix the gradual drift caused by the lack of leap years in the calendar used until that time. The Julian calendar introduced an extra day in all years divisible by four. After some initial confusion, the -calendar was adopted around the year we call 8 AD. Some centuries +calendar was adopted around the year we call 8 AD@. Some centuries later it became apparent that the Julian year of 365.25 days was itself not quite right. In 1582 Pope Gregory XIII introduced the Gregorian calendar, which added the new rule that years divisible @@ -12641,7 +12641,7 @@ are simplified with their unit definitions in mind. A common technique is to set the simplification mode down to the lowest amount of simplification you will allow to be applied automatically, then use manual commands like @kbd{a s} and @kbd{c c} (@code{calc-clean}) to -perform higher types of simplifications on demand. +perform higher types of simplifications on demand. @node Declarations, Display Modes, Simplification Modes, Mode Settings @section Declarations @@ -12992,7 +12992,7 @@ The @code{dneg} function checks for negative reals. The @code{dnonneg} function checks for nonnegative reals, i.e., reals greater than or equal to zero. Note that Calc's algebraic simplifications, which are effectively applied to all conditions in rewrite rules, can simplify -an expression like @expr{x > 0} to 1 or 0 using @code{dpos}. +an expression like @expr{x > 0} to 1 or 0 using @code{dpos}. So the actual functions @code{dpos}, @code{dneg}, and @code{dnonneg} are rarely necessary. @@ -13427,7 +13427,7 @@ the time part. The punctuation characters (including spaces) must match exactly; letter fields must correspond to suitable text in the input. If this doesn't work, Calc checks if the input is a simple number; if so, the number is interpreted as a number of days -since Jan 1, 1 AD. Otherwise, Calc tries a much more relaxed and +since Jan 1, 1 AD@. Otherwise, Calc tries a much more relaxed and flexible algorithm which is described in the next section. Weekday names are ignored during reading. @@ -13460,7 +13460,7 @@ Year: ``ad '' or blank. (Note trailing space.) @item AAA Year: ``AD '' or blank. @item aaaa -Year: ``a.d.'' or blank. +Year: ``a.d.@:'' or blank. @item AAAA Year: ``A.D.'' or blank. @item bb @@ -13472,7 +13472,7 @@ Year: `` bc'' or blank. (Note leading space.) @item BBB Year: `` BC'' or blank. @item bbbb -Year: ``b.c.'' or blank. +Year: ``b.c.@:'' or blank. @item BBBB Year: ``B.C.'' or blank. @item M @@ -13536,7 +13536,7 @@ AM/PM: ``am'' or ``pm''. @item PP AM/PM: ``AM'' or ``PM''. @item pppp -AM/PM: ``a.m.'' or ``p.m.''. +AM/PM: ``a.m.@:'' or ``p.m.''. @item PPPP AM/PM: ``A.M.'' or ``P.M.''. @item m @@ -14656,7 +14656,7 @@ Subscripts use double square brackets: @samp{a[[i]]}. The @kbd{d W} (@code{calc-maple-language}) command selects the conventions of Maple. -Maple's language is much like C. Underscores are allowed in symbol +Maple's language is much like C@. Underscores are allowed in symbol names; square brackets are used for subscripts; explicit @samp{*}s for multiplications are required. Use either @samp{^} or @samp{**} to denote powers. @@ -16717,7 +16717,7 @@ number (i.e., pervasively). If the simplification mode is set below basic simplification, it is raised for the purposes of this command. Thus, @kbd{c c} applies the basic simplifications even if their automatic application is disabled. -@xref{Simplification Modes}. +@xref{Simplification Modes}. @cindex Roundoff errors, correcting A numeric prefix argument to @kbd{c c} sets the floating-point precision @@ -16794,7 +16794,7 @@ additional argument from the top of the stack. @pindex calc-date @tindex date The @kbd{t D} (@code{calc-date}) [@code{date}] command converts a -date form into a number, measured in days since Jan 1, 1 AD. The +date form into a number, measured in days since Jan 1, 1 AD@. The result will be an integer if @var{date} is a pure date form, or a fraction or float if @var{date} is a date/time form. Or, if its argument is a number, it converts this number into a date form. @@ -16832,7 +16832,7 @@ The last two arguments default to zero if omitted. @cindex Julian day counts, conversions The @kbd{t J} (@code{calc-julian}) [@code{julian}] command converts a date form into a Julian day count, which is the number of days -since noon (GMT) on Jan 1, 4713 BC. A pure date is converted to an +since noon (GMT) on Jan 1, 4713 BC@. A pure date is converted to an integer Julian count representing noon of that day. A date/time form is converted to an exact floating-point Julian count, adjusted to interpret the date form in the current time zone but the Julian @@ -16985,7 +16985,7 @@ this formula will return the Wednesday one week in the future. An exercise for the reader is to modify this formula to yield the same day if the input is already a Wednesday. Another interesting exercise is to preserve the time-of-day portion of the input (@code{newweek} resets -the time to midnight; hint:@: how can @code{newweek} be defined in terms +the time to midnight; hint: how can @code{newweek} be defined in terms of the @code{weekday} function?). @ignore @@ -18978,7 +18978,7 @@ modulo operation as numbers 39 and below.) If @var{m} is a power of ten, however, the numbers should be completely unbiased. The Gaussian random numbers generated by @samp{random(0.0)} use the -``polar'' method described in Knuth section 3.4.1C. This method +``polar'' method described in Knuth section 3.4.1C@. This method generates a pair of Gaussian random numbers at a time, so only every other call to @samp{random(0.0)} will require significant calculations. @@ -22178,7 +22178,7 @@ Use @kbd{a v} if you want the variables to ignore their stored values. If you give a numeric prefix argument of 2 to @kbd{a v}, it simplifies using Calc's algebraic simplifications; @pxref{Simplifying Formulas}. If you give a numeric prefix of 3 or more, it uses Extended -Simplification mode (@kbd{a e}). +Simplification mode (@kbd{a e}). If you give a negative prefix argument @mathit{-1}, @mathit{-2}, or @mathit{-3}, it simplifies in the corresponding mode but only works on the top-level @@ -22251,7 +22251,7 @@ If inequalities with opposite direction (e.g., @samp{<} and @samp{>}) are mapped, the direction of the second inequality is reversed to match the first: Using @kbd{a M +} on @samp{a < b} and @samp{a > 2} reverses the latter to get @samp{2 < a}, which then allows the -combination @samp{a + 2 < b + a}, which the algebraic simplifications +combination @samp{a + 2 < b + a}, which the algebraic simplifications can reduce to @samp{2 < b}. Using @kbd{a M *}, @kbd{a M /}, @kbd{a M n}, or @kbd{a M &} to negate @@ -22398,7 +22398,7 @@ common special case of regular arithmetic commands like @kbd{+} and @kbd{Q} [@code{sqrt}], the arguments are simply popped from the stack and collected into a suitable function call, which is then simplified (the arguments being simplified first as part of the process, as -described above). +described above). Even the basic set of simplifications are too numerous to describe completely here, but this section will describe the ones that apply to the @@ -22704,7 +22704,7 @@ the algebraic simplification mode, which is the default simplification mode. If you have switched to a different simplification mode, you can switch back with the @kbd{m A} command. Even in other simplification modes, the @kbd{a s} command will use these algebraic simplifications to -simplify the formula. +simplify the formula. There is a variable, @code{AlgSimpRules}, in which you can put rewrites to be applied. Its use is analogous to @code{EvalRules}, @@ -22741,7 +22741,7 @@ This allows easier comparison of products; for example, the basic simplifications will not change @expr{x y + y x} to @expr{2 x y}, but the algebraic simplifications; it first rewrites the sum to @expr{x y + x y} which can then be recognized as a sum of identical -terms. +terms. The canonical ordering used to sort terms of products has the property that real-valued numbers, interval forms and infinities @@ -22784,10 +22784,10 @@ factor in the numerator and denominator, it is canceled out; for example, @expr{(4 x + 6) / 8 x} simplifies to @expr{(2 x + 3) / 4 x}. Non-constant common factors are not found even by algebraic -simplifications. To cancel the factor @expr{a} in +simplifications. To cancel the factor @expr{a} in @expr{(a x + a) / a^2} you could first use @kbd{j M} on the product @expr{a x} to Merge the numerator to @expr{a (1+x)}, which can then be -simplified successfully. +simplified successfully. @tex \bigskip @@ -22940,7 +22940,7 @@ as is @expr{x^2 >= 0} if @expr{x} is known to be real. @tindex esimplify Calc is capable of performing some simplifications which may sometimes be desired but which are not ``safe'' in all cases. The @kbd{a e} -(@code{calc-simplify-extended}) [@code{esimplify}] command +(@code{calc-simplify-extended}) [@code{esimplify}] command applies the algebraic simplifications as well as these extended, or ``unsafe'', simplifications. Use this only if you know the values in your formula lie in the restricted ranges for which these @@ -23584,10 +23584,10 @@ forever!) @vindex IntegSimpRules Another set of rules, stored in @code{IntegSimpRules}, are applied every time the integrator uses algebraic simplifications to simplify an -intermediate result. For example, putting the rule +intermediate result. For example, putting the rule @samp{twice(x) := 2 x} into @code{IntegSimpRules} would tell Calc to convert the @code{twice} function into a form it knows whenever -integration is attempted. +integration is attempted. One more way to influence the integrator is to define a function with the @kbd{Z F} command (@pxref{Algebraic Definitions}). Calc's @@ -26752,7 +26752,7 @@ meta-variable @expr{v}. As usual, if this meta-variable has already been matched to something else the two values must be equal; if the meta-variable is new then it is bound to the result of the expression. This variable can then appear in later conditions, and on the righthand -side of the rule. +side of the rule. In fact, @expr{v} may be any pattern in which case the result of evaluating @expr{x} is matched to that pattern, binding any meta-variables that appear in that pattern. Note that @code{let} @@ -27506,7 +27506,7 @@ but only when algebraic simplifications are used to simplify the formula. The variable @code{AlgSimpRules} holds rules for this purpose. The @kbd{a s} command will apply @code{EvalRules} and @code{AlgSimpRules} to the formula, as well as all of its built-in -simplifications. +simplifications. Most of the special limitations for @code{EvalRules} don't apply to @code{AlgSimpRules}. Calc simply does an @kbd{a r AlgSimpRules} @@ -27514,7 +27514,7 @@ command with an infinite repeat count as the first step of algebraic simplifications. It then applies its own built-in simplifications throughout the formula, and then repeats these two steps (along with applying the default simplifications) until no further changes are -possible. +possible. @cindex @code{ExtSimpRules} variable @cindex @code{UnitSimpRules} variable @@ -28949,9 +28949,9 @@ to select the lefthand side, execute your commands, then type All current modes apply when an @samp{=>} operator is computed, including the current simplification mode. Recall that the formula @samp{arcsin(sin(x))} will not be handled by Calc's algebraic -simplifications, but Calc's unsafe simplifications will reduce it to +simplifications, but Calc's unsafe simplifications will reduce it to @samp{x}. If you enter @samp{arcsin(sin(x)) =>} normally, the result -will be @samp{arcsin(sin(x)) => arcsin(sin(x))}. If you change to +will be @samp{arcsin(sin(x)) => arcsin(sin(x))}. If you change to Extended Simplification mode, the result will be @samp{arcsin(sin(x)) => x}. However, just pressing @kbd{a e} once will have no effect on @samp{arcsin(sin(x)) => arcsin(sin(x))}, @@ -29569,7 +29569,7 @@ plot on any text-only printer. @kindex g O @pindex calc-graph-output The @kbd{g O} (@code{calc-graph-output}) command sets the name of the -output file used by GNUPLOT. For some devices, notably @code{x11} and +output file used by GNUPLOT@. For some devices, notably @code{x11} and @code{windows}, there is no output file and this information is not used. Many other ``devices'' are really file formats like @code{postscript}; in these cases the output in the desired format @@ -29641,7 +29641,7 @@ window in the upper-left corner of the screen. This command has no effect if the current device is @code{windows}. The buffer called @samp{*Gnuplot Trail*} holds a transcript of the -session with GNUPLOT. This shows the commands Calc has ``typed'' to +session with GNUPLOT@. This shows the commands Calc has ``typed'' to GNUPLOT and the responses it has received. Calc tries to notice when an error message has appeared here and display the buffer for you when this happens. You can check this buffer yourself if you suspect @@ -33252,7 +33252,7 @@ in the range @samp{[0 ..@: 60)}. Date forms are stored as @samp{(date @var{n})}, where @var{n} is a real number that counts days since midnight on the morning of -January 1, 1 AD. If @var{n} is an integer, this is a pure date +January 1, 1 AD@. If @var{n} is an integer, this is a pure date form. If @var{n} is a fraction or float, this is a date/time form. Modulo forms are stored as @samp{(mod @var{n} @var{m})}, where @var{m} is a @@ -33760,7 +33760,7 @@ objects into a definite, consistent order. The @code{beforep} function is used by the @kbd{V S} vector-sorting command, and also by Calc's algebraic simplifications to put the terms of a product into canonical order: This allows @samp{x y + y x} to be simplified easily to -@samp{2 x y}. +@samp{2 x y}. @end defun @defun equal x y @@ -34443,7 +34443,7 @@ traversed in this way, it is compared with the original formula (from before the call to @code{normalize}) and, if it has changed, the entire procedure is repeated (starting with @code{normalize}) until no further changes occur. Usually only two iterations are -needed:@: one to simplify the formula, and another to verify that no +needed: one to simplify the formula, and another to verify that no further simplifications were possible. @end defun 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. @c The following four macros generate the filenames and titles of the @c main (X)Emacs manual and the Elisp/Lispref manual. Leave the @c Texinfo variable `XEMACS' unset to generate a GNU Emacs version, set it -@c to generate an XEmacs version, e.g. with +@c to generate an XEmacs version, e.g., with @c "makeinfo -DXEMACS cc-mode.texi". @ifset XEMACS @macro emacsman @@ -646,13 +646,13 @@ you're better off getting an external program like GNU @code{indent}, which will rearrange brace location, amongst other things. Preprocessor directives are handled as syntactic whitespace from other -code, i.e. they can be interspersed anywhere without affecting the +code, i.e., they can be interspersed anywhere without affecting the indentation of the surrounding code, just like comments. The code inside macro definitions is, by default, still analyzed syntactically so that you get relative indentation there just as you'd get if the same code was outside a macro. However, since there is no -hint about the syntactic context, i.e. whether the macro expands to an +hint about the syntactic context, i.e., whether the macro expands to an expression, to some statements, or perhaps to whole functions, the syntactic recognition can be wrong. @ccmode{} manages to figure it out correctly most of the time, though. @@ -773,7 +773,7 @@ Indents the entire top-level function, class or macro definition encompassing point. It leaves point unchanged. This function can't be used to reindent a nested brace construct, such as a nested class or function, or a Java method. The top-level construct being reindented -must be complete, i.e. it must have both a beginning brace and an ending +must be complete, i.e., it must have both a beginning brace and an ending brace. @item @kbd{C-M-\} (@code{indent-region}) @@ -1021,7 +1021,7 @@ preprocessor statements. A popular programming style, especially for object-oriented languages such as C++ is to write symbols in a mixed case format, where the first letter of each word is capitalized, and not separated by -underscores. E.g. @samp{SymbolsWithMixedCaseAndNoUnderlines}. +underscores. E.g., @samp{SymbolsWithMixedCaseAndNoUnderlines}. These commands move backward or forward to the beginning of the next 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{}. Since there's a lot of normal text in comments and string literals, @ccmode{} provides features to edit these like in text mode. The goal -is to do it seamlessly, i.e. you can use auto fill mode, sentence and +is to do it seamlessly, i.e., you can use auto fill mode, sentence and paragraph movement, paragraph filling, adaptive filling etc. wherever there's a piece of normal text without having to think much about it. @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. @cindex paragraph filling Line breaks are by default handled (almost) the same regardless of whether they are made by auto fill mode (@pxref{Auto -Fill,,,@emacsman{}, @emacsmantitle{}}), by paragraph filling (e.g. with +Fill,,,@emacsman{}, @emacsmantitle{}}), by paragraph filling (e.g., with @kbd{M-q}), or explicitly with @kbd{M-j} or similar methods. In string literals, the new line gets the same indentation as the previous nonempty line.@footnote{You can change this default by @@ -1120,7 +1120,7 @@ this function. @xref{Sample .emacs File}. @findex c-context-open-line @findex context-open-line (c-) This is to @kbd{C-o} (@kbd{M-x open-line}) as -@code{c-context-line-break} is to @kbd{RET}. I.e. it works just like +@code{c-context-line-break} is to @kbd{RET}. I.e., it works just like @code{c-context-line-break} but leaves the point before the inserted line break. @end table @@ -1144,7 +1144,7 @@ editing chaotically formatted code. It can also be disconcerting, especially for users who are new to @ccmode{}. @item auto-newline mode This automatically inserts newlines where you'd probably want to type -them yourself, e.g. after typing @samp{@}}s. Its action is suppressed +them yourself, e.g., after typing @samp{@}}s. Its action is suppressed when electric mode is disabled. @item hungry-delete mode This lets you delete a contiguous block of whitespace with a single @@ -1155,7 +1155,7 @@ last statement. This mode makes basic word movement commands like @kbd{M-f} (@code{forward-word}) and @kbd{M-b} (@code{backward-word}) treat the parts of sillycapsed symbols as different words. -E.g. @samp{NSGraphicsContext} is treated as three words @samp{NS}, +E.g., @samp{NSGraphicsContext} is treated as three words @samp{NS}, @samp{Graphics}, and @samp{Context}. @item syntactic-indentation mode 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 (@code{c-electric-slash}) causes reindentation when you type it as the second component of a C style block comment opener (@samp{/*}) or a C++ line comment opener (@samp{//}) respectively, but only if the -comment opener is the first thing on the line (i.e. there's only +comment opener is the first thing on the line (i.e., there's only whitespace before it). Additionally, you can configure @ccmode{} so that typing a slash at @@ -1426,7 +1426,7 @@ Auto-newline only triggers when the following conditions hold: @itemize @bullet @item Auto-newline minor mode is enabled, as evidenced by the indicator -@samp{a} after the mode name on the modeline (e.g. @samp{C/a} or +@samp{a} after the mode name on the modeline (e.g., @samp{C/a} or @samp{C/la}). @item @@ -1446,7 +1446,7 @@ definition. These constructs are also known as @dfn{syntactic whitespace} since they are usually ignored when scanning C code.}. @item -No numeric argument was supplied to the command (i.e. it was typed as +No numeric argument was supplied to the command (i.e., it was typed as normal, with no @kbd{C-u} prefix). @end itemize @@ -1631,7 +1631,7 @@ trouble with this in GNU Emacs. @cindex nomenclature @cindex subword In spite of the GNU Coding Standards, it is popular to name a symbol -by mixing uppercase and lowercase letters, e.g. @samp{GtkWidget}, +by mixing uppercase and lowercase letters, e.g., @samp{GtkWidget}, @samp{EmacsFrameClass}, or @samp{NSGraphicsContext}. Here we call these mixed case symbols @dfn{nomenclatures}. Also, each capitalized (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 @strong{Please note:} The font locking in AWK mode is currently not integrated with the rest of @ccmode{}. Only the last section of this -chapter, @ref{AWK Mode Font Locking}, applies to AWK. The other +chapter, @ref{AWK Mode Font Locking}, applies to AWK@. The other sections apply to the other languages. @menu @@ -1912,7 +1912,7 @@ additional regexps to match those you use: For each language there's a variable @code{*-font-lock-extra-types}, where @samp{*} stands for the language in question. It contains a list of regexps that matches identifiers that should be recognized as types, -e.g. @samp{\\sw+_t} to recognize all identifiers ending with @samp{_t} +e.g., @samp{\\sw+_t} to recognize all identifiers ending with @samp{_t} as is customary in C code. Each regexp should not match more than a single identifier. @@ -2009,7 +2009,7 @@ labels. @vindex font-lock-builtin-face @vindex font-lock-reference-face Preprocessor directives get @code{font-lock-preprocessor-face} if it -exists (i.e. XEmacs). In Emacs they get @code{font-lock-builtin-face} +exists (i.e., XEmacs). In Emacs they get @code{font-lock-builtin-face} or @code{font-lock-reference-face}, for lack of a closer equivalent. @item @@ -2035,14 +2035,14 @@ since those aren't syntactic errors in themselves. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! There are various tools to supply documentation in the source as -specially structured comments, e.g. the standard Javadoc tool in Java. +specially structured comments, e.g., the standard Javadoc tool in Java. @ccmode{} provides an extensible mechanism to fontify such comments and the special markup inside them. @defopt c-doc-comment-style @vindex doc-comment-style (c-) This is a style variable that specifies which documentation comment -style to recognize, e.g. @code{javadoc} for Javadoc comments. +style to recognize, e.g., @code{javadoc} for Javadoc comments. The value may also be a list of styles, in which case all of them are recognized simultaneously (presumably with markup cues that don't @@ -2060,7 +2060,7 @@ The default value for @code{c-doc-comment-style} is Note that @ccmode{} uses this variable to set other variables that handle fontification etc. That's done at mode initialization or when you switch to a style which sets this variable. Thus, if you change it -in some other way, e.g. interactively in a CC Mode buffer, you will need +in some other way, e.g., interactively in a CC Mode buffer, you will need to do @kbd{M-x java-mode} (or whatever mode you're currently using) to reinitialize. @@ -2351,7 +2351,7 @@ have it enabled by default by placing the following in your @cindex mode hooks @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @c The node name is "CC Hooks" rather than "Hooks" because of a bug in -@c some older versions of Info, e.g. the info.el in GNU Emacs 21.3. +@c some older versions of Info, e.g., the info.el in GNU Emacs 21.3. @c If you go to "Config Basics" and hit <CR> on the xref to "CC @c Hooks" the function Info-follow-reference searches for "*Note: CC @c Hooks" from the beginning of the page. If this node were instead @@ -2429,7 +2429,7 @@ file. The variables that @ccmode{}'s style system control are called @dfn{style variables}. Note that style variables are ordinary Lisp variables, which the style system initializes; you can change their -values at any time (e.g. in a hook function). The style system can +values at any time (e.g., in a hook function). The style system can also set other variables, to some extent. @xref{Styles}. @dfn{Style variables} are handled specially in several ways: @@ -2921,9 +2921,9 @@ visit the file, @ccmode{} will automatically institute these offsets using @code{c-set-offset}. @end defvar -Note that file style settings (i.e. @code{c-file-style}) are applied +Note that file style settings (i.e., @code{c-file-style}) are applied before file offset settings -(i.e. @code{c-file-offsets})@footnote{Also, if either of these are set +(i.e., @code{c-file-offsets})@footnote{Also, if either of these are set in a file's local variable section, all the style variable values are made local to that buffer, even if @code{c-style-variables-are-local-p} is @code{nil}. Since this @@ -3001,7 +3001,7 @@ subsequent lines of C style block comments like @noindent with zero or more stars at the beginning of every line. If you change this variable, please make sure it still matches the comment starter -(i.e. @code{//}) of line comments @emph{and} the line prefix inside +(i.e., @code{//}) of line comments @emph{and} the line prefix inside block comments. @findex c-setup-paragraph-variables @@ -3024,7 +3024,7 @@ the line prefix from the other lines in the comment. @ccmode{} uses adaptive fill mode (@pxref{Adaptive Fill,,, emacs, GNU Emacs Manual}) to make Emacs correctly keep the line prefix when filling paragraphs. That also makes Emacs preserve the text -indentation @emph{inside} the comment line prefix. E.g. in the +indentation @emph{inside} the comment line prefix. E.g., in the following comment, both paragraphs will be filled with the left margins of the texts kept intact: @@ -3055,7 +3055,7 @@ by default). A patch for that is available from @c 2005/11/22: The above is still believed to be the case. which handles things like bulleted lists nicely. There's a convenience function @code{c-setup-filladapt} that tunes the relevant variables in -Filladapt for use in @ccmode{}. Call it from a mode hook, e.g. with +Filladapt for use in @ccmode{}. Call it from a mode hook, e.g., with something like this in your @file{.emacs}: @example @@ -3081,7 +3081,7 @@ then as the comment prefix. It defaults to @samp{* @code{c-block-comment-prefix} typically gets overridden by the default style @code{gnu}, which sets it to blank. You can see the line splitting effect described here by setting a different style, -e.g. @code{k&r} @xref{Choosing a Style}.}, which makes a comment +e.g., @code{k&r} @xref{Choosing a Style}.}, which makes a comment @example /* Got O(n^2) here, which is a Bad Thing. */ @@ -3108,7 +3108,7 @@ most common comment styles, see @ref{Line-Up Functions}. @defopt c-ignore-auto-fill @vindex ignore-auto-fill (c-) When auto fill mode is enabled, @ccmode{} can selectively ignore it -depending on the context the line break would occur in, e.g. to never +depending on the context the line break would occur in, e.g., to never break a line automatically inside a string literal. This variable takes a list of symbols for the different contexts where auto-filling never should occur: @@ -3123,7 +3123,7 @@ Inside a C++ style line comment. @item cpp Inside a preprocessor directive. @item code -Anywhere else, i.e. in normal code. +Anywhere else, i.e., in normal code. @end table 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 startup. The reason is that @kbd{M-j} could otherwise produce sequences of single line block comments for texts that should logically be treated as one comment, and the rest of the paragraph handling code -(e.g. @kbd{M-q} and @kbd{M-a}) can't cope with that, which would lead to +(e.g., @kbd{M-q} and @kbd{M-a}) can't cope with that, which would lead to inconsistent behavior. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -3380,12 +3380,12 @@ giving a syntactic symbol an @dfn{action function} in @cindex customization, brace hanging An action function is called with two arguments: the syntactic symbol -for the brace (e.g. @code{substatement-open}), and the buffer position +for the brace (e.g., @code{substatement-open}), and the buffer position where the brace has been inserted. Point is undefined on entry to an -action function, but the function must preserve it (e.g. by using +action function, but the function must preserve it (e.g., by using @code{save-excursion}). The return value should be a list containing some combination of @code{before} and @code{after}, including neither -of them (i.e. @code{nil}). +of them (i.e., @code{nil}). @defvar c-syntactic-context @vindex syntactic-context (c-) @@ -3566,7 +3566,7 @@ statements. In addition to @ccmode{} also comes with the criteria function @code{c-semi&comma-no-newlines-for-oneline-inliners}, which suppresses newlines after semicolons inside one-line inline method definitions -(e.g. in C++ or Java). +(e.g., in C++ or Java). @end defun @@ -3580,7 +3580,7 @@ newlines after semicolons inside one-line inline method definitions @dfn{Clean-ups} are mechanisms which remove (or exceptionally, add) whitespace in specific circumstances and are complementary to colon and brace hanging. You enable a clean-up by adding its symbol into -@code{c-cleanup-list}, e.g. like this: +@code{c-cleanup-list}, e.g., like this: @example (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 On the surface, it would seem that clean-ups overlap the functionality provided by the @code{c-hanging-*-alist} variables. Clean-ups, -however, are used to adjust code ``after-the-fact'', i.e. to adjust +however, are used to adjust code ``after-the-fact'', i.e., to adjust the whitespace in constructs later than when they were typed. Most of the clean-ups remove automatically inserted newlines, and are @@ -3799,7 +3799,7 @@ Auto-newline minor mode are enabled: @item space-before-funcall Insert a space between the function name and the opening parenthesis of a function call. This produces function calls in the style -mandated by the GNU coding standards, e.g. @samp{signal@w{ }(SIGINT, +mandated by the GNU coding standards, e.g., @samp{signal@w{ }(SIGINT, SIG_IGN)} and @samp{abort@w{ }()}. Clean up occurs when the opening parenthesis is typed. This clean-up should never be active in AWK 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 of a function call that has no arguments. This is typically used together with @code{space-before-funcall} if you prefer the GNU function call style for functions with arguments but think it looks ugly when -it's only an empty parenthesis pair. I.e. you will get @samp{signal +it's only an empty parenthesis pair. I.e., you will get @samp{signal (SIGINT, SIG_IGN)}, but @samp{abort()}. Clean up occurs when the closing parenthesis is typed. @item comment-close-slash When inside a block comment, terminate the comment when you type a slash -at the beginning of a line (i.e. immediately after the comment prefix). +at the beginning of a line (i.e., immediately after the comment prefix). This clean-up removes whitespace preceding the slash and if needed, inserts a star to complete the token @samp{*/}. Type @kbd{C-q /} in this situation if you just want a literal @samp{/} inserted. @@ -3910,7 +3910,7 @@ brief and typical example: @noindent The first thing inside each syntactic element is always a @dfn{syntactic symbol}. It describes the kind of construct that was -recognized, e.g. @code{statement}, @code{substatement}, +recognized, e.g., @code{statement}, @code{substatement}, @code{class-open}, @code{class-close}, etc. @xref{Syntactic Symbols}, for a complete list of currently recognized syntactic symbols and their semantics. The remaining entries are various data associated @@ -3951,7 +3951,7 @@ position(s). @end table Running this command on line 4 of this example, we'd see in the echo -area@footnote{With a universal argument (i.e. @kbd{C-u C-c C-s}) the +area@footnote{With a universal argument (i.e., @kbd{C-u C-c C-s}) the analysis is inserted into the buffer as a comment on the current line.}: @@ -4219,7 +4219,7 @@ Method Symbols}. Lines continuing an Objective-C method call. @ref{Objective-C Method Symbols}. @item extern-lang-open -Brace that opens an @code{extern} block (e.g. @code{extern "C" +Brace that opens an @code{extern} block (e.g., @code{extern "C" @{...@}}). @ref{External Scope Symbols}. @item extern-lang-close 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. C++ template argument list continuations. @ref{Class Symbols}. @item inlambda Analogous to @code{inclass} syntactic symbol, but used inside lambda -(i.e. anonymous) functions. Only used in Pike mode. @ref{Statement +(i.e., anonymous) functions. Only used in Pike mode. @ref{Statement Block Symbols}. @item lambda-intro-cont -Lines continuing the header of a lambda function, i.e. between the +Lines continuing the header of a lambda function, i.e., between the @code{lambda} keyword and the function body. Only used in Pike mode. @ref{Statement Block Symbols}. @item inexpr-statement @@ -4311,7 +4311,7 @@ top-level construct introduction so it has the syntax the brace that opens a top-level function definition. Line 9 is the corresponding @code{defun-close} since it contains the brace that closes the top-level -function definition. Line 4 is a @code{defun-block-intro}, i.e. it is +function definition. Line 4 is a @code{defun-block-intro}, i.e., it is the first line of a brace-block, enclosed in a top-level function definition. @@ -4360,7 +4360,7 @@ structs, and unions are essentially equivalent syntactically (and are very similar semantically), so replacing the @code{class} keyword in the example above with @code{struct} or @code{union} would still result in a syntax of @code{class-open} for line 4 @footnote{This is the case even -for C and Objective-C. For consistency, structs in all supported +for C and Objective-C@. For consistency, structs in all supported languages are syntactically equivalent to classes. Note however that the keyword @code{class} is meaningless in C and Objective-C.}. Similarly, line 18 is assigned @code{class-close} syntax. @@ -4668,7 +4668,7 @@ where @code{inextern-lang} is a modifier similar in purpose to There are various other top level blocks like @code{extern}, and they are all treated in the same way except that the symbols are named after -the keyword that introduces the block. E.g. C++ namespace blocks get +the keyword that introduces the block. E.g., C++ namespace blocks get the three symbols @code{namespace-open}, @code{namespace-close} and @code{innamespace}. The currently recognized top level blocks are: @@ -4857,9 +4857,9 @@ Line 17 is assigned @code{stream-op} syntax. @ssindex cpp-define-intro @ssindex cpp-macro-cont Multiline preprocessor macro definitions are normally handled just like -other code, i.e. the lines inside them are indented according to the +other code, i.e., the lines inside them are indented according to the syntactic analysis of the preceding lines inside the macro. The first -line inside a macro definition (i.e. the line after the starting line of +line inside a macro definition (i.e., the line after the starting line of the cpp directive itself) gets @code{cpp-define-intro}. In this example: @example @@ -4875,7 +4875,7 @@ line 1 is given the syntactic symbol @code{cpp-macro}. The first line of a cpp directive is always given that symbol. Line 2 is given @code{cpp-define-intro}, so that you can give the macro body as a whole some extra indentation. Lines 3 through 5 are then analyzed as normal -code, i.e. @code{substatement} on lines 3 and 4, and @code{else-clause} +code, i.e., @code{substatement} on lines 3 and 4, and @code{else-clause} on line 5. The syntactic analysis inside macros can be turned off with @@ -5025,7 +5025,7 @@ handled like this too. @ssindex knr-argdecl-intro @ssindex knr-argdecl Two other syntactic symbols can appear in old style, non-prototyped C -code @footnote{a.k.a. K&R C, or Kernighan & Ritchie C}: +code @footnote{a.k.a.@: K&R C, or Kernighan & Ritchie C}: @example 1: int add_three_integers(a, b, c) @@ -5039,7 +5039,7 @@ code @footnote{a.k.a. K&R C, or Kernighan & Ritchie C}: Here, line 2 is the first line in an argument declaration list and so is given the @code{knr-argdecl-intro} syntactic symbol. Subsequent lines -(i.e. lines 3 and 4 in this example), are given @code{knr-argdecl} +(i.e., lines 3 and 4 in this example), are given @code{knr-argdecl} syntax. @@ -5703,7 +5703,7 @@ expressions. @defun c-lineup-inexpr-block @findex lineup-inexpr-block (c-) This can be used with the in-expression block symbols to indent the -whole block to the column where the construct is started. E.g. for Java +whole block to the column where the construct is started. E.g., for Java anonymous classes, this lines up the class under the @samp{new} keyword, and in Pike it lines up the lambda function body under the @samp{lambda} 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 @code{inline-close}, @code{block-close}, @code{brace-list-close}, @code{brace-list-intro}, @code{statement-block-intro}, @code{arglist-intro}, @code{arglist-cont-nonempty}, -@code{arglist-close}, and all @code{in*} symbols, e.g. @code{inclass} +@code{arglist-close}, and all @code{in*} symbols, e.g., @code{inclass} and @code{inextern-lang}. @end defun @@ -6053,7 +6053,7 @@ if ( x < 10 Since this function doesn't do anything for lines without an infix operator you typically want to use it together with some other lineup -settings, e.g. as follows (the @code{arglist-close} setting is just a +settings, e.g., as follows (the @code{arglist-close} setting is just a suggestion to get a consistent style): @example @@ -6087,7 +6087,7 @@ operator too, try to align it with the first one. @defun c-lineup-math @findex lineup-math (c-) Like @code{c-lineup-assignments} but indent with @code{c-basic-offset} -if no assignment operator was found on the first line. I.e. this +if no assignment operator was found on the first line. I.e., this function is the same as specifying a list @code{(c-lineup-assignments +)}. It's provided for compatibility with old configurations. @@ -6123,7 +6123,7 @@ expressions. @defun c-lineup-streamop @findex lineup-streamop (c-) -Line up C++ stream operators (i.e. @samp{<<} and @samp{>>}). +Line up C++ stream operators (i.e., @samp{<<} and @samp{>>}). @workswith @code{stream-op}. @end defun @@ -6204,7 +6204,7 @@ to handle most of the common comment styles. Some examples: @end example The style variable @code{c-comment-prefix-regexp} is used to recognize -the comment line prefix, e.g. the @samp{*} that usually starts every +the comment line prefix, e.g., the @samp{*} that usually starts every line inside a comment. @workswith The @code{c} syntactic symbol. @@ -6315,7 +6315,7 @@ int dribble() @{ If @code{c-syntactic-indentation-in-macros} is non-@code{nil}, the function returns the relative indentation to the macro start line to -allow accumulation with other offsets. E.g. in the following cases, +allow accumulation with other offsets. E.g., in the following cases, @code{cpp-define-intro} is combined with the @code{statement-block-intro} that comes from the @samp{do @{} that hangs on the @samp{#define} line: @@ -6390,7 +6390,7 @@ The @samp{x} line is aligned to the text after the @samp{:} on the This is done only in an @samp{asm} or @samp{__asm__} block, and only to those lines mentioned. Anywhere else @code{nil} is returned. The usual arrangement is to have this routine as an extra feature at the start of -arglist lineups, e.g. +arglist lineups, e.g.: @example (c-lineup-gcc-asm-reg c-lineup-arglist) @@ -6486,7 +6486,7 @@ another line-up function. Full details of these are in Line-up functions must not move point or change the content of the buffer (except temporarily). They are however allowed to do -@dfn{hidden buffer changes}, i.e. setting text properties for caching +@dfn{hidden buffer changes}, i.e., setting text properties for caching purposes etc. Buffer undo recording is disabled while they run. 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 @vindex syntactic-element (c-) @vindex c-syntactic-context @vindex syntactic-context (c-) -Some syntactic symbols, e.g. @code{arglist-cont-nonempty}, have more +Some syntactic symbols, e.g., @code{arglist-cont-nonempty}, have more info in the syntactic element - typically other positions that can be interesting besides the anchor position. That info can't be accessed through the passed argument, which is a cons cell. Instead, you can @@ -6600,9 +6600,9 @@ Line-Up}). When the indentation engine calls this hook, the variable @code{c-syntactic-context} is bound to the current syntactic context -(i.e. what you would get by typing @kbd{C-c C-s} on the source line. +(i.e., what you would get by typing @kbd{C-c C-s} on the source line. @xref{Custom Braces}.). Note that you should not change point or mark -inside a @code{c-special-indent-hook} function, i.e. you'll probably +inside a @code{c-special-indent-hook} function, i.e., you'll probably want to wrap your function in a @code{save-excursion}@footnote{The numerical value returned by @code{point} will change if you change the indentation of the line within a @code{save-excursion} form, but point @@ -6673,11 +6673,11 @@ customized with these variables: These variables control the alignment columns for line continuation backslashes in multiline macros. They are used by the functions that automatically insert or align such backslashes, -e.g. @code{c-backslash-region} and @code{c-context-line-break}. +e.g., @code{c-backslash-region} and @code{c-context-line-break}. @code{c-backslash-column} specifies the minimum column for the backslashes. If any line in the macro goes past this column, then the -next tab stop (i.e. next multiple of @code{tab-width}) in that line is +next tab stop (i.e., next multiple of @code{tab-width}) in that line is used as the alignment column for all the backslashes, so that they remain in a single column. However, if any lines go past @code{c-backslash-max-column} then the backslashes in the rest of the @@ -6693,7 +6693,7 @@ the automatic alignment of backslashes, use @vindex auto-align-backslashes (c-) Align automatically inserted line continuation backslashes if non-@code{nil}. When line continuation backslashes are inserted -automatically for line breaks in multiline macros, e.g. by +automatically for line breaks in multiline macros, e.g., by @code{c-context-line-break}, they are aligned with the other backslashes in the same macro if this flag is set. @@ -6878,9 +6878,9 @@ pathological code can cause @ccmode{} to perform fairly badly. This section gives some insight in how @ccmode{} operates, how that interacts with some coding styles, and what you can use to improve performance. -The overall goal is that @ccmode{} shouldn't be overly slow (i.e. take +The overall goal is that @ccmode{} shouldn't be overly slow (i.e., take more than a fraction of a second) in any interactive operation. -I.e. it's tuned to limit the maximum response time in single operations, +I.e., it's tuned to limit the maximum response time in single operations, which is sometimes at the expense of batch-like operations like reindenting whole blocks. If you find that @ccmode{} gradually gets slower and slower in certain situations, perhaps as the file grows in @@ -6898,7 +6898,7 @@ gets. @findex beginning-of-defun In earlier versions of @ccmode{}, we used to recommend putting the -opening brace of a top-level construct@footnote{E.g. a function in C, +opening brace of a top-level construct@footnote{E.g., a function in C, or outermost class definition in C++ or Java.} into the leftmost column. Earlier still, this used to be a rigid Emacs constraint, as embodied in the @code{beginning-of-defun} function. @ccmode now @@ -6940,7 +6940,7 @@ XEmacs users can set the variable tells @ccmode{} to use XEmacs-specific built-in functions which, in some circumstances, can locate the top-most opening brace much more quickly than @code{beginning-of-defun}. Preliminary testing has shown that for -styles where these braces are hung (e.g. most JDK-derived Java styles), +styles where these braces are hung (e.g., most JDK-derived Java styles), this hack can improve performance of the core syntax parsing routines from 3 to 60 times. However, for styles which @emph{do} conform to 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 22.1 as of this writing in February 2007). Text properties are used to speed up skipping over syntactic whitespace, -i.e. comments and preprocessor directives. Indenting a line after a +i.e., comments and preprocessor directives. Indenting a line after a huge macro definition can be slow the first time, but after that the text properties are in place and it should be fast (even after you've edited other parts of the file and then moved back). @@ -6959,7 +6959,7 @@ edited other parts of the file and then moved back). Font locking can be a CPU hog, especially the font locking done on decoration level 3 which tries to be very accurate. Note that that level is designed to be used with a font lock support mode that only -fontifies the text that's actually shown, i.e. Lazy Lock or Just-in-time +fontifies the text that's actually shown, i.e., Lazy Lock or Just-in-time Lock mode, so make sure you use one of them. Fontification of a whole buffer with some thousand lines can often take over a minute. That is 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 intention to change this goal. If you want to reformat old code, you're probably better off using some -other tool instead, e.g. @ref{Top, , GNU indent, indent, The `indent' +other tool instead, e.g., @ref{Top, , GNU indent, indent, The `indent' Manual}, which has more powerful reformatting capabilities than @ccmode{}. @item The support for C++ templates (in angle brackets) is not yet complete. When a non-nested template is used in a declaration, @ccmode{} indents -it and font-locks it OK. Templates used in expressions, and nested +it and font-locks it OK@. Templates used in expressions, and nested templates do not fare so well. Sometimes a workaround is to refontify the expression after typing the closing @samp{>}. @@ -7063,7 +7063,7 @@ too by adding this to your @code{c-initialization-hook}: @end example @xref{Getting Started}. This is a very common question. If you want -this to be the default behavior, don't lobby us, lobby RMS! @t{:-)} +this to be the default behavior, don't lobby us, lobby RMS@! @t{:-)} @item @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 you think it might affect our ability to reproduce it. Please try to produce the problem in an Emacs instance without any -customizations loaded (i.e. start it with the @samp{-q --no-site-file} +customizations loaded (i.e., start it with the @samp{-q --no-site-file} arguments). If it works correctly there, the problem might be caused by faulty customizations in either your own or your site 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 defines aliases to the @file{cl-lib.el} definitions). Where @file{cl-lib.el} defines a function called, for example, @code{cl-incf}, @file{cl.el} uses the same name but without the -@samp{cl-} prefix, e.g.@: @code{incf} in this example. There are a few +@samp{cl-} prefix, e.g., @code{incf} in this example. There are a few exceptions to this. First, functions such as @code{cl-defun} where the unprefixed version was already used for a standard Emacs Lisp function. In such cases, the @file{cl.el} version adds a @samp{*} -suffix, e.g.@: @code{defun*}. Second, there are some obsolete features +suffix, e.g., @code{defun*}. Second, there are some obsolete features that are only implemented in @file{cl.el}, not in @file{cl-lib.el}, because they are replaced by other standard Emacs Lisp features. Finally, in a very few cases the old @file{cl.el} versions do not @@ -898,8 +898,8 @@ generalized variables. @node Setf Extensions @subsection Setf Extensions -Several standard (e.g.@: @code{car}) and Emacs-specific -(e.g.@: @code{window-point}) Lisp functions are @code{setf}-able by default. +Several standard (e.g., @code{car}) and Emacs-specific +(e.g., @code{window-point}) Lisp functions are @code{setf}-able by default. This package defines @code{setf} handlers for several additional functions: @itemize @@ -4870,7 +4870,7 @@ direct C-language calls to the message routines rather than going through the Lisp @code{message} function. @c Bug#411. -Note that many primitives (e.g.@: @code{+}) have special byte-compile +Note that many primitives (e.g., @code{+}) have special byte-compile handling. Attempts to redefine such functions using @code{flet} will fail if byte-compiled. @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. Class trees are displayed in @dfn{tree buffers} which install their own major mode. Most Emacs keys work in tree buffers in the usual way, -e.g.@: you can move around in the buffer with the usual @kbd{C-f}, +e.g., you can move around in the buffer with the usual @kbd{C-f}, @kbd{C-v} etc., or you can search with @kbd{C-s}. 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 to the one containing the member. With a prefix argument (@kbd{C-u}), all members in the class tree, -i.e.@: all members the browser knows about appear in the completion +i.e., all members the browser knows about appear in the completion list. The member display will be switched to the class and member list containing the member. @@ -1333,7 +1333,7 @@ This command sets point to the previous position in the position stack. Directly after you performed a jump, this will put you back to the position where you came from. -The stack is not popped, i.e.@: you can always switch back and forth +The stack is not popped, i.e., you can always switch back and forth between positions in the stack. To avoid letting the stack grow to infinite size there is a maximum number of positions defined. When this 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 remember only part of a member name, and not its beginning. A special buffer is popped up containing all identifiers matching the -regular expression, and what kind of symbol it is (e.g.@: a member +regular expression, and what kind of symbol it is (e.g., a member function, or a type). You can then switch to this buffer, and use the command @kbd{C-c C-m f}, for example, to jump to a specific member. 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. @subsection Custom Locate The various simple project styles all have one major drawback, which -is that the files in the project are not completely known to EDE. +is that the files in the project are not completely known to EDE@. When the EDE API is used to try and file files by some reference name in the project, then that could fail. @@ -1074,7 +1074,7 @@ To enable one of these tools, set the variable @code{ede-locate-setup-options} with the names of different locate objects. @ref{Miscellaneous commands}. -Configure this in your @file{.emacs} before loading in CEDET or EDE. +Configure this in your @file{.emacs} before loading in CEDET or EDE@. If you want to add support for GNU Global, your configuration would look like this: @@ -1083,7 +1083,7 @@ look like this: @end example That way, when a search needs to be done, it will first try using -GLOBAL. If global is not available for that directory, then it will +GLOBAL@. If global is not available for that directory, then it will revert to the base locate object. The base object always fails to find a file. @@ -1100,7 +1100,7 @@ bugs in @ede{}. A knowledge of Emacs Lisp, and some @eieio{}(CLOS) is required. @ede{} uses @eieio{}, the CLOS package for Emacs, to define two object -superclasses, specifically the PROJECT and TARGET. All commands in +superclasses, specifically the PROJECT and TARGET@. All commands in @ede{} are usually meant to address the current project, or current target. @@ -1273,7 +1273,7 @@ The function @code{ede-directory-project-p} will call @code{ede-dir-to-projectfile} on every @code{ede-project-autoload} until one of them returns true. The method @code{ede-dir-to-projectfile} in turn gets the @code{:proj-file} slot -from the autoload. If it is a string (ie, a project file name), it +from the autoload. If it is a string (i.e., a project file name), it checks to see if that exists in BUFFER's directory. If it is a function, then it calls that function and expects it to return a file 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. @ede{} projects track source file / target associates via source code objects. The definitions for this is in @file{ede-source.el}. A source code object contains methods that know how to identify a file as being -of that class, (ie, a C file ends with @file{.c}). Some targets can +of that class, (i.e., a C file ends with @file{.c}). Some targets can handle many different types of sources which must all be compiled together. For example, a mixed C and C++ program would have instantiations of both sourcecode types. @@ -1635,7 +1635,7 @@ This is a URL to be sent to a web site for documentation. @item :web-site-directory @* A directory where web pages can be found by Emacs. -For remote locations use a path compatible with ange-ftp or EFS. +For remote locations use a path compatible with ange-ftp or EFS@. You can also use TRAMP for use with rcp & scp. @refill @@ -1978,7 +1978,7 @@ The function symbol must take two arguments: NAME - The name of the file to find. DIR - The directory root for this cpp-root project. -It should return the fully qualified file name passed in from NAME. If that file does not +It should return the fully qualified file name passed in from NAME@. If that file does not exist, it should return nil. @refill @@ -2565,7 +2565,7 @@ Optional @var{DEPTH} is the depth we start at. @end deffn @deffn Method ede-buffer-header-file :AFTER this buffer -There are no default header files in EDE. +There are no default header files in EDE@. Do a quick check to see if there is a Header tag in this buffer. @end deffn 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 type a number, say 3, and then @kbd{j} (@code{ediff-jump-to-difference}), Ediff moves to the third difference region. Typing 3 and then @kbd{a} (@code{ediff-diff-to-diff}) copies the 3rd difference region from variant A -to variant B. Likewise, 4 followed by @kbd{ra} restores the 4th difference +to variant B@. Likewise, 4 followed by @kbd{ra} restores the 4th difference region in buffer A (if it was previously written over via the command @kbd{a}). @@ -490,7 +490,7 @@ compares three files simultaneously). @kindex a @emph{In comparison sessions:} Copies the current difference region (or the region specified as the prefix -to this command) from buffer A to buffer B. +to this command) from buffer A to buffer B@. Ediff saves the old contents of buffer B's region; it can be restored via the command @kbd{rb}, which see. @@ -512,31 +512,31 @@ be reinstated via the command @kbd{ra} in comparison sessions and @item ab @kindex ab Copies the current difference region (or the region specified as the prefix -to this command) from buffer A to buffer B. This (and the next five) +to this command) from buffer A to buffer B@. This (and the next five) command is enabled only in sessions that compare three files simultaneously. The old region in buffer B is saved and can be restored via the command @kbd{rb}. @item ac @kindex ac -Copies the difference region from buffer A to buffer C. +Copies the difference region from buffer A to buffer C@. The old region in buffer C is saved and can be restored via the command @kbd{rc}. @item ba @kindex ba -Copies the difference region from buffer B to buffer A. +Copies the difference region from buffer B to buffer A@. The old region in buffer A is saved and can be restored via the command @kbd{ra}. @item bc @kindex bc -Copies the difference region from buffer B to buffer C. +Copies the difference region from buffer B to buffer C@. The command @kbd{rc} undoes this. @item ca @kindex ca -Copies the difference region from buffer C to buffer A. +Copies the difference region from buffer C to buffer A@. The command @kbd{ra} undoes this. @item cb @kindex cb -Copies the difference region from buffer C to buffer B. +Copies the difference region from buffer C to buffer B@. The command @kbd{rb} undoes this. @item p @@ -713,12 +713,12 @@ over. @xref{Selective Browsing}, for more. @item A @kindex A -Toggles the read-only property in buffer A. +Toggles the read-only property in buffer A@. If file A is under version control and is checked in, it is checked out (with your permission). @item B @kindex B -Toggles the read-only property in buffer B. +Toggles the read-only property in buffer B@. If file B is under version control and is checked in, it is checked out. @item C @kindex C @@ -795,7 +795,7 @@ While merging with an ancestor file, Ediff is determined to reduce user's wear and tear by saving him and her much of unproductive, repetitive typing. If it notices that, say, file A's difference region is identical to the same difference region in the ancestor file, then the merge buffer will -automatically get the difference region taken from buffer B. The rationale +automatically get the difference region taken from buffer B@. The rationale is that this difference region in buffer A is as old as that in the ancestor buffer, so the contents of that region in buffer B represents real change. @@ -820,7 +820,7 @@ To be more precise, this toggles the check for whether the current merge is identical to its default setting, as originally decided by Ediff. For instance, if Ediff is merging according to the `combined' policy, then the merge region is skipped over if it is different from the combination of the -regions in buffers A and B. (Warning: swapping buffers A and B will confuse +regions in buffers A and B@. (Warning: swapping buffers A and B will confuse things in this respect.) If the merge region is marked as `prefer-A' then this region will be skipped if it differs from the current difference region in buffer A, etc. @@ -1238,7 +1238,7 @@ Keep in mind that hooks executing before @code{ediff-cleanup-mess} start in @code{ediff-control-buffer;} they should also leave @code{ediff-control-buffer} as the current buffer when they finish. Hooks that are executed after @code{ediff-cleanup-mess} should expect -the current buffer be either buffer A or buffer B. +the current buffer be either buffer A or buffer B@. @code{ediff-cleanup-mess} doesn't kill the buffers being compared or merged (see @code{ediff-cleanup-hook}, below). @@ -1361,7 +1361,7 @@ the variable @code{ediff-help-message}, which is local to @section Window and Frame Configuration On a non-windowing display, Ediff sets things up in one frame, splitting -it between a small control window and the windows for buffers A, B, and C. +it between a small control window and the windows for buffers A, B, and C@. The split between these windows can be horizontal or vertical, which can be changed interactively by typing @kbd{|} while the cursor is in the control window. @@ -1999,7 +1999,7 @@ represented as a list of the form @code{(STRING1 Symbol1 STRING2 Symbol2 STRING3 Symbol3 STRING4)}. The symbols here must be atoms of the form @code{A}, @code{B}, or @code{Ancestor}. They determine the order in which the corresponding difference regions (from buffers A, B, and the ancestor -buffer) are displayed in the merged region of buffer C. The strings in the +buffer) are displayed in the merged region of buffer C@. The strings in the template determine the text that separates the aforesaid regions. The default template is @@ -2062,7 +2062,7 @@ you copy a difference region from buffer A to buffer C then @samp{=diff(B)} will change to @samp{diff-A} and the mode line will display @samp{=diff(A) prefer-B}. This indicates that the difference region in buffer C is identical to that in buffer A, but originally -buffer C's region came from buffer B. This is useful to know because +buffer C's region came from buffer B@. This is useful to know because you can recover the original difference region in buffer C by typing @kbd{r}. @@ -2090,7 +2090,7 @@ buffer A consists of the white space only (or if it is empty), Ediff will not take it into account for the purpose of computing fine differences. The result is that Ediff can provide a better visual information regarding the actual fine differences in the non-white regions in buffers B and -C. Moreover, if the regions in buffers B and C differ in the white space +C@. Moreover, if the regions in buffers B and C differ in the white space only, then a message to this effect will be displayed. @vindex ediff-merge-window-share @@ -2388,7 +2388,7 @@ In merging, this is the merge buffer. In two-way comparison, this variable is @code{nil}. @item ediff-window-A -The window displaying buffer A. If buffer A is not visible, this variable +The window displaying buffer A@. If buffer A is not visible, this variable is @code{nil} or it may be a dead window. @item ediff-window-B @@ -2407,7 +2407,7 @@ the control buffer is in its own frame. @chapter Credits Ediff was written by Michael Kifer <kifer@@cs.stonybrook.edu>. It was inspired -by emerge.el written by Dale R.@: Worley <drw@@math.mit.edu>. An idea due to +by emerge.el written by Dale R. Worley <drw@@math.mit.edu>. An idea due to Boris Goldowsky <boris@@cs.rochester.edu> made it possible to highlight fine differences in Ediff buffers. Alastair Burt <burt@@dfki.uni-kl.de> ported Ediff to XEmacs, Eric Freudenthal <freudent@@jan.ultra.nyu.edu> @@ -2424,15 +2424,15 @@ Adrian Aichner (aichner at ecf.teradyne.com), Drew Adams (drew.adams at oracle.com), Steve Baur (steve at xemacs.org), Neal Becker (neal at ctd.comsat.com), -E.@: Jay Berkenbilt (ejb at ql.org), +E. Jay Berkenbilt (ejb at ql.org), Lennart Borgman (ennart.borgman at gmail.com) Alastair Burt (burt at dfki.uni-kl.de), Paul Bibilo (peb at delcam.co.uk), Kevin Broadey (KevinB at bartley.demon.co.uk), Harald Boegeholz (hwb at machnix.mathematik.uni-stuttgart.de), -Bradley A.@: Bosch (brad at lachman.com), -Michael D.@: Carney (carney at ltx-tr.com), -Jin S.@: Choi (jin at atype.com), +Bradley A. Bosch (brad at lachman.com), +Michael D. Carney (carney at ltx-tr.com), +Jin S. Choi (jin at atype.com), Scott Cummings (cummings at adc.com), Albert Dvornik (bert at mit.edu), Eric Eide (eeide at asylum.cs.utah.edu), @@ -2491,7 +2491,7 @@ Paul Raines (raines at slac.stanford.edu), Stefan Reicher (xsteve at riic.at), Charles Rich (rich at merl.com), Bill Richter (richter at math.nwu.edu), -C.S.@: Roberson (roberson at aur.alcatel.com), +C.S. Roberson (roberson at aur.alcatel.com), Kevin Rodgers (kevin.rodgers at ihs.com), Sandy Rutherford (sandy at ibm550.sissa.it), 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. This manual describes version 4.0 of the EDT Emulation for Emacs. It comes with special functions which replicate nearly all of EDT's keypad mode behavior. It sets up default keypad and function key -bindings which closely match those found in EDT. Support is provided so +bindings which closely match those found in EDT@. Support is provided so that users may reconfigure most keypad and function key bindings to their own liking. @@ -321,7 +321,7 @@ restores the original key bindings in effect just prior to invoking the emulation. Emacs binds keys to @acronym{ASCII} control characters and so does the -real EDT. Where EDT key bindings and Emacs key bindings conflict, +real EDT@. Where EDT key bindings and Emacs key bindings conflict, the default Emacs key bindings are retained by the EDT emulation by default. If you are a diehard EDT user you may not like this. The @ref{Control keys} section explains how to change this so that the EDT @@ -527,7 +527,7 @@ add mod2 = Num_Lock @end example So, after executing @samp{xmodmap .xmodmaprc}, a press of the physical -@key{F12} key looks like a Num_Lock keypress to X. Also, a press of the +@key{F12} key looks like a Num_Lock keypress to X@. Also, a press of the physical @key{NumLock} key looks like a press of the @key{F12} key to X. 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 @item Cursor movement and deletion involving word entities is identical to -EDT. This, above all else, gives the die-hard EDT user a sense of being +EDT@. This, above all else, gives the die-hard EDT user a sense of being at home. Also, an emulation of EDT's @samp{SET ENTITY WORD} command is provided, for those users who like to customize movement by a word at a 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. @node Wish List @chapter Wish List -@eieio{} is an incomplete implementation of CLOS. Finding ways to +@eieio{} is an incomplete implementation of CLOS@. Finding ways to improve the compatibility would help make CLOS style programs run better in Emacs. 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 does not enable scrolling, which means that you cannot see the whole image. To prevent this, the library tries to determine the image size before displaying it inline, and if it doesn't fit the window, the -library will display it externally (e.g. with @samp{ImageMagick} or +library will display it externally (e.g., with @samp{ImageMagick} or @samp{xv}). Setting this variable to @code{t} disables this check and makes the library display all inline images as inline, regardless of their size. If you set this variable to @code{resize}, the image will @@ -427,7 +427,7 @@ or @kbd{I} instead.} @item mm-w3m-safe-url-regexp @vindex mm-w3m-safe-url-regexp -A regular expression that matches safe URL names, i.e. URLs that are +A regular expression that matches safe URL names, i.e., URLs that are unlikely to leak personal information when rendering @acronym{HTML} email (the default value is @samp{\\`cid:}). If @code{nil} consider all URLs safe. In Gnus, this will be overridden according to the value @@ -489,7 +489,7 @@ Delete all control characters. @item mm-file-name-delete-gotchas @findex mm-file-name-delete-gotchas Delete characters that could have unintended consequences when used -with flawed shell scripts, i.e. @samp{|}, @samp{>} and @samp{<}; and +with flawed shell scripts, i.e., @samp{|}, @samp{>} and @samp{<}; and @samp{-}, @samp{.} as the first character. @item mm-file-name-delete-whitespace @@ -922,7 +922,7 @@ each case the most efficient of quoted-printable and base64 should be used. @code{qp-or-base64} has another effect. It will fold long lines so that -MIME parts may not be broken by MTA. So do @code{quoted-printable} and +MIME parts may not be broken by MTA@. So do @code{quoted-printable} and @code{base64}. 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 @item rfc2047-encode-encoded-words @vindex rfc2047-encode-encoded-words The boolean variable specifies whether encoded words -(e.g. @samp{=?us-ascii?q?hello?=}) should be encoded again. +(e.g., @samp{=?us-ascii?q?hello?=}) should be encoded again. @code{rfc2047-encoded-word-regexp} is used to look for such words. @item rfc2047-allow-irregular-q-encoded-words @vindex rfc2047-allow-irregular-q-encoded-words The boolean variable specifies whether irregular Q encoded words -(e.g. @samp{=?us-ascii?q?hello??=}) should be decoded. If it is +(e.g., @samp{=?us-ascii?q?hello??=}) should be decoded. If it is non-@code{nil}, @code{rfc2047-encoded-word-regexp-loose} is used instead of @code{rfc2047-encoded-word-regexp} to look for encoded words. @@ -1608,14 +1608,14 @@ Take a date and return a time. If the date is not syntactically valid, return a ``zero'' time. @item time-less-p -Take two times and say whether the first time is less (i. e., earlier) +Take two times and say whether the first time is less (i.e., earlier) than the second time. @item time-since Take a time and return a time saying how long it was since that time. @item subtract-time -Take two times and subtract the second from the first. I. e., return +Take two times and subtract the second from the first. I.e., return the time between the two times. @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. @end ifnottex @menu -* Overview:: -* Quick start:: -* Commands:: -* Caching Passphrases:: -* Bug Reports:: +* Overview:: +* Quick start:: +* Commands:: +* Caching Passphrases:: +* Bug Reports:: @end menu @node Overview @@ -107,12 +107,12 @@ encryption/decryption of @samp{*.gpg} files. This chapter introduces various commands for typical use cases. @menu -* Key management:: -* Cryptographic operations on regions:: -* Cryptographic operations on files:: -* Dired integration:: -* Mail-mode integration:: -* Encrypting/decrypting *.gpg files:: +* Key management:: +* Cryptographic operations on regions:: +* Cryptographic operations on files:: +* Dired integration:: +* Mail-mode integration:: +* Encrypting/decrypting *.gpg files:: @end menu @node Key management @@ -311,7 +311,7 @@ style of sending signed/encrypted emails by embedding raw OpenPGP blobs inside a message body, not using modern MIME format. NOTE: Inline OpenPGP is not recommended and you should consider to use -PGP/MIME. See +PGP/MIME@. See @uref{http://josefsson.org/inline-openpgp-considered-harmful.html, Inline OpenPGP in E-mail is bad@comma{} Mm'kay?}. 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. * Keystroke Summary:: Keystrokes used in ERC buffers. * Modules:: Available modules for ERC. * Advanced Usage:: Cool ways of using ERC. -* Getting Help and Reporting Bugs:: +* Getting Help and Reporting Bugs:: * History:: The history of ERC. * Copying:: The GNU General Public License gives you permission to redistribute ERC on @@ -246,7 +246,7 @@ translation effort. @item user scripting -Users can load scripts (e.g. auto greeting scripts) when ERC starts up. +Users can load scripts (e.g., auto greeting scripts) when ERC starts up. It is also possible to make custom IRC commands, if you know a little 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 help you figure out its parameters. @defun erc -Select connection parameters and run ERC. +Select connection parameters and run ERC@. Non-interactively, it takes the following keyword arguments. @itemize @bullet @@ -655,7 +655,7 @@ This can be either a string or a function to call. @section Sample Configuration @cindex configuration, sample -Here is an example of configuration settings for ERC. This can go into +Here is an example of configuration settings for ERC@. This can go into your Emacs configuration file. Everything after the @code{(require 'erc)} command can optionally go into @file{~/.emacs.d/.ercrc.el}. @@ -706,7 +706,7 @@ stuff, to the current ERC buffer." (erc :server "localhost" :port "6667" :nick "MYNICK"))) -;; Make C-c RET (or C-c C-RET) send messages instead of RET. This has +;; Make C-c RET (or C-c C-RET) send messages instead of RET. This has ;; been commented out to avoid confusing new users. ;; (define-key erc-mode-map (kbd "RET") nil) ;; (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 @kbd{M-x customize-group erc RET}. @defopt erc-hide-list -If non, @code{nil}, this is a list of IRC message types to hide, e.g. +If non, @code{nil}, this is a list of IRC message types to hide, e.g.: @example (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. @item @uref{http://www.emacswiki.org/cgi-bin/wiki/ERC} is the -emacswiki.org page for ERC. Anyone may add tips, hints, etc. to it. +emacswiki.org page for ERC@. Anyone may add tips, hints, etc. to it. @item 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 selector "^ert-" selects ERT's self-tests. Other uses include grouping tests by their expected execution time, -e.g. to run quick tests during interactive development and slow tests less +e.g., to run quick tests during interactive development and slow tests less often. This can be achieved with the @code{:tag} argument to @code{ert-deftest} and @code{tag} test selectors. 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 @item Eshell scripts can't execute in the background -@item Support zsh's ``Parameter Expansion'' syntax, i.e. @samp{$@{@var{name}:-@var{val}@}} +@item Support zsh's ``Parameter Expansion'' syntax, i.e., @samp{$@{@var{name}:-@var{val}@}} @item Write an @command{info} alias that can take arguments @@ -869,7 +869,7 @@ It would call subcommands with @option{--help}, or @option{-h} or @item Implement @command{stty} in Lisp -@item Support @command{rc}'s matching operator, e.g. @samp{~ (@var{list}) @var{regexp}} +@item Support @command{rc}'s matching operator, e.g., @samp{~ (@var{list}) @var{regexp}} @item Implement @command{bg} and @command{fg} as editors of @code{eshell-process-list} 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. @comment node-name, next, previous, up @chapter Usage -This chapter describes the usage of EUDC. Most functions and +This chapter describes the usage of EUDC@. Most functions and customization options are available through the @samp{Directory Search} submenu of the @samp{Tools} submenu. 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@* @quotation This list of frequently asked questions about GNU Emacs with answers (``FAQ'') may be translated into other languages, transformed into other -formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information. +formats (e.g., Texinfo, Info, WWW, WAIS), and updated with new information. The same conditions apply to any derivative of the FAQ as apply to the FAQ 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 pressed.}. @kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127. It is a misnomer to call -@kbd{C-?} a ``control'' key, since 127 has both bits 5 and 6 turned ON. +@kbd{C-?} a ``control'' key, since 127 has both bits 5 and 6 turned ON@. Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127. @c FIXME I cannot understand the previous sentence. @@ -257,9 +257,9 @@ Emacs manual. @cindex Directories and files that come with Emacs These are files that come with Emacs. The Emacs distribution is divided -into subdirectories; e.g. @file{etc}, @file{lisp}, and @file{src}. -Some of these (e.g. @file{etc} and @file{lisp}) are present both in -an installed Emacs and in the sources, but some (e.g. @file{src}) are +into subdirectories; e.g., @file{etc}, @file{lisp}, and @file{src}. +Some of these (e.g., @file{etc} and @file{lisp}) are present both in +an installed Emacs and in the sources, but some (e.g., @file{src}) are only found in the sources. If you use Emacs, but don't know where it is kept on your system, start @@ -314,7 +314,7 @@ GNU General Public License @end table -Avoid confusing the FSF and the LPF. The LPF opposes +Avoid confusing the FSF and the LPF@. The LPF opposes look-and-feel copyrights and software patents. The FSF aims to make high quality free software available for everyone. @@ -552,7 +552,7 @@ help-for-help} instead to invoke help. To discover what key (if any) invokes help on your system, type @kbd{M-x where-is @key{RET} help-for-help @key{RET}}. This will print a comma-separated list of key sequences in the echo area. Ignore the last character in each key -sequence listed. Each of the resulting key sequences (e.g. @key{F1} is +sequence listed. Each of the resulting key sequences (e.g., @key{F1} is common) invokes help. 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 apropos-documentation}. @item -You can order a hardcopy of the manual from the FSF. @xref{Getting a +You can order a hardcopy of the manual from the FSF@. @xref{Getting a printed manual}. @cindex Reference cards, in other languages @@ -640,7 +640,7 @@ information. To get a list of these commands, type @samp{?} after @cindex Manual, obtaining a printed or HTML copy of @cindex Emacs manual, obtaining a printed or HTML copy of -You can order a printed copy of the Emacs manual from the FSF. For +You can order a printed copy of the Emacs manual from the FSF@. For details see the @uref{http://shop.fsf.org/, FSF on-line store}. The full Texinfo source for the manual also comes in the @file{doc/emacs} @@ -954,7 +954,7 @@ status of its latest version. @cindex TECO @cindex Original version of Emacs -Emacs originally was an acronym for Editor MACroS. RMS says he ``picked +Emacs originally was an acronym for Editor MACroS@. RMS says he ``picked the name Emacs because @key{E} was not in use as an abbreviation on ITS at the time.'' The first Emacs was a set of macros written in 1976 at MIT by RMS for the editor TECO (Text Editor and COrrector, originally Tape @@ -985,9 +985,9 @@ conventions}). @cindex Bazaar repository, Emacs Emacs @value{EMACSVER} is the current version as of this writing. A version -number with two components (e.g. @samp{22.1}) indicates a released +number with two components (e.g., @samp{22.1}) indicates a released version; three components indicate a development -version (e.g. @samp{23.0.50} is what will eventually become @samp{23.1}). +version (e.g., @samp{23.0.50} is what will eventually become @samp{23.1}). Emacs is under active development, hosted at @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, change their values, and save your changes to your init file. @xref{Easy Customization,,, emacs, The GNU Emacs Manual}. -If you know the name of the group in advance (e.g. ``shell''), use +If you know the name of the group in advance (e.g., ``shell''), use @kbd{M-x customize-group @key{RET}}. If you wish to customize a single option, use @kbd{M-x customize-option @@ -1385,7 +1385,7 @@ customize, with completion. @cindex Console, colors In Emacs 21.1 and later, colors and faces are supported in non-windowed mode, -i.e.@: on Unix and GNU/Linux text-only terminals and consoles, and when +i.e., on Unix and GNU/Linux text-only terminals and consoles, and when invoked as @samp{emacs -nw} on X, and MS-Windows. (Colors and faces were supported in the MS-DOS port since Emacs 19.29.) Emacs automatically detects color support at startup and uses it if available. If you think @@ -1540,7 +1540,7 @@ with @samp{#!}): @cindex Major mode for shell scripts The variable @code{interpreter-mode-alist} specifies which mode to use -when loading an interpreted script (e.g. shell, python, etc.). Emacs +when loading an interpreted script (e.g., shell, python, etc.). Emacs determines which interpreter you're using by examining the first line of the script. Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on @code{interpreter-mode-alist} to learn more. @@ -3172,7 +3172,7 @@ the main GNU distribution site, sources are available as @c Don't include VER in the file name, because pretests are not there. @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz} -(Replace @samp{VERSION} with the relevant version number, e.g. @samp{23.1}.) +(Replace @samp{VERSION} with the relevant version number, e.g., @samp{23.1}.) @item 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: @cindex Misspecified key sequences Usually, one of two things has happened. In one case, the control -character in the key sequence has been misspecified (e.g. @samp{C-f} +character in the key sequence has been misspecified (e.g., @samp{C-f} used instead of @samp{\C-f} within a Lisp expression). In the other case, a @dfn{prefix key} in the keystroke sequence you were trying to bind 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: @item Not all modifiers are permitted in all situations. @key{Hyper}, @key{Super}, and @key{Alt} are not available on Unix character -terminals. Non-@acronym{ASCII} keys and mouse events (e.g. @kbd{C-=} and +terminals. Non-@acronym{ASCII} keys and mouse events (e.g., @kbd{C-=} and @kbd{Mouse-1}) also fall under this category. @end itemize @@ -4275,7 +4275,7 @@ type them in. To enable this feature, execute the following: @end lisp Note that the aliases are expanded automatically only after you type -a word-separator character (e.g. @key{RET} or @kbd{,}). You can force their +a word-separator character (e.g., @key{RET} or @kbd{,}). You can force their expansion by moving point to the end of the alias and typing @kbd{C-x a e} (@kbd{M-x expand-abbrev}). @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.'' @ifnottex @node Top @top GNU Flymake -@insertcopying +@insertcopying @end ifnottex @menu @@ -69,7 +69,7 @@ Emacs minor mode. Flymake runs the pre-configured syntax check tool (compiler for C++ files, @code{perl} for perl files, etc.) in the background, passing it a temporary copy of the current buffer, and parses the output for known error/warning message patterns. Flymake -then highlights erroneous lines (i.e. lines for which at least one +then highlights erroneous lines (i.e., lines for which at least one error or warning has been reported by the syntax check tool), and displays an overall buffer status in the mode line. Status information 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 actual data to be presented. The control file describes how to present it. -@insertcopying +@insertcopying @menu * 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, they make up a forms. The contents of the forms consist of the contents of the fields of the -record (e.g. @samp{root}, @samp{0}, @samp{1}, @samp{Super User}) +record (e.g., @samp{root}, @samp{0}, @samp{1}, @samp{Super User}) interspersed with normal text (e.g @samp{User : }, @samp{Uid: }). 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 @code{nil}, multi-line text fields are prohibited. The pseudo newline must not be a character contained in @code{forms-field-sep}. -The default value is @code{"\^k"}, the character Control-K. Example: +The default value is @code{"\^k"}, the character Control-K@. Example: @example (setq forms-multi-line "\^k") @@ -739,7 +739,7 @@ so you'd better think twice before using this. The default format for the data file, using @code{"\t"} to separate fields and @code{"\^k"} to separate lines within a field, matches the -file format of some popular database programs, e.g. FileMaker. So +file format of some popular database programs, e.g., FileMaker. So @code{forms-mode} can decrease the need to use proprietary software. @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. @top Gnus Coding Style and Maintenance Guide This manual describes @dots{} -@insertcopying +@insertcopying @end ifnottex @menu @@ -64,7 +64,7 @@ This manual describes @dots{} The Gnus distribution contains a lot of libraries that have been written for Gnus and used intensively for Gnus. But many of those libraries are -useful on their own. E.g. other Emacs Lisp packages might use the +useful on their own. E.g., other Emacs Lisp packages might use the @acronym{MIME} library @xref{Top, ,Top, emacs-mime, The Emacs MIME Manual}. @@ -196,7 +196,7 @@ There are no Gnus dependencies in this file. Functions for Cancel-Lock feature @c Cf. draft-ietf-usefor-cancel-lock-01.txt @c Although this draft has expired, Canlock-Lock revived in 2007 when -@c major news providers (e.g. news.individual.org) started to use it. +@c major news providers (e.g., news.individual.org) started to use it. @c As of 2007-08-25... There are no Gnus dependencies in these files. @@ -257,18 +257,18 @@ XEmacs 21.1 and up. The development of Gnus normally is done on the Git repository trunk as of April 19, 2010 (formerly it was done in CVS; the repository is -at http://git.gnus.org), i.e. there are no separate branches to +at http://git.gnus.org), i.e., there are no separate branches to develop and test new features. Most of the time, the trunk is developed quite actively with more or less daily changes. Only after -a new major release, e.g. 5.10.1, there's usually a feature period of +a new major release, e.g., 5.10.1, there's usually a feature period of several months. After the release of Gnus 5.10.6 the development of new features started again on the trunk while the 5.10 series is continued on the stable branch (v5-10) from which more stable releases will be done when needed (5.10.8, @dots{}). @ref{Gnus Development, ,Gnus Development, gnus, The Gnus Newsreader} -Stable releases of Gnus finally become part of Emacs. E.g. Gnus 5.8 -became a part of Emacs 21 (relabeled to Gnus 5.9). The 5.10 series +Stable releases of Gnus finally become part of Emacs. E.g., Gnus 5.8 +became a part of Emacs 21 (relabeled to Gnus 5.9). The 5.10 series became part of Emacs 22 as Gnus 5.11. @section Syncing @@ -379,7 +379,7 @@ Starting from No Gnus, the @file{GNUS-NEWS} is created from For new customizable variables introduced in Oort Gnus (including the v5-10 branch) use @code{:version "22.1" ;; Oort Gnus} (including the -comment) or e.g. @code{:version "22.2" ;; Gnus 5.10.10} if the feature +comment) or, e.g., @code{:version "22.2" ;; Gnus 5.10.10} if the feature was added for Emacs 22.2 and Gnus 5.10.10. @c 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 as a part of Emacs. It's been around in some form for almost a decade now, and has been distributed as a standard part of Emacs for much of that time. Gnus 5 is the latest (and greatest) incarnation. The -original version was called GNUS, and was written by Masanobu UMEDA. +original version was called GNUS, and was written by Masanobu UMEDA@. When autumn crept up in '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus. @@ -149,7 +149,7 @@ Anti Spam features. Message-utils now included in Gnus. @item -New format specifiers for summary lines, e.g. %B for +New format specifiers for summary lines, e.g., %B for a complex trn-style thread tree. @end itemize @@ -162,7 +162,7 @@ Where and how to get Gnus? Gnus is released independent from releases of Emacs and XEmacs. Therefore, the version bundled with Emacs or the version in XEmacs's -package system might not be up to date (e.g. Gnus 5.9 bundled with Emacs +package system might not be up to date (e.g., Gnus 5.9 bundled with Emacs 21 is outdated). You can get the latest released version of Gnus from @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 (under MS-Windows either get the Cygwin environment from @uref{http://www.cygwin.com} which allows you to do what's described above or unpack the -tarball with some packer (e.g. Winace from +tarball with some packer (e.g., Winace from @uref{http://www.winace.com}) and use the batch-file make.bat included in the tarball to install Gnus.) If you don't want to (or aren't allowed to) install Gnus @@ -267,7 +267,7 @@ and how to prevent it? This message means that the last time you used Gnus, it wasn't properly exited and therefore couldn't write its -information to disk (e.g. which messages you read), you +information to disk (e.g., which messages you read), you are now asked if you want to restore that information from the auto-save file. @@ -314,7 +314,7 @@ through them? @subsubheading Answer Gnus offers the topic mode, it allows you to sort your -groups in, well, topics, e.g. all groups dealing with +groups in, well, topics, e.g., all groups dealing with Linux under the topic linux, all dealing with music under the topic music and all dealing with scottish music under the topic scottish which is a subtopic of music. @@ -406,7 +406,7 @@ directory Emacs chooses will most certainly not be what you want, so let's do it the correct way. The first thing you've got to do is to create a suitable directory (no blanks in directory name -please) e.g. c:\myhome. Then you must set the environment +please), e.g., c:\myhome. Then you must set the environment variable HOME to this directory. To do this under Windows 9x or Me include the line @@ -556,7 +556,7 @@ these: 1: You want to read your mail from a pop3 server and send them directly to a SMTP Server 2: Some program like fetchmail retrieves your mail and stores it on disk from where Gnus shall read it. Outgoing mail is sent by -Sendmail, Postfix or some other MTA. Sometimes, you even +Sendmail, Postfix or some other MTA@. Sometimes, you even need a combination of the above cases. 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 achieve what you want. The easiest way is to get an external program which retrieves copies of the mail and stores them on disk, so Gnus can read it from there. On Unix systems you -could use e.g. fetchmail for this, on MS Windows you can use +could use, e.g., fetchmail for this, on MS Windows you can use Hamster, an excellent local news and mail server. The other solution would be, to replace the method Gnus @@ -728,7 +728,7 @@ Gnus to use it and not to delete the retrieved mail. For GNU Emacs look for the file epop3.el which can do the same (If you know the home of this file, please send me an e-mail). You can also tell Gnus to use an external program -(e.g. fetchmail) to fetch your mail, see the info node +(e.g., fetchmail) to fetch your mail, see the info node "Mail Source Specifiers" in the Gnus manual on how to do it. @@ -753,7 +753,7 @@ it. * FAQ 4-9:: Is there a way to automatically ignore posts by specific authors or with specific words in the subject? And can I highlight more interesting ones in some way? -* FAQ 4-10:: How can I disable threading in some (e.g. mail-) groups, +* FAQ 4-10:: How can I disable threading in some (e.g., mail-) groups, or set other variables specific for some groups? * FAQ 4-11:: Can I highlight messages written by me and follow-ups to those? @@ -778,7 +778,7 @@ If you enter the group by saying @samp{RET} in group buffer with point over the group, only unread and ticked messages are loaded. Say @samp{C-u RET} -instead to load all available messages. If you want only the e.g. 300 newest say +instead to load all available messages. If you want only the 300 newest say @samp{C-u 300 RET} 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 @samp{s} for substring-match and delete afterwards everything but the name to score down all authors with the given name no matter which email address is used. Now you need to tell -Gnus when to apply the rule and how long it should last, hit e.g. +Gnus when to apply the rule and how long it should last, hit @samp{p} to apply the rule now and let it last forever. If you want to raise the score instead of lowering it say @samp{I} instead of @samp{L}. @@ -967,7 +967,7 @@ Gnus manual for the exact syntax, basically it's one big list whose elements are lists again. the first element of those lists is the header to score on, then one more list with what to match, which score to assign, when to expire the rule and how to do the -matching. If you find me very interesting, you could e.g. add the +matching. If you find me very interesting, you could add the following to your all.Score: @example @@ -998,7 +998,7 @@ in ~/.gnus.el. @node FAQ 4-10 @subsubheading Question 4.10 -How can I disable threading in some (e.g. mail-) groups, or +How can I disable threading in some (e.g., mail-) groups, or set other variables specific for some groups? @subsubheading Answer @@ -1114,7 +1114,7 @@ tabulators which allow you a summary in table form, but sadly hard tabulators are broken in 5.8.8. Since 5.10, Gnus offers you some very nice new specifiers, -e.g. %B which draws a thread-tree and %&user-date which +e.g., %B which draws a thread-tree and %&user-date which gives you a date where the details are dependent of the articles age. Here's an example which uses both: @@ -1771,7 +1771,7 @@ snippet by Frank Haun <pille3003@@fhaun.de> in @example (defun my-archive-article (&optional n) - "Copies one or more article(s) to a corresponding `nnml:' group, e.g. + "Copies one or more article(s) to a corresponding `nnml:' group, e.g., `gnus.ding' goes to `nnml:1.gnus.ding'. And `nnml:List-gnus.ding' goes to `nnml:1.List-gnus-ding'. @@ -1879,7 +1879,7 @@ some groups). How to do it? @subsubheading Answer -If you want all read messages to be expired (e.g. in +If you want all read messages to be expired (e.g., in mailing lists where there's an online archive), you've got two choices: auto-expire and total-expire. Auto-expire means, that every article @@ -1924,7 +1924,7 @@ Say something like this in ~/.gnus.el: (If you want to change the value of nnmail-expiry-target on a per group basis see the question "How can I disable -threading in some (e.g. mail-) groups, or set other +threading in some (e.g., mail-) groups, or set other variables specific for some groups?") @node FAQ 7 - Gnus in a dial-up environment @@ -1983,7 +1983,7 @@ On windows boxes I'd vote for it's a small freeware, open-source program which fetches your mail and news from remote servers and offers them to Gnus (or any other mail and/or news reader) via nntp -respectively POP3 or IMAP. It also includes a smtp +respectively POP3 or IMAP@. It also includes a smtp server for receiving mails from Gnus. @node FAQ 7-2 @@ -1996,7 +1996,7 @@ So what was this thing about the Agent? The Gnus agent is part of Gnus, it allows you to fetch mail and news and store them on disk for reading them later when you're offline. It kind of mimics offline -newsreaders like e.g. Forte Agent. If you want to use +newsreaders like Forte Agent. If you want to use the Agent place the following in ~/.gnus.el if you are still using 5.8.8 or 5.9 (it's the default since 5.10): @@ -2075,7 +2075,7 @@ work, the agent must be active. @menu * FAQ 8-1:: How to find information and help inside Emacs? -* FAQ 8-2:: I can't find anything in the Gnus manual about X (e.g. +* FAQ 8-2:: I can't find anything in the Gnus manual about X (e.g., attachments, PGP, MIME...), is it not documented? * FAQ 8-3:: Which websites should I know? * FAQ 8-4:: Which mailing lists and newsgroups are there? @@ -2105,7 +2105,7 @@ apropos} searches the bound variables. @subsubheading Question 8.2 I can't find anything in the Gnus manual about X -(e.g. attachments, PGP, MIME...), is it not documented? +(e.g., attachments, PGP, MIME...), is it not documented? @subsubheading Answer diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index a9cd0d3567c..dd561a41d5b 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi @@ -1731,7 +1731,7 @@ asterisk at the beginning of the line?). You can change that format to whatever you want by fiddling with the @code{gnus-group-line-format} variable. This variable works along the lines of a @code{format} specification, which is pretty much the same as -a @code{printf} specifications, for those of you who use (feh!) C. +a @code{printf} specifications, for those of you who use (feh!) C@. @xref{Formatting Variables}. @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 reasons of efficiency. It is recommended that you keep all your mail groups (if any) on quite -low levels (e.g. 1 or 2). +low levels (e.g., 1 or 2). Maybe the following description of the default behavior of Gnus helps to 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 use this level as the ``work'' level. @vindex gnus-activate-level -Gnus will normally just activate (i. e., query the server about) groups +Gnus will normally just activate (i.e., query the server about) groups on level @code{gnus-activate-level} or less. If you don't want to activate unsubscribed groups, for instance, you might set this variable to 5. The default is 6. @@ -2654,7 +2654,7 @@ to a particular group by using a match string like @kindex G R (Group) @findex gnus-group-make-rss-group Make a group based on an @acronym{RSS} feed -(@code{gnus-group-make-rss-group}). You will be prompted for an URL. +(@code{gnus-group-make-rss-group}). You will be prompted for an URL@. @xref{RSS}. @item G DEL @@ -2708,7 +2708,7 @@ the article range. @findex gnus-read-ephemeral-gmane-group-url This command is similar to @code{gnus-read-ephemeral-gmane-group}, but the group name and the article number and range are constructed from a -given @acronym{URL}. Supported @acronym{URL} formats include e.g. +given @acronym{URL}. Supported @acronym{URL} formats include: @url{http://thread.gmane.org/gmane.foo.bar/12300/focus=12399}, @url{http://thread.gmane.org/gmane.foo.bar/12345/}, @url{http://article.gmane.org/gmane.foo.bar/12345/}, @@ -3125,7 +3125,7 @@ parameters, then you may need the following statement elsewhere in your @vindex gnus-list-identifiers A use for this feature is to remove a mailing list identifier tag in -the subject fields of articles. E.g. if the news group +the subject fields of articles. E.g., if the news group @example nntp+news.gnus.org:gmane.text.docbook.apps @@ -5036,7 +5036,7 @@ A related variable is @code{nnmail-extra-headers}, which controls when to include extra headers when generating overview (@acronym{NOV}) files. If you have old overview files, you should regenerate them after changing this variable, by entering the server buffer using @kbd{^}, -and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause +and then @kbd{g} on the appropriate mail server (e.g., nnml) to cause regeneration. @vindex gnus-summary-line-format @@ -7120,8 +7120,8 @@ arrived on the mailing list. Consequently, when sorting sub-threads using the default @code{gnus-thread-sort-by-number}, responses can end up appearing before the article to which they are responding to. Setting this variable to an alternate value -(e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an -appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a +(e.g., @code{gnus-thread-sort-by-date}), in a group's parameters or in an +appropriate hook (e.g., @code{gnus-summary-generate-hook}) can produce a more logical sub-thread ordering in such instances. @end table @@ -7908,7 +7908,7 @@ reader to use this setting. @item gnus-summary-save-in-pipe @findex gnus-summary-save-in-pipe Pipe the article to a shell command. This function takes optional two -arguments COMMAND and RAW. Valid values for COMMAND include: +arguments COMMAND and RAW@. Valid values for COMMAND include: @itemize @bullet @item a string@* @@ -8916,7 +8916,7 @@ Unreadable articles that tell you to read them with Caesar rotate or rot13. (Typically offensive jokes and such.) It's commonly called ``rot13'' because each letter is rotated 13 -positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter +positions in the alphabet, e.g., @samp{B} (letter #2) -> @samp{O} (letter #15). It is sometimes referred to as ``Caesar rotate'' because Caesar is rumored to have employed this form of, uh, somewhat weak encryption. @@ -9037,7 +9037,7 @@ Capitalize the first word in each sentence @item W c @kindex W c (Summary) @findex gnus-article-remove-cr -Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF +Translate CRLF pairs (i.e., @samp{^M}s on the end of the lines) into LF (this takes care of DOS line endings), and then translate any remaining CRs into LF (this takes care of Mac line endings) (@code{gnus-article-remove-cr}). @@ -9587,13 +9587,13 @@ Piconify the @code{From} header (@code{gnus-treat-from-picon}). @item W D m @kindex W D m (Summary) @findex gnus-treat-mail-picon -Piconify all mail headers (i. e., @code{Cc}, @code{To}) +Piconify all mail headers (i.e., @code{Cc}, @code{To}) (@code{gnus-treat-mail-picon}). @item W D n @kindex W D n (Summary) @findex gnus-treat-newsgroups-picon -Piconify all news headers (i. e., @code{Newsgroups} and +Piconify all news headers (i.e., @code{Newsgroups} and @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}). @item W D g @@ -9604,7 +9604,7 @@ Gravatarify the @code{From} header (@code{gnus-treat-from-gravatar}). @item W D h @kindex W D h (Summary) @findex gnus-treat-mail-gravatar -Gravatarify all mail headers (i. e., @code{Cc}, @code{To}) +Gravatarify all mail headers (i.e., @code{Cc}, @code{To}) (@code{gnus-treat-from-gravatar}). @item W D D @@ -9885,7 +9885,7 @@ displayed. This variable overrides This variable is only used when @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}. -To see e.g. security buttons but no other buttons, you could set this +E.g., to see security buttons but no other buttons, you could set this variable to @code{("multipart/signed")} and leave @code{gnus-unbuttonized-mime-types} at the default value. @@ -9904,8 +9904,8 @@ default value is @code{nil}. @vindex gnus-article-mime-part-function For each @acronym{MIME} part, this function will be called with the @acronym{MIME} handle as the parameter. The function is meant to be used to allow -users to gather information from the article (e. g., add Vcard info to -the bbdb database) or to do actions based on parts (e. g., automatically +users to gather information from the article (e.g., add Vcard info to +the bbdb database) or to do actions based on parts (e.g., automatically save all jpegs into some directory). 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 faster. Of course, it'll make group entry somewhat slow. @vindex gnus-refer-thread-limit -The @code{gnus-refer-thread-limit} variable says how many old (i. e., +The @code{gnus-refer-thread-limit} variable says how many old (i.e., articles before the first displayed in the current group) headers to fetch when doing this command. The default is 200. If @code{t}, all the available headers will be fetched. This variable can be overridden @@ -11275,13 +11275,13 @@ things to work: @enumerate @item To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to -install an OpenPGP implementation such as GnuPG. The Lisp interface +install an OpenPGP implementation such as GnuPG@. The Lisp interface to GnuPG included with Emacs is called EasyPG (@pxref{Top, ,EasyPG, epa, EasyPG Assistant user's manual}), but PGG (@pxref{Top, ,PGG, pgg, PGG Manual}), and Mailcrypt are also supported. @item -To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6 +To handle @acronym{S/MIME} message, you need to install OpenSSL@. OpenSSL 0.9.6 or newer is recommended. @end enumerate @@ -11773,7 +11773,7 @@ directory, the oldest files will be deleted. The default is 500MB. @item gnus-html-frame-width @vindex gnus-html-frame-width -The width to use when rendering HTML. The default is 70. +The width to use when rendering HTML@. The default is 70. @item gnus-max-image-proportion @vindex gnus-max-image-proportion @@ -12218,7 +12218,7 @@ Displayed when headers are hidden in the article buffer. @item p Displayed when article is digitally signed or encrypted, and Gnus has hidden the security headers. (N.B. does not tell anything about -security status, i.e. good or bad signature.) +security status, i.e., good or bad signature.) @item s 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) contains the message including the message header. Changes made to the message will only affect the Gcc copy, but not the original message. You can use these hooks to edit the copy (and influence -subsequent transformations), e.g. remove MML secure tags +subsequent transformations), e.g., remove MML secure tags (@pxref{Signing and encrypting}). @end table @@ -13028,7 +13028,7 @@ personal mail group. A foreign group (or any group, really) is specified by a @dfn{name} and a @dfn{select method}. To take the latter first, a select method is a -list where the first element says what back end to use (e.g. @code{nntp}, +list where the first element says what back end to use (e.g., @code{nntp}, @code{nnspool}, @code{nnml}) and the second element is the @dfn{server name}. There may be additional elements in the select method, where the value may have special meaning for the back end in question. @@ -13405,7 +13405,7 @@ Server variables are often called @dfn{server parameters}. @subsection Servers and Methods Wherever you would normally use a select method -(e.g. @code{gnus-secondary-select-method}, in the group select method, +(e.g., @code{gnus-secondary-select-method}, in the group select method, when browsing a foreign server) you can use a virtual server name instead. This could potentially save lots of typing. And it's nice all over. @@ -13749,7 +13749,7 @@ inhibit Gnus to add a @code{Message-ID} header, you could say: (add-hook 'nntp-prepare-post-hook 'canlock-insert-header) @end lisp -Note that not all servers support the recommended ID. This works for +Note that not all servers support the recommended ID@. This works for INN versions 2.3.0 and later, for instance. @item nntp-server-list-active-group @@ -14268,7 +14268,7 @@ Here's a complete example @code{nnimap} backend with a client-side @cindex reading mail @cindex mail -Reading mail with a newsreader---isn't that just plain WeIrD? But of +Reading mail with a newsreader---isn't that just plain WeIrD@? But of course. @menu @@ -14684,8 +14684,8 @@ The name of the @acronym{POP} server. The default is taken from the @env{MAILHOST} environment variable. @item :port -The port number of the @acronym{POP} server. This can be a number (eg, -@samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a +The port number of the @acronym{POP} server. This can be a number (e.g., +@samp{:port 1234}) or a string (e.g., @samp{:port "pop3"}). If it is a string, it should be a service name as listed in @file{/etc/services} on Unix systems. The default is @samp{"pop3"}. On some systems you might need to specify it as @samp{"pop-3"} instead. @@ -14833,7 +14833,7 @@ Two example maildir mail sources: @item imap Get mail from a @acronym{IMAP} server. If you don't want to use -@acronym{IMAP} as intended, as a network mail reading protocol (ie +@acronym{IMAP} as intended, as a network mail reading protocol (i.e., with nnimap), for some reason or other, Gnus let you treat it similar to a @acronym{POP} server and fetches articles from a given @acronym{IMAP} mailbox. @xref{Using IMAP}, for more information. @@ -15367,7 +15367,7 @@ Where @code{nnmail-split-lowercase-expanded} controls whether the lowercase of the matched string should be used for the substitution. Setting it as non-@code{nil} is useful to avoid the creation of multiple groups when users send to an address using different case -(i.e. mailing-list@@domain vs Mailing-List@@Domain). The default value +(i.e., mailing-list@@domain vs Mailing-List@@Domain). The default value is @code{t}. @findex nnmail-split-fancy-with-parent @@ -15901,7 +15901,7 @@ Translate all @samp{TAB} characters into @samp{SPACE} characters. @c @findex nnmail-fix-eudora-headers @cindex Eudora @cindex Pegasus -Some mail user agents (e.g. Eudora and Pegasus) produce broken +Some mail user agents (e.g., Eudora and Pegasus) produce broken @code{References} headers, but correct @code{In-Reply-To} headers. This function will get rid of the @code{References} header if the headers contain a line matching the regular expression @@ -16910,7 +16910,7 @@ Some web sites have an RDF Site Summary (@acronym{RSS}). @acronym{RSS} is a format for summarizing headlines from news related sites (such as BBC or CNN). But basically anything list-like can be presented as an @acronym{RSS} feed: weblogs, changelogs or recent -changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}). +changes to a wiki (e.g., @url{http://cliki.net/recent-changes.rdf}). @acronym{RSS} has a quite regular and nice interface, and it's possible to get the information Gnus needs to keep groups updated. @@ -16974,7 +16974,7 @@ in Emacs or @code{escape-quoted} in XEmacs). @item nnrss-ignore-article-fields @vindex nnrss-ignore-article-fields Some feeds update constantly article fields during their publications, -e.g. to indicate the number of comments. However, if there is +e.g., to indicate the number of comments. However, if there is a difference between the local article and the distant one, the latter is considered to be new. To avoid this and discard some fields, set this variable to the list of fields to be ignored. The default is @@ -17144,7 +17144,7 @@ After all, Gnus is a newsreader, in case you're forgetting. @code{nneething} does this in a two-step process. First, it snoops each file in question. If the file looks like an article (i.e., the first few lines look like headers), it will use this as the head. If this is -just some arbitrary file without a head (e.g. a C source file), +just some arbitrary file without a head (e.g., a C source file), @code{nneething} will cobble up a header out of thin air. It will use file ownership, name and date and do whatever it can with these elements. @@ -17866,7 +17866,7 @@ two variables are probably the only ones you will want to change: @defvar nndiary-reminders This is the list of times when you want to be reminded of your -appointments (e.g. 3 weeks before, then 2 days before, then 1 hour +appointments (e.g., 3 weeks before, then 2 days before, then 1 hour before and that's it). Remember that ``being reminded'' means that the diary message will pop up as brand new and unread again when you get new mail. @@ -17918,9 +17918,9 @@ see the event's date. @code{gnus-diary} provides two supplemental user formats to be used in summary line formats. @code{D} corresponds to a formatted time string -for the next occurrence of the event (e.g. ``Sat, Sep 22 01, 12:00''), +for the next occurrence of the event (e.g., ``Sat, Sep 22 01, 12:00''), while @code{d} corresponds to an approximate remaining time until the -next occurrence of the event (e.g. ``in 6 months, 1 week''). +next occurrence of the event (e.g., ``in 6 months, 1 week''). For example, here's how Joe's birthday is displayed in my @code{nndiary+diary:birthdays} summary buffer (note that the message is @@ -18374,7 +18374,7 @@ to know: The functions are called with no parameters, but the useful values. For example, you could decide that you don't want to download articles -that were posted more than a certain number of days ago (e.g. posted +that were posted more than a certain number of days ago (e.g., posted more than @code{gnus-agent-expire-days} ago) you might write a function something along the lines of the following: @@ -19094,7 +19094,7 @@ Hook run when finished fetching articles. @item gnus-agent-cache @vindex gnus-agent-cache Variable to control whether use the locally stored @acronym{NOV} and -articles when plugged, e.g. essentially using the Agent as a cache. +articles when plugged, e.g., essentially using the Agent as a cache. The default is non-@code{nil}, which means to use the Agent as a cache. @item gnus-agent-go-online @@ -19345,7 +19345,7 @@ entries into this list, and upon group exit, this list is saved. The current score file is by default the group's local score file, even if no such score file actually exists. To insert score commands into -some other score file (e.g. @file{all.SCORE}), you must first make this +some other score file (e.g., @file{all.SCORE}), you must first make this score file the current one. General score commands that don't actually change the score file: @@ -19961,7 +19961,7 @@ header uses. This match key is somewhat special, in that it will match the @code{From} header, and affect the score of not only the matching articles, but also all followups to the matching articles. This allows -you e.g. increase the score of followups to your own articles, or +you to increase the score of followups to your own articles, or decrease the score of followups to the articles of some known trouble-maker. Uses the same match types as the @code{From} header uses. (Using this match key will lead to creation of @file{ADAPT} @@ -20041,7 +20041,7 @@ interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{c y}) the rest. Next time you enter the group, you will see new articles in the interesting threads, plus any new threads. -I.e.---the orphan score atom is for high-volume groups where a few +I.e., the orphan score atom is for high-volume groups where a few interesting threads which can't be found automatically by ordinary scoring rules exist. @@ -20936,7 +20936,7 @@ When score files are loaded and @code{gnus-decay-scores} is non-@code{nil}, Gnus will run the score files through the decaying mechanism thereby lowering the scores of all non-permanent score rules. If @code{gnus-decay-scores} is a regexp, only score files matching this -regexp are treated. E.g. you may set it to @samp{\\.ADAPT\\'} if only +regexp are treated. E.g., you may set it to @samp{\\.ADAPT\\'} if only @emph{adaptive} score files should be decayed. The decay itself if performed by the @code{gnus-decay-score-function} function, which is @code{gnus-decay-score} by default. Here's the definition of that @@ -21143,7 +21143,7 @@ features (inspired by the Google search input language): @item Boolean query operators AND, OR, and NOT are supported, and parentheses can be used to control -operator precedence, e.g. (emacs OR xemacs) AND linux. Note that +operator precedence, e.g., (emacs OR xemacs) AND linux. Note that operators must be written with all capital letters to be recognized. Also preceding a term with a - sign is equivalent to NOT term. @@ -21188,12 +21188,12 @@ Gmane queries follow a simple query language: @table @samp @item Boolean query operators AND, OR, NOT (or AND NOT), and XOR are supported, and brackets can be -used to control operator precedence, e.g. (emacs OR xemacs) AND linux. +used to control operator precedence, e.g., (emacs OR xemacs) AND linux. Note that operators must be written with all capital letters to be recognized. @item Required and excluded terms -+ and - can be used to require or exclude terms, e.g. football -american ++ and - can be used to require or exclude terms, e.g., football -american @item Unicode handling The search engine converts all text to utf-8, so searching should work @@ -21201,8 +21201,8 @@ in any language. @item Stopwords Common English words (like 'the' and 'a') are ignored by default. You -can override this by prefixing such words with a + (e.g. +the) or -enclosing the word in quotes (e.g. "the"). +can override this by prefixing such words with a + (e.g., +the) or +enclosing the word in quotes (e.g., "the"). @end table @@ -21392,7 +21392,7 @@ bound to mairix searches and are automatically updated. @end menu @c FIXME: The markup in this section might need improvement. -@c E.g. adding @samp, @var, @file, @command, etc. +@c E.g., adding @samp, @var, @file, @command, etc. @c Cf. (info "(texinfo)Indicating") @node About mairix @@ -21400,7 +21400,7 @@ bound to mairix searches and are automatically updated. Mairix is a tool for indexing and searching words in locally stored mail. It was written by Richard Curnow and is licensed under the -GPL. Mairix comes with most popular GNU/Linux distributions, but it also +GPL@. Mairix comes with most popular GNU/Linux distributions, but it also runs under Windows (with cygwin), Mac OS X and Solaris. The homepage can be found at @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html} @@ -21430,8 +21430,8 @@ searches. Mairix searches local mail---that means, mairix absolutely must have direct access to your mail folders. If your mail resides on another -server (e.g. an @acronym{IMAP} server) and you happen to have shell -access, @code{nnmairix} supports running mairix remotely, e.g. via ssh. +server (e.g., an @acronym{IMAP} server) and you happen to have shell +access, @code{nnmairix} supports running mairix remotely, e.g., via ssh. Additionally, @code{nnmairix} only supports the following Gnus back ends: @code{nnml}, @code{nnmaildir}, and @code{nnimap}. You must use @@ -21451,7 +21451,7 @@ the package @file{mairix.el}, which comes with Emacs 23. The back end @code{nnmairix} enables you to call mairix from within Gnus, either to query mairix with a search term or to update the database. While visiting a message in the summary buffer, you can use -several pre-defined shortcuts for calling mairix, e.g. to quickly +several pre-defined shortcuts for calling mairix, e.g., to quickly search for all mails from the sender of the current message or to display the whole thread associated with the message, even if the mails are in different folders. @@ -21459,8 +21459,8 @@ mails are in different folders. Additionally, you can create permanent @code{nnmairix} groups which are bound to certain mairix searches. This way, you can easily create a group containing mails from a certain sender, with a certain subject line or -even for one specific thread based on the Message-ID. If you check for -new mail in these folders (e.g. by pressing @kbd{g} or @kbd{M-g}), they +even for one specific thread based on the Message-ID@. If you check for +new mail in these folders (e.g., by pressing @kbd{g} or @kbd{M-g}), they automatically update themselves by calling mairix. You might ask why you need @code{nnmairix} at all, since mairix already @@ -21470,7 +21470,7 @@ does not---at least not without problems. Most probably you will get strange article counts, and sometimes you might see mails which Gnus claims have already been canceled and are inaccessible. This is due to the fact that Gnus isn't really amused when things are happening behind -its back. Another problem can be the mail back end itself, e.g. if you +its back. Another problem can be the mail back end itself, e.g., if you use mairix with an @acronym{IMAP} server (I had Dovecot complaining about corrupt index files when mairix changed the contents of the search group). Using @code{nnmairix} should circumvent these problems. @@ -21485,7 +21485,7 @@ binary so that the search results are stored in folders named present these folders in the Gnus front end only with @code{<NAME>}. You can use an existing mail back end where you already store your mail, but if you're uncomfortable with @code{nnmairix} creating new mail -groups alongside your other mail, you can also create e.g. a new +groups alongside your other mail, you can also create, e.g., a new @code{nnmaildir} or @code{nnml} server exclusively for mairix, but then make sure those servers do not accidentally receive your new mail (@pxref{nnmairix caveats}). A special case exists if you want to use @@ -21594,7 +21594,7 @@ Just hit @kbd{TAB} to see the available servers. Currently, servers which are accessed through @code{nnmaildir}, @code{nnimap} and @code{nnml} are supported. As explained above, for locally stored mails, this can be an existing server where you store your mails. -However, you can also create e.g. a new @code{nnmaildir} or @code{nnml} +However, you can also create, e.g., a new @code{nnmaildir} or @code{nnml} server exclusively for @code{nnmairix} in your secondary select methods (@pxref{Finding the News}). If you use a secondary @code{nnml} server just for mairix, make sure that you explicitly set the server variable @@ -21607,20 +21607,20 @@ just for mairix, make sure that you explicitly set the server variable @vindex nnmairix-mairix-search-options The @strong{command} to call the mairix binary. This will usually just be @code{mairix}, but you can also choose something like @code{ssh -SERVER mairix} if you want to call mairix remotely, e.g. on your +SERVER mairix} if you want to call mairix remotely, e.g., on your @acronym{IMAP} server. If you want to add some default options to mairix, you could do this here, but better use the variable @code{nnmairix-mairix-search-options} instead. @item The name of the @strong{default search group}. This will be the group -where all temporary mairix searches are stored, i.e. all searches which +where all temporary mairix searches are stored, i.e., all searches which are not bound to permanent @code{nnmairix} groups. Choose whatever you like. @item If the mail back end is @code{nnimap} or @code{nnmaildir}, you will be -asked if you work with @strong{Maildir++}, i.e. with hidden maildir +asked if you work with @strong{Maildir++}, i.e., with hidden maildir folders (=beginning with a dot). For example, you have to answer @samp{yes} here if you work with the Dovecot @acronym{IMAP} server. Otherwise, you should answer @samp{no} here. @@ -21679,7 +21679,7 @@ Changes the search query for the @code{nnmairix} group under cursor @kindex G b t (Group) @findex nnmairix-group-toggle-threads-this-group Toggles the 'threads' parameter for the @code{nnmairix} group under cursor, -i.e. if you want see the whole threads of the found messages +i.e., if you want see the whole threads of the found messages (@code{nnmairix-group-toggle-threads-this-group}). @item G b u @@ -21769,8 +21769,8 @@ calling @code{nnmairix-search} with @samp{f:From}. @kindex $ o (Summary) @findex nnmairix-goto-original-article (Only in @code{nnmairix} groups!) Tries determine the group this article -originally came from and displays the article in this group, so that -e.g. replying to this article the correct posting styles/group +originally came from and displays the article in this group, so that, +e.g., replying to this article the correct posting styles/group parameters are applied (@code{nnmairix-goto-original-article}). This function will use the registry if available, but can also parse the article file name as a fallback method. @@ -21868,7 +21868,7 @@ way slower than the registry---if you set hundreds or even thousands of marks this way, it might take some time. You can avoid this situation by setting @code{nnmairix-only-use-registry} to t. -Maybe you also want to propagate marks the other way round, i.e. if you +Maybe you also want to propagate marks the other way round, i.e., if you tick an article in a "real" mail group, you'd like to have the same article in a @code{nnmairix} group ticked, too. For several good reasons, this can only be done efficiently if you use maildir. To @@ -21922,7 +21922,7 @@ Example: search group for ticked articles For example, you can create a group for all ticked articles, where the articles always stay unread: -Hit @kbd{G b g}, enter group name (e.g. @samp{important}), use +Hit @kbd{G b g}, enter group name (e.g., @samp{important}), use @samp{F:f} as query and do not include threads. Now activate marks propagation for this group by using @kbd{G b p}. Then @@ -21935,7 +21935,7 @@ tick marks from the original article. The other possibility is to set @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t}, but see the above comments about this option. If it works for you, the tick marks should also exist in the @code{nnmairix} group and you can remove them as usual, -e.g. by marking an article as read. +e.g., by marking an article as read. When you have removed a tick mark from the original article, this article should vanish from the @code{nnmairix} group after you have updated the @@ -21951,7 +21951,7 @@ the mail back end in the form @samp{zz_mairix-<NAME>-<NUMBER>}. You can see them when you enter the back end server in the server buffer. You should not subscribe these groups! Unfortunately, these groups will usually get @emph{auto-subscribed} when you use @code{nnmaildir} or -@code{nnml}, i.e. you will suddenly see groups of the form +@code{nnml}, i.e., you will suddenly see groups of the form @samp{zz_mairix*} pop up in your group buffer. If this happens to you, simply kill these groups with C-k. For avoiding this, turn off auto-subscription completely by setting the variable @@ -22563,7 +22563,7 @@ size spec per split. Point will be put in the buffer that has the optional third element @code{point}. In a @code{frame} split, the last subsplit having a leaf -split where the tag @code{frame-focus} is a member (i.e. is the third or +split where the tag @code{frame-focus} is a member (i.e., is the third or fourth element in the list, depending on whether the @code{point} tag is present) gets focus. @@ -22898,11 +22898,11 @@ quicker. @vindex gnus-mode-non-string-length By default, Gnus displays information on the current article in the mode lines of the summary and article buffers. The information Gnus wishes -to display (e.g. the subject of the article) is often longer than the +to display (e.g., the subject of the article) is often longer than the mode lines, and therefore have to be cut off at some point. The @code{gnus-mode-non-string-length} variable says how long the other elements on the line is (i.e., the non-info part). If you put -additional elements on the mode line (e.g. a clock), you should modify +additional elements on the mode line (e.g., a clock), you should modify this variable: @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it> @@ -23922,7 +23922,7 @@ Specifiers}) follow. @end lisp Once you manage to process your incoming spool somehow, thus making -the mail contain e.g.@: a header indicating it is spam, you are ready to +the mail contain, e.g., a header indicating it is spam, you are ready to filter it out. Using normal split methods (@pxref{Splitting Mail}): @lisp @@ -24600,7 +24600,7 @@ From Reiner Steib <reiner.steib@@gmx.de>. My provider has set up bogofilter (in combination with @acronym{DCC}) on the mail server (@acronym{IMAP}). Recognized spam goes to @samp{spam.detected}, the rest goes through the normal filter rules, -i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false +i.e., to @samp{some.folder} or to @samp{INBOX}. Training on false positives or negatives is done by copying or moving the article to @samp{training.ham} or @samp{training.spam} respectively. A cron job on the server feeds those to bogofilter with the suitable ham or spam @@ -24625,7 +24625,7 @@ does most of the job for me: @item @b{The Spam folder:} In the folder @samp{spam.detected}, I have to check for false positives -(i.e. legitimate mails, that were wrongly judged as spam by +(i.e., legitimate mails, that were wrongly judged as spam by bogofilter or DCC). Because of the @code{gnus-group-spam-classification-spam} entry, all @@ -24638,7 +24638,7 @@ and deleted from the @samp{spam.detected} folder. The @code{gnus-article-sort-by-chars} entry simplifies detection of false positives for me. I receive lots of worms (sweN, @dots{}), that all -have a similar size. Grouping them by size (i.e. chars) makes finding +have a similar size. Grouping them by size (i.e., chars) makes finding other false positives easier. (Of course worms aren't @i{spam} (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is an excellent tool for filtering those unwanted mails for me.) @@ -24666,7 +24666,7 @@ groups as spam and reports the to Gmane at group exit: Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)} because I don't read the groups directly from news.gmane.org, but -through my local news server (leafnode). I.e. the article numbers are +through my local news server (leafnode). I.e., the article numbers are not the same as on news.gmane.org, thus @code{spam-report.el} has to check the @code{X-Report-Spam} header to find the correct number. @@ -24805,7 +24805,7 @@ messages are not assumed to be spam or ham. Set this variable to @code{t} if you want to use the BBDB as an implicit filter, meaning that every message will be considered spam -unless the sender is in the BBDB. Use with care. Only sender +unless the sender is in the BBDB@. Use with care. Only sender addresses in the BBDB will be allowed through; all others will be classified as spammers. @@ -25269,7 +25269,7 @@ SpamOracle. @defvar spam-spamoracle-binary Gnus uses the SpamOracle binary called @file{spamoracle} found in the -user's PATH. Using the variable @code{spam-spamoracle-binary}, this +user's PATH@. Using the variable @code{spam-spamoracle-binary}, this can be customized. @end defvar @@ -25334,7 +25334,7 @@ messages. @end example For this group the @code{spam-use-spamoracle} is installed for both ham and spam processing. If the group contains spam message -(e.g. because SpamOracle has not had enough sample messages yet) and +(e.g., because SpamOracle has not had enough sample messages yet) and the user marks some messages as spam messages, these messages will be processed by SpamOracle. The processor sends the messages to SpamOracle as new samples for spam. @@ -25780,7 +25780,7 @@ of said features in case your attention span is... never mind. Split messages to their parent This keeps discussions in the same group. You can use the subject and -the sender in addition to the Message-ID. Several strategies are +the sender in addition to the Message-ID@. Several strategies are available. @item @@ -26482,7 +26482,7 @@ Message Mode is able to request notifications from the receiver. @cindex RFC 1991 @cindex RFC 2440 RFC 1991 is the original @acronym{PGP} message specification, -published as an informational RFC. RFC 2440 was the follow-up, now +published as an informational RFC@. RFC 2440 was the follow-up, now called Open PGP, and put on the Standards Track. Both document a non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both encoding (signing and encryption) and decoding (verification and @@ -27455,7 +27455,7 @@ group, which is created automatically. values. @item -@code{gnus-summary-goto-article} now accept Message-ID's. +@code{gnus-summary-goto-article} now accept Message-IDs. @item A new Message command for deleting text in the body of a message @@ -28209,7 +28209,7 @@ The nnml and nnfolder back ends store marks for each groups. This makes it possible to take backup of nnml/nnfolder servers/groups separately of @file{~/.newsrc.eld}, while preserving marks. It also makes it possible to share articles and marks between users (without -sharing the @file{~/.newsrc.eld} file) within e.g. a department. It +sharing the @file{~/.newsrc.eld} file) within, e.g., a department. It works by storing the marks stored in @file{~/.newsrc.eld} in a per-group file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to @@ -28912,10 +28912,10 @@ can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are slow, and then try to analyze the backtrace (repeating the procedure helps isolating the real problem areas). -A fancier approach is to use the elisp profiler, ELP. The profiler is +A fancier approach is to use the elisp profiler, ELP@. The profiler is (or should be) fully documented elsewhere, but to get you started there are a few steps that need to be followed. First, instrument the -part of Gnus you are interested in for profiling, e.g. @kbd{M-x +part of Gnus you are interested in for profiling, e.g., @kbd{M-x elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package RET message}. Then perform the operation that is slow and press @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. @section Lesson I: Development Cycle The purpose of this tutorial is to guide you through a very basic -development cycle using IDLWAVE. We will paste a simple program into +development cycle using IDLWAVE@. We will paste a simple program into a buffer and use the shell to compile, debug and run it. On the way we will use many of the important IDLWAVE commands. Note, however, 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 highlighted in different colors, if you have set up support for font-lock. -Let's check out two particular editing features of IDLWAVE. Place the +Let's check out two particular editing features of IDLWAVE@. Place the cursor after the @code{end} statement of the @code{for} loop and press @key{SPC}. IDLWAVE blinks back to the beginning of the block and changes the generic @code{end} to the specific @code{endfor} @@ -464,7 +464,7 @@ First, let's launch the IDLWAVE shell. You do this with the command @kbd{C-c C-s}. The Emacs window will split or another window will popup to display IDL running in a shell interaction buffer. Type a few commands like @code{print,!PI} to convince yourself that you can work -there just as well as in a terminal, or the IDLDE. Use the arrow keys +there just as well as in a terminal, or the IDLDE@. Use the arrow keys to cycle through your command history. Are we having fun now? 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 variables. You can access it through the IDLWAVE menu in one of the @file{.pro} buffers, menu item @code{Customize->Browse IDLWAVE Group}. Here you'll be presented with all the various variables grouped -into categories. You can navigate the hierarchy (e.g. @samp{IDLWAVE +into categories. You can navigate the hierarchy (e.g., @samp{IDLWAVE Code Formatting->Idlwave Abbrev And Indent Action->Idlwave Expand Generic End} to turn on @code{END} expansion), read about the variables, 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 every IDL routine on your search path. All this information is written to the file @file{.idlwave/idlusercat.el} in your home directory and will from now on automatically load whenever you use -IDLWAVE. You may find it necessary to rebuild the catalog on occasion +IDLWAVE@. You may find it necessary to rebuild the catalog on occasion as your local libraries change, or build a library catalog for those directories instead. Invoke routine info (@kbd{C-c ?}) or completion (@kbd{M-@key{TAB}}) on any routine or partial routine name you know to @@ -715,7 +715,7 @@ Usage: Result = READFITS(filename, header, heap) ... @end example -I hope you made it until here. Now you are set to work with IDLWAVE. +I hope you made it until here. Now you are set to work with IDLWAVE@. On the way you will want to change other things, and to learn more about the possibilities not discussed in this short tutorial. Read the manual, look at the documentation strings of interesting variables @@ -789,7 +789,7 @@ continuation lines. @cindex Foreign code, adapting @cindex Indentation, of foreign code @kindex C-M-\ -To re-indent a larger portion of code (e.g. when working with foreign +To re-indent a larger portion of code (e.g., when working with foreign code written with different conventions), use @kbd{C-M-\} (@code{indent-region}) after marking the relevant code. Useful marking 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: @end example @noindent This simultaneously solves the font-lock problem and is more -consistent with the notation for hexadecimal numbers, e.g. @code{'C5'XB}. +consistent with the notation for hexadecimal numbers, e.g., @code{'C5'XB}. @node Routine Info, Online Help, Code Formatting, The IDLWAVE Major Mode @section Routine Info @@ -1111,7 +1111,7 @@ method exists in several classes, IDLWAVE queries for the class of the object, unless the class is already known through a text property on the @samp{->} operator (@pxref{Object Method Completion and Class Ambiguity}), or by having been explicitly included in the call -(e.g. @code{a->myclass::Foo}). +(e.g., @code{a->myclass::Foo}). @cindex Calling sequences @cindex Keywords of a routine @@ -1168,7 +1168,7 @@ will automatically split into the next two. Any routines discovered in library catalogs (@pxref{Library Catalogs}), will display the category assigned during creation, -e.g. @samp{NasaLib}. For routines not discovered in this way, you can +e.g., @samp{NasaLib}. For routines not discovered in this way, you can create additional categories based on the routine's filename using the variable @code{idlwave-special-lib-alist}. @@ -1248,12 +1248,12 @@ Maximum number of source files displayed in the Routine Info window. @cindex Speed, of online help @cindex XML Help Catalog -For IDL system routines, extensive documentation is supplied with IDL. +For IDL system routines, extensive documentation is supplied with IDL@. IDLWAVE can access the HTML version of this documentation very quickly and accurately, based on the local context. This can be @emph{much} faster than using the IDL online help application, because IDLWAVE usually gets you to the right place in the documentation directly --- -e.g. a specific keyword of a routine --- without any additional browsing +e.g., a specific keyword of a routine --- without any additional browsing and scrolling. For this online help to work, an HTML version of the IDL documentation @@ -1331,7 +1331,7 @@ When using completion and Emacs pops up a @file{*Completions*} buffer with possible completions, clicking with @kbd{Mouse-3} on a completion item invokes help on that item (@pxref{Completion}). Items for which help is available in the online system documentation (vs. just the -program source itself) will be emphasized (e.g. colored blue). +program source itself) will be emphasized (e.g., colored blue). @end itemize @noindent In both cases, a blue face indicates that the item is documented in @@ -1501,7 +1501,7 @@ displaying source file. @defopt idlwave-help-doclib-name (@code{"name"}) The case-insensitive heading word in doclib headers to locate the -@emph{name} section. Can be a regexp, e.g. @code{"\\(name\\|nom\\)"}. +@emph{name} section. Can be a regexp, e.g., @code{"\\(name\\|nom\\)"}. @end defopt @defopt idlwave-help-doclib-keyword (@code{"KEYWORD"}) @@ -1576,7 +1576,7 @@ If the list of completions is too long to fit in the @kbd{M-@key{TAB}} repeatedly. Online help (if installed) for each possible completion is available by clicking with @kbd{Mouse-3} on the item. Items for which system online help (from the IDL manual) is -available will be emphasized (e.g. colored blue). For other items, the +available will be emphasized (e.g., colored blue). For other items, the corresponding source code or DocLib header will be used as the help text. @@ -1681,14 +1681,14 @@ narrow down the number of possible completions. The variable @code{idlwave-query-class} can be configured to make such prompting the default for all methods (not recommended), or selectively for very common methods for which the number of completing keywords would be too -large (e.g. @code{Init,SetProperty,GetProperty}). +large (e.g., @code{Init,SetProperty,GetProperty}). @cindex Saving object class on @code{->} @cindex @code{->} -After you have specified the class for a particular statement (e.g. when +After you have specified the class for a particular statement (e.g., when completing the method), IDLWAVE can remember it for the rest of the editing session. Subsequent completions in the same statement -(e.g. keywords) can then reuse this class information. This works by +(e.g., keywords) can then reuse this class information. This works by placing a text property on the method invocation operator @samp{->}, after which the operator will be shown in a different face (bold by default). The variable @code{idlwave-store-inquired-class} can be used @@ -1737,7 +1737,7 @@ be used (as in the buffer). @cindex Keyword inheritance @cindex Inheritance, keyword -Class inheritance affects which methods are called in IDL. An object of +Class inheritance affects which methods are called in IDL@. An object of a class which inherits methods from one or more superclasses can override that method by defining its own method of the same name, extend 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. @cindex Structure tag completion In many programs, especially those involving widgets, large structures -(e.g. the @samp{state} structure) are used to communicate among +(e.g., the @samp{state} structure) are used to communicate among routines. It is very convenient to be able to complete structure tags, in the same way as for instance variables (tags) of the @samp{self} 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 the structure in all parts of the program. This is entirely unenforced by the IDL language, but is a typical convention. If you consistently refer to the same structure with the same variable name -(e.g. @samp{state}), structure tags which are read from its definition +(e.g., @samp{state}), structure tags which are read from its definition in the same file can be used for completion. Structure tag completion is not enabled by default. To enable it, @@ -2070,7 +2070,7 @@ abbreviation strings. @end defopt @defopt idlwave-abbrev-move (@code{t}) -Non-@code{nil} means the abbrev hook can move point, e.g. to end up +Non-@code{nil} means the abbrev hook can move point, e.g., to end up between the parentheses of a function call. @end defopt @@ -2103,7 +2103,7 @@ must be non-@code{nil}. @item @cindex Foreign code, adapting @cindex Actions, applied to foreign code -Actions can also be applied to a larger piece of code, e.g. to convert +Actions can also be applied to a larger piece of code, e.g., to convert foreign code to your own style. To do this, mark the relevant part of the code and execute @kbd{M-x expand-region-abbrevs}. Useful marking 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 Note that the modified assignment operators which begin with a word (@samp{AND=}, @samp{OR=}, @samp{NOT=}, etc.) require a leading space to be recognized (e.g @code{vAND=4} would be interpreted as a variable -@code{vAND}). Also note that, since e.g., @code{>} and @code{>=} are +@code{vAND}). Also note that since, e.g., @code{>} and @code{>=} are both valid operators, it is impossible to surround both by blanks while they are being typed. Similarly with @code{&} and @code{&&}. For 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. @cindex Spells, magic IDLWAVE works in line input mode: You compose a full command line, using all the power Emacs gives you to do this. When you press @key{RET}, the -whole line is sent to IDL. Sometimes it is necessary to send single +whole line is sent to IDL@. Sometimes it is necessary to send single characters (without a newline), for example when an IDL program is waiting for single character input with the @code{GET_KBRD} function. You can send a single character to IDL with the command @kbd{C-c C-x} (@code{idlwave-shell-send-char}). When you press @kbd{C-c C-y} (@code{idlwave-shell-char-mode-loop}), IDLWAVE runs a blocking loop -which accepts characters and immediately sends them to IDL. The loop +which accepts characters and immediately sends them to IDL@. The loop can be exited with @kbd{C-g}. It terminates also automatically when the current IDL command is finished. Check the documentation of the two variables described below for a way to make IDL programs trigger @@ -2745,7 +2745,7 @@ example, if you include in @file{.emacs}: @end lisp @noindent a breakpoint can then be set by pressing @kbd{b} while holding down -@kbd{shift} and @kbd{control} keys, i.e. @kbd{C-S-b}. Compiling a +@kbd{shift} and @kbd{control} keys, i.e., @kbd{C-S-b}. Compiling a source file will be on @kbd{C-S-c}, deleting a breakpoint @kbd{C-S-d}, etc. In the remainder of this chapter we will assume that the @kbd{C-c C-d} bindings are active, but each of these bindings will @@ -2783,11 +2783,11 @@ more of @code{control}, @code{meta}, @code{super}, @code{hyper}, IDLWAVE helps you set breakpoints and step through code. Setting a breakpoint in the current line of the source buffer is accomplished with @kbd{C-c C-d C-b} (@code{idlwave-shell-break-here}). With a -prefix arg of 1 (i.e. @kbd{C-1 C-c C-d C-b}), the breakpoint gets a +prefix arg of 1 (i.e., @kbd{C-1 C-c C-d C-b}), the breakpoint gets a @code{/ONCE} keyword, meaning that it will be deleted after first use. -With a numeric prefix greater than one (e.g. @kbd{C-4 C-c C-d C-b}), +With a numeric prefix greater than one (e.g., @kbd{C-4 C-c C-d C-b}), the breakpoint will only be active the @code{nth} time it is hit. -With a single non-numeric prefix (i.e. @kbd{C-u C-c C-d C-b}), prompt +With a single non-numeric prefix (i.e., @kbd{C-u C-c C-d C-b}), prompt for a condition --- an IDL expression to be evaluated and trigger the breakpoint only if true. To clear the breakpoint in the current line, use @kbd{C-c C-d C-d} (@code{idlwave-clear-current-bp}). When @@ -3042,7 +3042,7 @@ with shortcut of examine type. Most single-character electric debug bindings use the final keystroke of the equivalent multiple key commands (which are of course also -still available), but some differ (e.g. @kbd{e},@kbd{t},@kbd{q},@kbd{x}). +still available), but some differ (e.g., @kbd{e},@kbd{t},@kbd{q},@kbd{x}). Some have additional convenience bindings (like @kbd{@key{SPACE}} for stepping). All prefix and other argument options described in this section for the commands invoked by electric debug bindings are still @@ -3106,7 +3106,7 @@ window, but is useful for immediate stepping, etc. @cindex Mouse binding to print expressions @kindex C-c C-d C-p -Do you find yourself repeatedly typing, e.g. @code{print,n_elements(x)}, +Do you find yourself repeatedly typing, e.g., @code{print,n_elements(x)}, and similar statements to remind yourself of the type/size/structure/value/etc. of variables and expressions in your code 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 For added speed and convenience, there are mouse bindings which allow you to click on expressions and examine their values. Use @kbd{S-Mouse-2} to print an expression and @kbd{C-M-Mouse-2} to invoke -help (i.e. you need to hold down @key{META} and @key{CONTROL} while +help (i.e., you need to hold down @key{META} and @key{CONTROL} while clicking with the middle mouse button). If you simply click, the nearest expression will be selected in the same manner as described 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. @cindex ROUTINE_NAMES, IDL procedure N.B.: printing values of expressions on higher levels of the calling stack uses the @emph{unsupported} IDL routine @code{ROUTINE_NAMES}, -which may or may not be available in future versions of IDL. Caveat +which may or may not be available in future versions of IDL@. Caveat Examinor. @end itemize @@ -3503,7 +3503,7 @@ extending the internal built-in information available for IDL system routines (@pxref{Routine Info}) to other source collections. Starting with version 5.0, there are two types of catalogs available -with IDLWAVE. The traditional @emph{user catalog} and the newer +with IDLWAVE@. The traditional @emph{user catalog} and the newer @emph{library catalogs}. Although they can be used interchangeably, the library catalogs are more flexible, and preferred. There are few occasions when a user catalog might be preferred --- read below. Both @@ -3513,7 +3513,7 @@ To facilitate the catalog systems, IDLWAVE stores information it gathers from the shell about the IDL search paths, and can write this information out automatically, or on-demand (menu @code{Debug->Save Path Info}). On systems with no shell from which to discover the path -information (e.g. Windows), a library path must be specified in +information (e.g., Windows), a library path must be specified in @code{idlwave-library-path} to allow library catalogs to be located, and to setup directories for user catalog scan (@pxref{User Catalog} for more on this variable). Note that, before the shell is running, IDLWAVE @@ -3530,12 +3530,12 @@ to locate library catalogs. @end defopt @defopt idlwave-library-path -IDL library path for Windows and MacOS. Under Unix/MacOSX, will be +IDL library path for Windows and MacOS@. Under Unix/MacOSX, will be obtained from the Shell when run. @end defopt @defopt idlwave-system-directory -The IDL system directory for Windows and MacOS. Also needed for +The IDL system directory for Windows and MacOS@. Also needed for locating HTML help and the IDL Assistant for IDL v6.2 and later. Under Unix/MacOSX, will be obtained from the Shell and recorded, if run. @end defopt @@ -3565,19 +3565,19 @@ in directories containing @code{.pro} routine files. They are discovered on the IDL search path and loaded automatically when routine information is read. Each catalog file documents the routines found in that directory --- one catalog per directory. Every catalog has a -library name associated with it (e.g. @emph{AstroLib}). This name will +library name associated with it (e.g., @emph{AstroLib}). This name will be shown briefly when the catalog is found, and in the routine info of routines it documents. Many popular libraries of routines are shipped with IDLWAVE catalog files by default, and so will be automatically discovered. Library catalogs are scanned externally to Emacs using a tool provided with -IDLWAVE. Each catalog can be re-scanned independently of any other. +IDLWAVE@. Each catalog can be re-scanned independently of any other. Catalogs can easily be made available system-wide with a common source repository, providing uniform routine information, and lifting the burden of scanning from the user (who may not even know they're using a scanned catalog). Since all catalogs are independent, they can be -re-scanned automatically to gather updates, e.g. in a @file{cron} job. +re-scanned automatically to gather updates, e.g., in a @file{cron} job. Scanning is much faster than with the built-in user catalog method. One minor disadvantage: the entire IDL search path is scanned for catalog 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 @item @kbd{M-x idlwave-list-buffer-load-path-shadows} This command checks the names of all routines defined in the current buffer for shadowing conflicts with other routines accessible to -IDLWAVE. The command also has a key binding: @kbd{C-c C-b} +IDLWAVE@. The command also has a key binding: @kbd{C-c C-b} @item @kbd{M-x idlwave-list-shell-load-path-shadows}. Checks all routines compiled under the shell for shadowing. This is very useful when you have written a complete application. Just compile @@ -3744,7 +3744,7 @@ many other reasons. @cindex @code{!DIR}, IDL variable Users of Windows and MacOS (not X) also must set the variable @code{idlwave-system-directory} to the value of the @code{!DIR} system -variable in IDL. IDLWAVE appends @file{lib} to the value of this +variable in IDL@. IDLWAVE appends @file{lib} to the value of this variable and assumes that all files found on that path are system routines. @@ -3791,7 +3791,7 @@ itself. There are a wide variety of possible browsers to use for displaying the online HTML help available with IDLWAVE (starting with version 5.0). Since IDL v6.2, a single cross-platform HTML help browser, the -@emph{IDL Assistant} is distributed with IDL. If this help browser is +@emph{IDL Assistant} is distributed with IDL@. If this help browser is available, it is the preferred choice, and the default. The variable @code{idlwave-help-use-assistant}, enabled by default, controls whether this help browser is used. If you use the IDL Assistant, the @@ -3879,7 +3879,7 @@ features which: @itemize @minus @item -are not self-evident (i.e. too magic) when used by an unsuspecting user. +are not self-evident (i.e., too magic) when used by an unsuspecting user. @item are too intrusive. @item @@ -3910,7 +3910,7 @@ the old maintainer had in his @file{.emacs}: However, if you are an Emacs power-user and want IDLWAVE to work completely differently, you can change almost every aspect of it. Here -is an example of a much more extensive configuration of IDLWAVE. The +is an example of a much more extensive configuration of IDLWAVE@. The user is King! @example @@ -4121,7 +4121,7 @@ under MacOSX} If you run Emacs directly as an Aqua application, rather than from the console shell, the environment is set not from your usual shell -configuration files (e.g. @file{.cshrc}), but from the file +configuration files (e.g., @file{.cshrc}), but from the file @file{~/.MacOSX/environment.plist}. Either include your path settings there, or start Emacs and IDLWAVE from the shell. @@ -4136,7 +4136,7 @@ which includes it by default. cl-builtin-gethash} on completion or routine info.} This error arises if you upgraded Emacs from 20.x to 21.x without -re-installing IDLWAVE. Old Emacs and new Emacs are not byte-compatible +re-installing IDLWAVE@. Old Emacs and new Emacs are not byte-compatible in compiled lisp files. Presumably, you kept the original .elc files in place, and this is the source of the error. If you recompile (or just "make; make install") from source, it should resolve this problem. @@ -4190,7 +4190,7 @@ load file}}. The problem is that your Emacs is not finding the version of IDLWAVE you installed. Many Emacsen come with an older bundled copy of IDLWAVE -(e.g. v4.7 for Emacs 21.x), which is likely what's being used instead. +(e.g., v4.7 for Emacs 21.x), which is likely what's being used instead. You need to make sure your Emacs @emph{load-path} contains the directory where IDLWAVE is installed (@file{/usr/local/share/emacs/site-lisp}, by default), @emph{before} Emacs's default search directories. You can @@ -4244,13 +4244,13 @@ displayed as Latin characters!} Unfortunately, the HTMLHelp files RSI provides attempt to switch to @samp{Symbol} font to display Greek characters, which is not really an -permitted method for doing this in HTML. There is a "workaround" for +permitted method for doing this in HTML@. There is a "workaround" for some browsers: @xref{HTML Help Browser Tips}. @item @strong{In the shell, my long commands are truncated at 256 characters!} This actually happens when running IDL in an XTerm as well. There are -a couple of workarounds: @code{define_key,/control,'^d'} (e.g. in +a couple of workarounds: @code{define_key,/control,'^d'} (e.g., in your @file{$IDL_STARTUP} file) will disable the @samp{EOF} character and give you a 512 character limit. You won't be able to use @key{C-d} to quit the shell, however. Another possibility is @@ -4259,7 +4259,7 @@ memory-bounded limit), but disables the processing of background widget events (those with @code{/NO_BLOCK} passed to @code{XManager}). @item @strong{When I invoke IDL HTML help on a routine, the page which -is loaded is one page off, e.g. for @code{CONVERT_COORD}, I get +is loaded is one page off, e.g., for @code{CONVERT_COORD}, I get @code{CONTOUR}.} 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. @end ifinfo @end ifnottex -@insertcopying +@insertcopying @menu * Getting Started:: Getting started using an Info reader. @@ -264,7 +264,7 @@ links. @format >> If you are in Emacs and have a mouse, and if you already practiced - typing @kbd{n} to get to the next node, click now with the left + typing @kbd{n} to get to the next node, click now with the left mouse button on the @samp{Next} link to do the same ``the mouse way''. @end format @@ -324,7 +324,7 @@ the screen. we call ``Backspace or DEL'' in this manual is labeled differently on different keyboards. Look for a key which is a little ways above the @key{ENTER} or @key{RET} key and which you normally use outside Emacs -to erase the character before the cursor, i.e.@: the character you +to erase the character before the cursor, i.e., the character you typed last. It might be labeled @samp{Backspace} or @samp{<-} or @samp{DEL}, or sometimes @samp{Delete}.} and @kbd{b} commands exist to 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. Mairix is a tool for indexing and searching words in locally stored mail. It was written by Richard Curnow and is licensed under the -GPL. Mairix comes with most popular GNU/Linux distributions, but it also +GPL@. Mairix comes with most popular GNU/Linux distributions, but it also runs under Windows (with cygwin), Mac OS X and Solaris. The homepage can be found at @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html} @@ -246,7 +246,7 @@ modifying `mairix-widget-fields-list'. @kindex M-x mairix-widget-search-based-on-article @findex mairix-widget-search-based-on-article Create a mairix query using graphical widgets, but based on the -currently displayed article, i.e. the available fields will be filled +currently displayed article, i.e., the available fields will be filled with the current header values. @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 the normal methods for determining the To header will be used. Each list element should be a cons, where the @sc{car} should be the -name of a header (e.g. @code{Cc}) and the @sc{cdr} should be the header -value (e.g. @samp{larsi@@ifi.uio.no}). All these headers will be +name of a header (e.g., @code{Cc}) and the @sc{cdr} should be the header +value (e.g., @samp{larsi@@ifi.uio.no}). All these headers will be inserted into the head of the outgoing mail. @@ -407,7 +407,7 @@ and very difficult to follow. @end itemize -Gnus honors the MFT header in other's messages (i.e. while following +Gnus honors the MFT header in other's messages (i.e., while following up to someone else's post) and also provides support for generating sensible MFT headers for outgoing messages as well. @@ -1041,7 +1041,7 @@ modern cryptography, @acronym{S/MIME}, various PKCS standards, OpenSSL and so on. The @acronym{S/MIME} support in Message (and @acronym{MML}) require -OpenSSL. OpenSSL performs the actual @acronym{S/MIME} sign/encrypt +OpenSSL@. OpenSSL performs the actual @acronym{S/MIME} sign/encrypt operations. OpenSSL can be found at @uref{http://www.openssl.org/}. OpenSSL 0.9.6 and later should work. Version 0.9.5a cannot extract mail 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 required. Message (@acronym{MML}) need a certificate for the person to whom you wish to communicate with though. You're asked for this when you type @kbd{C-c C-m c s}. Currently there are two ways to retrieve this -certificate, from a local file or from DNS. If you chose a local +certificate, from a local file or from DNS@. If you chose a local file, it need to contain a X.509 certificate in @acronym{PEM} format. If you chose DNS, you're asked for the domain name where the 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 @emph{Note!} Your private key is now stored unencrypted in the file, so take care in handling it. Storing encrypted keys on the disk are supported, and Gnus will ask you for a passphrase before invoking -OpenSSL. Read the OpenSSL documentation for how to achieve this. If +OpenSSL@. Read the OpenSSL documentation for how to achieve this. If you use unencrypted keys (e.g., if they are on a secure storage, or if you are on a secure single user machine) simply press @code{RET} at the passphrase prompt. @@ -1154,9 +1154,9 @@ your PGP implementation, so we refer to it. If you have imported your old PGP 2.x key into GnuPG, and want to send signed and encrypted messages to your fellow PGP 2.x users, you'll discover that the receiver cannot understand what you send. One -solution is to use PGP 2.x instead (e.g.@: if you use @code{pgg}, set +solution is to use PGP 2.x instead (e.g., if you use @code{pgg}, set @code{pgg-default-scheme} to @code{pgp}). You could also convince your -fellow PGP 2.x users to convert to GnuPG. +fellow PGP 2.x users to convert to GnuPG@. @vindex mml-signencrypt-style-alist As a final workaround, you can make the sign and encryption work in two steps; separately sign, then encrypt a message. If you would like @@ -1676,7 +1676,7 @@ installation. Most versions of MH doesn't like being fed messages that contain the headers in this variable. If this variable is non-@code{nil} (which is the default), these headers will be removed before mailing when sending -messages via MH. Set it to @code{nil} if your MH can handle these +messages via MH@. Set it to @code{nil} if your MH can handle these headers. @item message-qmail-inject-program @@ -1690,7 +1690,7 @@ Arguments passed to qmail-inject programs. This should be a list of strings, one string for each argument. It may also be a function. -For e.g., if you wish to set the envelope sender address so that bounces +E.g., if you wish to set the envelope sender address so that bounces go to the right place or to deal with listserv's usage of that address, you might set this variable to @code{'("-f" "you@@some.where")}. @@ -1780,7 +1780,7 @@ This required header will be generated by Message. A unique ID will be created based on the date, time, user name (for the local part) and the domain part. For the domain part, message will look (in this order) at @code{message-user-fqdn}, @code{system-name}, @code{mail-host-address} -and @code{message-user-mail-address} (i.e. @code{user-mail-address}) +and @code{message-user-mail-address} (i.e., @code{user-mail-address}) until a probably valid fully qualified domain name (FQDN) was found. @item User-Agent diff --git a/doc/misc/mh-e.texi b/doc/misc/mh-e.texi index e59b312889d..d34aa6b0ae5 100644 --- a/doc/misc/mh-e.texi +++ b/doc/misc/mh-e.texi @@ -206,7 +206,7 @@ History of MH-E This manual introduces another interface to the MH mail system that is accessible through the GNU Emacs editor, namely, @emph{MH-E}. MH-E is easy to use. I don't assume that you know GNU Emacs or even MH at this -point, since I didn't know either of them when I discovered MH-E. +point, since I didn't know either of them when I discovered MH-E@. However, MH-E was the tip of the iceberg, and I discovered more and more niceties about GNU Emacs and MH@. Now I'm fully hooked on both of them. @@ -540,7 +540,7 @@ installing MH-E. If the @code{mh-version} command displays @samp{No MH variant detected}@footnote{In very old versions of MH-E, you may get the error message, @samp{Cannot find the commands `inc' and `mhl' and the file -`components'} if MH-E can't find MH. In this case, you need to update +`components'} if MH-E can't find MH@. In this case, you need to update MH-E, and you may need to install MH too. However, newer versions of MH-E are better at finding MH if it is on your system.}, then you need 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. @cindex GNU mailutils MH If you don't have MH on your system already, you must install a -variant of MH. The Debian mh-e package does this for you automatically +variant of MH@. The Debian mh-e package does this for you automatically (@pxref{Getting MH-E}). Most people use @uref{http://www.nongnu.org/nmh/, nmh}, but you may be interested in trying out @uref{http://www.gnu.org/software/mailutils/, GNU mailutils -MH}, which supports IMAP. Your GNU/Linux distribution probably has +MH}, which supports IMAP@. Your GNU/Linux distribution probably has packages for both of these. @cindex @command{install-mh} @@ -671,7 +671,7 @@ chapter for a mapping between default key bindings and function names.}. When you're done, you'll be able to send, read, and file mail, which is all that a lot of people ever do. But if you're the curious or adventurous type, read the rest of the manual to be able to -use all the features of MH-E. I suggest you read this chapter first to +use all the features of MH-E@. I suggest you read this chapter first to get the big picture, and then you can read the manual as you wish. @menu @@ -1572,7 +1572,7 @@ command incorporates your mail and creates a buffer called @samp{+inbox} in MH-Folder mode. The command @kbd{M-x mh-rmail} shows you only new mail, not mail you have already read@footnote{If you want to see your old mail as well, use @kbd{F r} to pull all your messages -into MH-E. Or, give a prefix argument to @code{mh-rmail} so it will +into MH-E@. Or, give a prefix argument to @code{mh-rmail} so it will prompt you for folder to visit like @kbd{F v} (for example, @kbd{C-u M-x mh-rmail @key{RET} bob @key{RET}}). @xref{Folders}.}. @@ -2456,7 +2456,7 @@ that they do not really appear like an attachment at all to the reader. Most of the time, this is desirable, so by default MH-E suppresses the buttons for inline attachments. On the other hand, you may receive code or HTML which the sender has added to his message as -inline attachments so that you can read them in MH-E. In this case, it +inline attachments so that you can read them in MH-E@. In this case, it is useful to see the buttons so that you know you don't have to cut and paste the code into a file; you can simply save the attachment. If you want to make the buttons visible for inline attachments, you can @@ -3222,7 +3222,7 @@ original configuration is displayed. @cindex menu, @samp{Message} @cindex using folders -This chapter discusses the things you can do with folders within MH-E. +This chapter discusses the things you can do with folders within MH-E@. The commands in this chapter are also found in the @samp{Folder} and @samp{Message} menus. @@ -5705,7 +5705,7 @@ buffer and delete the draft message. Use the command @kbd{C-x k} @cindex aliases -MH aliases are used in the same way in MH-E as they are in MH. Any +MH aliases are used in the same way in MH-E as they are in MH@. Any alias listed as a recipient will be expanded when the message is sent. This chapter discusses other things you can do with aliases in MH-E. @@ -5816,7 +5816,7 @@ Otherwise, you can complete aliases in the header of the draft with @vindex mh-alias-completion-ignore-case-flag -As MH ignores case in the aliases, so too does MH-E. However, you may +As MH ignores case in the aliases, so too does MH-E@. However, you may turn off the option @code{mh-alias-completion-ignore-case-flag} to make case significant which can be used to segregate completion of your aliases. You might use uppercase for mailing lists and lowercase @@ -8526,7 +8526,7 @@ necessary, they are extremely useful. [12] [13] # Place mail sent to any MH-E mailing list in +mh-e. [14] :0 w: mh-e$LOCKEXT -[15] * ^TO.*mh-e-.*@.*sourceforge.net +[15] * ^TO.*mh-e-.*@@.*sourceforge.net [16] | myrcvstore -create +mh-e @end smallexample @@ -8599,7 +8599,7 @@ modify. Note that for them to become accessible, you'll have to load @vtable @code @item gnus-secondary-select-methods Select the @samp{nnml} value. This select method uses directories for -folders and individual files for messages, just like MH. You do not +folders and individual files for messages, just like MH@. You do not have to set an address. @c ------------------------- @item mail-sources @@ -8632,7 +8632,7 @@ MAILDIR=$HOME/`mhparam Path` # Place mail sent to the GnuCash mailing list in gnucash.spool, where # Gnus will pick it up. :0: -* ^TO.*gnucash.*@.*gnucash.org +* ^TO.*gnucash.*@@.*gnucash.org gnucash.spool @end smallexample @@ -8677,7 +8677,7 @@ positive we won't ask for it. @cindex SourceForge @cindex mailing lists -There are several mailing lists for MH-E. They are @i{mh-e-users at +There are several mailing lists for MH-E@. They are @i{mh-e-users at lists.sourceforge.net}, @i{mh-e-announce at lists.sourceforge.net}, and @i{mh-e-devel at lists.sourceforge.net}. You can subscribe or view the archives at @uref{https://sourceforge.net/mail/?group_id=13357, @@ -8744,9 +8744,9 @@ instead. After you download and extract the MH-E tarball, read the @file{README} file and @file{MH-E-NEWS}. These correspond to the release notes and change log mentioned above. The file @file{README} -contains instructions on installing MH-E. If you're already running +contains instructions on installing MH-E@. If you're already running Emacs, please quit that session and start again to load in the new -MH-E. Check that you're running the new version with the command +MH-E@. Check that you're running the new version with the command @kbd{M-x mh-version}. @cindex contributed software @@ -8856,13 +8856,13 @@ limited the use and appeal of the package. @cindex @command{xmh}, in MH-E history In '89, I came to Wisconsin as a professor and decided not to work on -MH-E. It was stable, except for minor bugs, and had enough +MH-E@. It was stable, except for minor bugs, and had enough functionality, so I let it be for a few years. Stephen Gildea of BBN began to pester me about the bugs, but I ignored them. In 1990, he went off to the X Consortium, said good bye, and said that he would now be using @command{xmh}. A few months later, he came back and said that he couldn't stand @command{xmh} and could I put a few more bug fixes -into MH-E. At that point, I had no interest in fixing MH-E, so I gave +into MH-E@. At that point, I had no interest in fixing MH-E, so I gave the responsibility of maintenance to him and he has done a fine job since then. @@ -8883,7 +8883,7 @@ modifications of my own) and dislike having to use applications with embedded editors; they never live up to Emacs. MH is the mail reader of choice at BBN, so I converted to it. Since I -didn't want to give up using an Emacs interface, I started using MH-E. +didn't want to give up using an Emacs interface, I started using MH-E@. As is my wont, I started hacking on it almost immediately. I first used version 3.4m. One of the first features I added was to treat the folder buffer as a file-visiting buffer: you could lock it, save it, @@ -8895,7 +8895,7 @@ MH-E was too slow and optimized it a lot. Version, 3.7, distributed with Emacs 18.56 in 1990, was noticeably faster. When I moved to the X Consortium I became the first person there to -not use xmh. (There is now one other engineer there using MH-E.) About +not use xmh. (There is now one other engineer there using MH-E@.) About this point I took over maintenance of MH-E from Jim and was finally able to add some features Jim hadn't accepted, such as the backward 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 @node Configuration @chapter Configuration -All Newsticker options are customizable, i.e. they can be changed with +All Newsticker options are customizable, i.e., they can be changed with Emacs customization methods. Call the command @code{customize-group} and enter @samp{newsticker} for the customization group. @@ -260,7 +260,7 @@ apply to the plainview reader only. @item @code{newsticker-ticker} contains options that define how headlines -are shown in the echo area, i.e. the ``ticker''. +are shown in the echo area, i.e., the ``ticker''. @itemize @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. To get validation and schema-sensitive editing, you need a RELAX NG Compact Syntax (RNC) schema for your document (@pxref{Locating a schema}). The @file{etc/schema} directory includes some schemas for popular document -types. See @url{http://relaxng.org/} for more information on RELAX NG. +types. See @url{http://relaxng.org/} for more information on RELAX NG@. You can use the @samp{Trang} program from @url{http://www.thaiopensource.com/relaxng/trang.html} to automatically create RNC schemas. This program can: @@ -138,7 +138,7 @@ indicates point): @end example @noindent -and the schema is XHTML. In this context, the symbol to be completed +and the schema is XHTML@. In this context, the symbol to be completed is @samp{h}. The possible completions consist of just @samp{head}. Another example, is @@ -288,7 +288,7 @@ and then following the instructions in the displayed buffer. Emacs has several commands that operate on paragraphs, most notably @kbd{M-q}. nXML mode redefines these to work in a way -that is useful for XML. The exact rules that are used to find the +that is useful for XML@. The exact rules that are used to find the beginning and end of a paragraph are complicated; they are designed mainly to ensure that @kbd{M-q} does the right thing. @@ -355,7 +355,7 @@ child element. A section also contains its subordinate sections (its subsections). The text content of a section consists of anything in a section that is neither a subsection nor a heading. -Note that this is a different model from that used by XHTML. +Note that this is a different model from that used by XHTML@. nXML mode's outline support will not be useful for XHTML unless you adopt a convention of adding a @code{div} to enclose each section, rather than having sections implicitly delimited by different @@ -363,7 +363,7 @@ section, rather than having sections implicitly delimited by different in a future version. The variable @code{nxml-section-element-name-regexp} gives -a regexp for the local names (i.e. the part of the name following any +a regexp for the local names (i.e., the part of the name following any prefix) of section elements. The variable @code{nxml-heading-element-name-regexp} gives a regexp for the local names of heading elements. For an element to be recognized @@ -653,7 +653,7 @@ of any type is used. As usual with XML-related technologies, resources are identified by URIs. The @samp{uri} attribute identifies the schema by -specifying the URI. The URI may be relative. If so, it is resolved +specifying the URI@. The URI may be relative. If so, it is resolved relative to the URI of the schema locating file that contains attribute. This means that if the value of @samp{uri} attribute 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 whose URI matches a pattern. The pattern has the same syntax as an absolute or relative URI except that the path component of the URI can use a @samp{*} character to stand for zero or more characters -within a path segment (i.e. any character other @samp{/}). +within a path segment (i.e., any character other @samp{/}). Typically, the URI pattern looks like a relative URI, but, whereas a relative URI in the @samp{resource} attribute is resolved into a particular absolute URI using the base URI of the schema locating file, a relative URI pattern matches if it matches some number of complete path segments of the document's URI ending with the last path -segment of the document's URI. For example, +segment of the document's URI@. For example, @example <uri pattern="*.xsl" uri="xslt.rnc"/> @@ -757,7 +757,7 @@ specifies that when the namespace URI of the document is Type identifiers allow a level of indirection in locating the schema for a document. Instead of associating the document directly with a schema URI, the document is associated with a type identifier, -which is in turn associated with a schema URI. nXML mode does not +which is in turn associated with a schema URI@. nXML mode does not constrain the format of type identifiers. They can be simply strings without any formal structure or they can be public identifiers or URIs. Note that these type identifiers have nothing to do with the @@ -862,12 +862,12 @@ an @samp{applyFollowingRules} to the private file. @chapter DTDs nXML mode is designed to support the creation of standalone XML -documents that do not depend on a DTD. Although it is common practice +documents that do not depend on a DTD@. Although it is common practice to insert a DOCTYPE declaration referencing an external DTD, this has undesirable side-effects. It means that the document is no longer self-contained. It also means that different XML parsers may interpret the document in different ways, since the XML Recommendation does not -require XML parsers to read the DTD. With DTDs, it was impractical to +require XML parsers to read the DTD@. With DTDs, it was impractical to get validation without using an external DTD or reference to an parameter entity. With RELAX NG and other schema languages, you can 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 * Capture:: Capturing new stuff * Attachments:: Add files to tasks * RSS Feeds:: Getting input from RSS feeds -* Protocols:: External (e.g.@: Browser) access to Emacs and Org +* Protocols:: External (e.g., Browser) access to Emacs and Org * Refiling notes:: Moving a tree from one place to another * Archiving:: What to do with finished projects @@ -838,7 +838,7 @@ ends, for example: @cindex FAQ There is a website for Org which provides links to the newest version of Org, as well as additional information, frequently asked -questions (FAQ), links to tutorials, etc@. This page is located at +questions (FAQ), links to tutorials, etc. This page is located at @uref{http://orgmode.org}. @cindex print edition @@ -996,7 +996,7 @@ packages, please take the time to check the list (@pxref{Conflicts}). The four Org commands @command{org-store-link}, @command{org-capture}, @command{org-agenda}, and @command{org-iswitchb} should be accessible through -global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are +global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are suggested bindings for these keys, please modify the keys to your own liking. @lisp @@ -1324,7 +1324,7 @@ Expose all the headings of the subtree, CONTENT view for just one subtree. @cindex show children, command @orgcmd{C-c @key{TAB},show-children} Expose all direct children of the subtree. With a numeric prefix argument N, -expose all children down to level N. +expose all children down to level N@. @orgcmd{C-c C-x b,org-tree-to-indirect-buffer} Show the current subtree in an indirect buffer@footnote{The indirect buffer @@ -1351,7 +1351,7 @@ Copy the @i{visible} text in the region into the kill ring. @cindex @code{showeverything}, STARTUP keyword When Emacs first visits an Org file, the global state is set to -OVERVIEW, i.e.@: only the top level headlines are visible. This can be +OVERVIEW, i.e., only the top level headlines are visible. This can be configured through the variable @code{org-startup-folded}, or on a per-file basis by adding one of the following lines anywhere in the buffer: @@ -1371,7 +1371,7 @@ for this property are @code{folded}, @code{children}, @code{content}, and @code{all}. @table @asis @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility} -Switch back to the startup visibility of the buffer, i.e.@: whatever is +Switch back to the startup visibility of the buffer, i.e., whatever is requested by startup options and @samp{VISIBILITY} properties in individual entries. @end table @@ -1440,7 +1440,7 @@ headline@footnote{If you do not want the line to be split, customize the variable @code{org-M-RET-may-split-line}.}. If the command is used at the beginning of a headline, the new headline is created before the current line. If at the beginning of any other line, the content of that line is made the -new heading. If the command is used at the end of a folded subtree (i.e.@: +new heading. If the command is used at the end of a folded subtree (i.e., behind the ellipses at the end of a headline), then a headline like the current one will be inserted after the end of the subtree. @orgcmd{C-@key{RET},org-insert-heading-respect-content} @@ -1474,7 +1474,7 @@ level). @orgcmd{M-S-@key{down},org-move-subtree-down} Move subtree down (swap with next subtree of same level). @orgcmd{C-c C-x C-w,org-cut-subtree} -Kill subtree, i.e.@: remove it from buffer but save in kill ring. +Kill subtree, i.e., remove it from buffer but save in kill ring. With a numeric prefix argument N, kill N sequential subtrees. @orgcmd{C-c C-x M-w,org-copy-subtree} 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 @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize confusion with normal text, those are limited to one character only. Beyond that limit, bullets will automatically fallback to numbers.}. If you want a -list to start with a different value (e.g.@: 20), start the text of the item +list to start with a different value (e.g., 20), start the text of the item with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie must be put @emph{before} the checkbox. If you have activated alphabetical lists, you can also use counters like @code{[@@b]}.}. Those constructs can @@ -1896,7 +1896,7 @@ or on a per-file basis by using Org mode supports the creation of footnotes. In contrast to the @file{footnote.el} package, Org mode's footnotes are designed for work on a larger document, not only for one-off documents like emails. The basic -syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is +syntax is similar to the one used by @file{footnote.el}, i.e., a footnote is defined in a paragraph that is started by a footnote marker in square brackets in column 0, no indentation allowed. If you need a paragraph break 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.} n @r{Normalize the footnotes by collecting all definitions (including} @r{inline definitions) into a special section, and then numbering them} @r{in sequence. The references will then also be numbers. This is} - @r{meant to be the final step before finishing a document (e.g.@: sending} + @r{meant to be the final step before finishing a document (e.g., sending} @r{off an email). The exporters do this automatically, and so could} @r{something like @code{message-send-hook}.} 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 @section The built-in table editor @cindex table editor, built-in -Org makes it easy to format tables in plain ASCII. Any line with @samp{|} as +Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as the first non-whitespace character is considered part of a table. @samp{|} is also the column separator@footnote{To insert a vertical bar into a table field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table @@ -2429,7 +2429,7 @@ representation that looks like this: @end example Column specifications can be absolute like @code{$1}, -@code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the +@code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the column of the field which is being computed) like @code{$+1} or @code{$-2}. @code{$<} and @code{$>} are immutable references to the first and last 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. However, this syntax is deprecated, it should not be used for new documents. Use @code{@@>$} instead.} row in the table, respectively. You may also specify the row relative to one of the hlines: @code{@@I} refers to the first -hline, @code{@@II} to the second, etc@. @code{@@-I} refers to the first such +hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such line above the current line, @code{@@+I} to the first such line below the current line. You can also write @code{@@III+2} which is the second data line after the third hline in the table. @code{@@0} and @code{$0} refer to the current row and column, respectively, -i.e. to the row/column for the field being computed. Also, if you omit +i.e., to the row/column for the field being computed. Also, if you omit either the column or the row part of the reference, the current row/column is implied. @@ -2810,7 +2810,7 @@ following command: Install a new formula for the current column and replace current field with the result of the formula. The command prompts for a formula, with default taken from the @samp{#+TBLFM} line, applies it to the current field and -stores it. With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command +stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command will apply it to that many consecutive fields in the current column. @end table @@ -3115,7 +3115,7 @@ Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}. @item with Specify a @code{with} option to be inserted for every col being plotted -(e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). +(e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). Defaults to @code{lines}. @item file @@ -3519,7 +3519,7 @@ variable @code{org-display-internal-link-with-indirect-buffer}}. @cindex @code{inlineimages}, STARTUP keyword @cindex @code{noinlineimages}, STARTUP keyword Toggle the inline display of linked images. Normally this will only inline -images that have no description part in the link, i.e.@: images that will also +images that have no description part in the link, i.e., images that will also be inlined during export. When called with a prefix argument, also display images that do have a link description. You can ask for inline images to be displayed at startup by configuring the variable @@ -3629,7 +3629,7 @@ can define them in the file with @noindent In-buffer completion (@pxref{Completion}) can be used after @samp{[} to complete link abbreviations. You may also define a function -@code{org-PREFIX-complete-link} that implements special (e.g.@: completion) +@code{org-PREFIX-complete-link} that implements special (e.g., completion) support for inserting such a link with @kbd{C-c C-l}. Such a function should not accept any arguments, and return the full link with prefix. @@ -3781,7 +3781,7 @@ with @code{shift-selection-mode}. See also the variable View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the entire buffer, but shows all TODO items (with not-DONE state) and the headings hierarchy above them. With a prefix argument (or by using @kbd{C-c -/ T}), search for a specific TODO. You will be prompted for the keyword, and +/ T}), search for a specific TODO@. You will be prompted for the keyword, and you can also give a list of keywords like @code{KWD1|KWD2|...} to list entries that match any one of these keywords. With a numeric prefix argument N, show the tree for the Nth keyword in the variable @@ -3808,7 +3808,7 @@ option @code{org-todo-state-tags-triggers} for details. @vindex org-todo-keywords By default, marked TODO entries have one of only two states: TODO and -DONE. Org mode allows you to classify TODO items in more complex ways +DONE@. Org mode allows you to classify TODO items in more complex ways with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With special setup, the TODO keyword system can work differently in different files. @@ -3847,9 +3847,9 @@ you don't provide the separator bar, the last state is used as the DONE state. @cindex completion, of TODO keywords With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO -to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may +to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may also use a numeric prefix argument to quickly select a specific state. For -example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY. +example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@. Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you define many keywords, you can use in-buffer completion (@pxref{Completion}) or even a special one-key selection scheme @@ -3876,13 +3876,13 @@ be set up like this: In this case, different keywords do not indicate a sequence, but rather different types. So the normal work flow would be to assign a task to a -person, and later to mark it DONE. Org mode supports this style by adapting +person, and later to mark it DONE@. Org mode supports this style by adapting the workings of the command @kbd{C-c C-t}@footnote{This is also true for the @kbd{t} command in the timeline and agenda buffers.}. When used several times in succession, it will still cycle through all names, in order to first select the right type for a task. But when you return to the item after some time and execute @kbd{C-c C-t} again, it will switch from any name directly -to DONE. Use prefix arguments or completion to quickly select a specific +to DONE@. Use prefix arguments or completion to quickly select a specific name. You can also review the items of a specific TODO type in a sparse tree by using a numeric prefix to @kbd{C-c / t}. For example, to see all things 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. @cindex property, ORDERED The structure of Org files (hierarchy and lists) makes it easy to define TODO dependencies. Usually, a parent TODO task should not be marked DONE until -all subtasks (defined as children tasks) are marked as DONE. And sometimes +all subtasks (defined as children tasks) are marked as DONE@. And sometimes there is a logical sequence to a number of (sub)tasks, so that one task cannot be acted upon before all siblings above it are done. If you customize the variable @code{org-enforce-todo-dependencies}, Org will block entries -from changing state to DONE while they have children that are not DONE. +from changing state to DONE while they have children that are not DONE@. Furthermore, if an entry has a property @code{ORDERED}, each of its children -will be blocked until all earlier siblings are marked DONE. Here is an +will be blocked until all earlier siblings are marked DONE@. Here is an example: @example @@ -4194,7 +4194,7 @@ when you are using both @code{org-log-done} and state change logging. However, it will never prompt for two notes---if you have configured both, the state change recording note will take precedence and cancel the @samp{Closing Note}.}, and that a note is recorded when switching to -WAIT or CANCELED. The setting for WAIT is even more special: the +WAIT or CANCELED@. The setting for WAIT is even more special: the @samp{!} after the slash means that in addition to the note taken when entering the state, a timestamp should be recorded when @i{leaving} the WAIT state, if and only if the @i{target} state does not configure @@ -5265,7 +5265,7 @@ values. @noindent The first column, @samp{%25ITEM}, means the first 25 characters of the -item itself, i.e.@: of the headline. You probably always should start the +item itself, i.e., of the headline. You probably always should start the column definition with the @samp{ITEM} specifier. The other specifiers create columns @samp{Owner} with a list of names as allowed values, for @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 single plus or minus, the date is always relative to today. With a double plus or minus, it is relative to the default date. If instead of a single letter, you use the abbreviation of day name, the date will be -the Nth such day, e.g.@: +the Nth such day, e.g.: @example +0 @result{} today @@ -5694,7 +5694,7 @@ read the docstring of the variable You can specify a time range by giving start and end times or by giving a start time and a duration (in HH:MM format). Use one or two dash(es) as the separator in the former case and use '+' as the separator in the latter -case, e.g.@: +case, e.g.: @example 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 addition, the agenda for @emph{today} will carry a warning about the approaching or missed deadline, starting @code{org-deadline-warning-days} before the due date, and continuing -until the entry is marked DONE. An example: +until the entry is marked DONE@. An example: @example *** TODO write article about the Earth for the Guide @@ -5827,10 +5827,10 @@ date. @vindex org-agenda-skip-scheduled-if-done The headline will be listed under the given date@footnote{It will still -be listed on that date after it has been marked DONE. If you don't like +be listed on that date after it has been marked DONE@. If you don't like this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In addition, a reminder that the scheduled date has passed will be present -in the compilation for @emph{today}, until the entry is marked DONE, i.e.@: +in the compilation for @emph{today}, until the entry is marked DONE, i.e., the task will automatically be forwarded until completed. @example @@ -5919,7 +5919,7 @@ Sparse tree for deadlines and scheduled items after a given date. @end table Note that @code{org-schedule} and @code{org-deadline} supports -setting the date by indicating a relative time: e.g. +1d will set +setting the date by indicating a relative time: e.g., +1d will set the date to the next day after today, and --1w will set the date to the previous week before any current timestamp. @@ -6488,7 +6488,7 @@ trees to an archive file keeps the system compact and fast. * Capture:: Capturing new stuff * Attachments:: Add files to tasks * RSS Feeds:: Getting input from RSS feeds -* Protocols:: External (e.g.@: Browser) access to Emacs and Org +* Protocols:: External (e.g., Browser) access to Emacs and Org * Refiling notes:: Moving a tree from one place to another * Archiving:: What to do with finished projects @end menu @@ -7676,7 +7676,7 @@ commands}. @cindex Boolean logic, for tag/property searches A search string can use Boolean operators @samp{&} for AND and @samp{|} for -OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently +OR@. @samp{&} binds more strongly than @samp{|}. Parentheses are currently not implemented. Each element in the search is either a tag, a regular expression matching tags, or an expression like @code{PROPERTY OPERATOR 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 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry. So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword -DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not +DONE@. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc. The ITEM special property cannot currently be used in tags/property 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 assumed to be date/time specifications in the standard Org way, and the comparison will be done accordingly. Special values that will be recognized are @code{"<now>"} for now (including time), and @code{"<today>"}, and -@code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time +@code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year, respectively, can be used. @@ -7784,7 +7784,7 @@ tags/property part of the search string (which may include several terms connected with @samp{|}) with a @samp{/} and then specify a Boolean expression just for TODO keywords. The syntax is then similar to that for tags, but should be applied with care: for example, a positive selection on -several TODO keywords cannot meaningfully be combined with boolean AND. +several TODO keywords cannot meaningfully be combined with boolean AND@. However, @emph{negative selection} combined with AND can be meaningful. To make sure that only lines are checked that actually have any TODO keyword (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 covered by the current agenda view. The initial setting for this mode in new agenda buffers can be set with the variable @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument -when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show +when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show contributions from entries that are hidden by agenda filtering@footnote{Only tags filtering will be respected here, effort filtering is ignored.}. See 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 numbered. If you use a @code{+n} switch, the numbering from the previous numbered snippet will be continued in the current one. In literal examples, Org will interpret strings like @samp{(ref:name)} as labels, and use them as -targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name +targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name enclosed in single parenthesis). In HTML, hovering the mouse over such a link will remote-highlight the corresponding code line, which is kind of cool. @@ -9408,7 +9408,7 @@ include your @file{.emacs} file, you could use: #+INCLUDE: "~/.emacs" src emacs-lisp @end example @noindent -The optional second and third parameter are the markup (e.g.@: @samp{quote}, +The optional second and third parameter are the markup (e.g., @samp{quote}, @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the language for formatting the contents. The markup is optional; if it is not 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. #+AUTHOR: the author (default taken from @code{user-full-name}) #+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} #+EMAIL: his/her email address (default from @code{user-mail-address}) -#+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag -#+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag -#+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language}) +#+DESCRIPTION: the page description, e.g., for the XHTML meta tag +#+KEYWORDS: the page keywords, e.g., for the XHTML meta tag +#+LANGUAGE: language for HTML, e.g., @samp{en} (@code{org-export-default-language}) #+TEXT: Some descriptive text to be inserted at the beginning. #+TEXT: Several lines may be given. #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... -#+BIND: lisp-var lisp-val, e.g.@:: @code{org-export-latex-low-levels itemize} +#+BIND: lisp-var lisp-val, e.g., @code{org-export-latex-low-levels itemize} @r{You need to confirm using these, or configure @code{org-export-allow-BIND}} #+LINK_UP: the ``up'' link of an exported page #+LINK_HOME: the ``home'' link of an exported page @@ -9972,11 +9972,11 @@ separate Emacs process@footnote{To make this behavior the default, customize the variable @code{org-export-run-in-background}.}. @orgcmd{C-c C-e v,org-export-visible} Like @kbd{C-c C-e}, but only export the text that is currently visible -(i.e.@: not hidden by outline visibility). +(i.e., not hidden by outline visibility). @orgcmd{C-u C-u C-c C-e,org-export} @vindex org-export-run-in-background Call the exporter, but reverse the setting of -@code{org-export-run-in-background}, i.e.@: request background processing if +@code{org-export-run-in-background}, i.e., request background processing if not set, or force processing in the current Emacs process if set. @end table @@ -9987,7 +9987,7 @@ not set, or force processing in the current Emacs process if set. @cindex UTF-8 export ASCII export produces a simple and very readable version of an Org mode -file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file +file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file with special characters and symbols available in these encodings. @cindex region, active @@ -10179,7 +10179,7 @@ All lines between these markers are exported literally @cindex links, in HTML export @cindex internal links, in HTML export @cindex external links, in HTML export -Internal links (@pxref{Internal links}) will continue to work in HTML. This +Internal links (@pxref{Internal links}) will continue to work in HTML@. This includes automatic links created by radio targets (@pxref{Radio targets}). Links to external files will still work if the target file is on 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. @cindex DocBook recursive sections DocBook exporter exports Org files as articles using the @code{article} -element in DocBook. Recursive sections, i.e.@: @code{section} elements, are +element in DocBook. Recursive sections, i.e., @code{section} elements, are used in exported articles. Top level headlines in Org files are exported as top level sections, and lower level headlines are exported as nested sections. The entire structure of Org files will be exported completely, no @@ -11996,7 +11996,7 @@ time. @subsection Export of properties -The exporter also takes TODO state information into consideration, i.e.@: if a +The exporter also takes TODO state information into consideration, i.e., if a task is marked as done it will have the corresponding attribute in TaskJuggler (@samp{complete 100}). Also it will export any property on a task resource or resource node which is known to TaskJuggler, such as @@ -12048,7 +12048,7 @@ examples should illustrate this: @subsection Reports @vindex org-export-taskjuggler-default-reports -TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource +TaskJuggler can produce many kinds of reports (e.g., gantt chart, resource allocation, etc). The user defines what kind of reports should be generated for a project in the TaskJuggler file. The exporter will automatically insert 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 in the standard iCalendar format. If you also want to have TODO entries included in the export, configure the variable @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT, -and TODO items as VTODO. It will also create events from deadlines that are +and TODO items as VTODO@. It will also create events from deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO items will be used to set the start and due dates for the TODO entry@footnote{See the variables @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: @lisp ("project-name" :property value :property value ...) - @r{i.e.@: a well-formed property list with alternating keys and values} + @r{i.e., a well-formed property list with alternating keys and values} @r{or} ("project-name" :components ("project-name" "project-name" ...)) @@ -12452,7 +12452,7 @@ something like @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link becomes a link to @file{foo.html}. In this way, you can interlink the pages of your "org web" project and the links will work as expected when -you publish them to HTML. If you also publish the Org source file and want +you publish them to HTML@. If you also publish the Org source file and want to link to that, use an @code{http:} link instead of a @code{file:} link, because @code{file:} links are converted to link to the corresponding @file{html} file. @@ -12704,7 +12704,7 @@ This may be necessary in particular if files include other files via @cindex source code, working with Source code can be included in Org mode documents using a @samp{src} block, -e.g.@: +e.g.: @example #+BEGIN_SRC emacs-lisp @@ -12852,7 +12852,7 @@ variable @code{org-src-fontify-natively}. It is possible to export the @emph{code} of code blocks, the @emph{results} of code block evaluation, @emph{both} the code and the results of code block evaluation, or @emph{none}. For most languages, the default exports code. -However, for some languages (e.g.@: @code{ditaa}) the default exports the +However, for some languages (e.g., @code{ditaa}) the default exports the results of code block evaluation. For information on exporting code block bodies, see @ref{Literal examples}. @@ -13737,7 +13737,7 @@ then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets the value of the Emacs variable @code{default-directory}. When using @code{:dir}, you should supply a relative path for file output -(e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which +(e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which case that path will be interpreted relative to the default directory. 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 @item @code{yes} Column names are removed and reapplied as with @code{nil} even if the table -does not ``look like'' it has column names (i.e.@: the second row is not an +does not ``look like'' it has column names (i.e., the second row is not an hline) @end itemize @@ -14219,7 +14219,7 @@ variable indexing @xref{var, Indexable variable values}. @subsubsection @code{:shebang} Setting the @code{:shebang} header argument to a string value -(e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the +(e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the first line of any tangled file holding the code block, and the file permissions of the tangled file are set to make it executable. @@ -14604,7 +14604,7 @@ option keyword is already complete, pressing @kbd{M-@key{TAB}} again will insert example settings for this keyword. @item In the line after @samp{#+STARTUP: }, complete startup keywords, -i.e.@: valid keys for this line. +i.e., valid keys for this line. @item Elsewhere, complete dictionary words using Ispell. @end itemize @@ -14657,7 +14657,7 @@ additional details. @vindex org-speed-commands-user Single keys can be made to execute commands when the cursor is at the -beginning of a headline, i.e.@: before the first star. Configure the variable +beginning of a headline, i.e., before the first star. Configure the variable @code{org-use-speed-commands} to activate this feature. There is a pre-defined list of commands, and you can add more such commands using the 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. @item #+SETUPFILE: file This line defines a file that holds more in-buffer setup. Normally this is entirely ignored. Only when the buffer is parsed for option-setting lines -(i.e.@: when starting Org mode for a file, when pressing @kbd{C-c C-c} in a +(i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a settings line, or when exporting), then the contents of this file are parsed as if they had been included in the buffer. In particular, the file can be any other Org mode file with internal setup. You can visit the file the @@ -15168,7 +15168,7 @@ example using the color @code{grey90} on a white background. Things become cleaner still if you skip all the even levels and use only odd levels 1, 3, 5..., effectively adding two stars to go from one outline level to the next@footnote{When you need to specify a level for a property search -or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this +or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this way we get the outline view shown at the beginning of this section. In order to make the structure editing and export commands handle this convention correctly, configure the variable @code{org-odd-levels-only}, or set this on @@ -15259,7 +15259,7 @@ names for natural constants or units. Instead of defining your own constants in the variable @code{org-table-formula-constants}, install the @file{constants} package which defines a large number of constants and units, and lets you use unit prefixes like @samp{M} for -@samp{Mega}, etc@. You will need version 2.0 of this package, available +@samp{Mega}, etc. You will need version 2.0 of this package, available at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for the function @code{constants-get}, which has to be autoloaded in your setup. See the installation instructions in the file @@ -15626,7 +15626,7 @@ the link description when the link is later inserted into an Org buffer with @kbd{C-c C-l}. When it makes sense for your new link type, you may also define a function -@code{org-PREFIX-complete-link} that implements special (e.g.@: completion) +@code{org-PREFIX-complete-link} that implements special (e.g., completion) support for inserting such a link with @kbd{C-c C-l}. Such a function should not accept any arguments, and return the full link with prefix. @@ -15832,9 +15832,9 @@ When you are done, press @kbd{C-c C-c} in the table to get the converted table inserted between the two marker lines. Now let's assume you want to make the table header by hand, because you -want to control how columns are aligned, etc@. In this case we make sure +want to control how columns are aligned, etc. In this case we make sure that the table translator skips the first 2 lines of the source -table, and tell the command to work as a @i{splice}, i.e.@: to not produce +table, and tell the command to work as a @i{splice}, i.e., to not produce header and footer commands of the target table: @example @@ -15917,7 +15917,7 @@ hands processing over to the generic translator. Here is the entire code: As you can see, the properties passed into the function (variable @var{PARAMS}) are combined with the ones newly defined in the function -(variable @var{PARAMS2}). The ones passed into the function (i.e.@: the +(variable @var{PARAMS2}). The ones passed into the function (i.e., the ones set by the @samp{ORGTBL SEND} line) take precedence. So if you would like to use the @LaTeX{} translator, but wanted the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you could just @@ -16086,7 +16086,7 @@ using @code{org-agenda-skip-function}. Let's say you want to produce a list of projects that contain a WAITING tag anywhere in the project tree. Let's further assume that you have marked all tree headings that define a project with the TODO keyword -PROJECT. In this case you would run a TODO search for the keyword +PROJECT@. In this case you would run a TODO search for the keyword PROJECT, but skip the match unless there is a WAITING tag anywhere in the subtree belonging to the project line. @@ -16179,7 +16179,7 @@ line in Emacs batch mode. This extracted information can be sent directly to a printer, or it can be read by a program that does further processing of the data. The first of these commands is the function @code{org-batch-agenda}, that produces an agenda view and sends it as -ASCII text to STDOUT. The command takes a single string as parameter. +ASCII text to STDOUT@. The command takes a single string as parameter. If the string has length 1, it is used as a key to one of the commands you have configured in @code{org-agenda-custom-commands}, basically any 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 @vindex org-use-property-inheritance @findex org-insert-property-drawer @defun org-entry-get pom property &optional inherit -Get value of PROPERTY for entry at point-or-marker POM. By default, +Get value of PROPERTY for entry at point-or-marker POM@. By default, this only looks at properties defined locally in the entry. If INHERIT is non-nil and the entry does not have the property, then also check higher levels of the hierarchy. If INHERIT is the symbol @@ -16317,7 +16317,7 @@ Insert a property drawer for the current entry. Also @end defun @defun org-entry-put-multivalued-property pom property &rest values -Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of +Set PROPERTY at point-or-marker POM to VALUES@. VALUES should be a list of strings. They will be concatenated, with spaces as separators. @end defun @@ -16374,7 +16374,7 @@ does not need to preserve point. After evaluation, the cursor will be moved to the end of the line (presumably of the headline of the processed entry) and search continues from there. Under some circumstances, this may not produce the wanted results. For example, -if you have removed (e.g.@: archived) the current (sub)tree it could +if you have removed (e.g., archived) the current (sub)tree it could mean that the next entry will be skipped entirely. In such cases, you can specify the position from where search should continue by making 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.'' @ifnottex @top PCL-CVS -This manual describes PCL-CVS, the GNU Emacs front-end to CVS. It +This manual describes PCL-CVS, the GNU Emacs front-end to CVS@. It is nowhere near complete, so you are advised to use @kbd{M-x customize-group RET pcl-cvs @key{RET}} and to look at the documentation strings of the various commands and major modes for further information. @@ -202,7 +202,7 @@ and cleanups. the build and installation procedure. @item -@email{woods@@weird.com, Greg A.@: Woods} contributed code to implement +@email{woods@@weird.com, Greg A. Woods} contributed code to implement the use of per-file diff buffers, and vendor join diffs with emerge and ediff, as well as various and sundry bug fixes and cleanups. @@ -236,7 +236,7 @@ there would be no new releases of PCL-CVS. @cindex Sample session This document assumes that you know what CVS is, and that you at least -know the fundamental concepts of CVS. If that is not the case, you +know the fundamental concepts of CVS@. If that is not the case, you should read the CVS documentation. Type @kbd{info -f cvs} or @kbd{man cvs}. @@ -476,7 +476,7 @@ This chapter describes all the commands that you can use in PCL-CVS. @end iftex @ifnottex The nodes in this menu contains explanations about all the commands that -you can use in PCL-CVS. They are grouped together by type. +you can use in PCL-CVS@. They are grouped together by type. @end ifnottex @menu @@ -568,7 +568,7 @@ argument to the command (e.g., by typing @cindex Command-line options to CVS This section describes the convention used by nearly all PCL-CVS -commands for setting optional flags sent to CVS. A single @kbd{C-u} +commands for setting optional flags sent to CVS@. A single @kbd{C-u} prefix argument is used to cause the command to prompt for flags to be used for the current invocation of the command only. Two @kbd{C-u} prefix 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} commands will use the previously prevailing flags. As a second example, say you are about to perform a diff and want to see -the result in unified diff format, i.e. you'd like to pass the flag +the result in unified diff format, i.e., you'd like to pass the flag @samp{-u} to both @samp{cvs diff} and @samp{diff}. You'd also like all subsequent diffs to use this flag. You can type @kbd{C-u C-u = -u @key{RET}} 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 selected files has changed between the first step and the last. You can change this last detail with @code{log-edit-confirm}. -As for the difference between @kbd{c} (i.e. @code{cvs-mode-commit}) and -@kbd{C} (i.e. @code{cvs-mode-commit-setup}) is that the first gets you +As for the difference between @kbd{c} (i.e., @code{cvs-mode-commit}) and +@kbd{C} (i.e., @code{cvs-mode-commit-setup}) is that the first gets you straight to @samp{*cvs-commit*} without erasing it or changing anything to its content, while the second first erases @samp{*cvs-commit*} 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. @table @asis @item Unexpected output from CVS -Unexpected output from CVS may confuse PCL-CVS. It will create +Unexpected output from CVS may confuse PCL-CVS@. It will create warning messages in the @samp{*cvs*} buffer alerting you to any parse errors. If you get these messages, please send a bug report to the email 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. This document assumes that you have already obtained and installed them and that you are familiar with its basic functions. -By default, PGG uses GnuPG. If you are new to such a system, I +By default, PGG uses GnuPG@. If you are new to such a system, I recommend that you should look over the GNU Privacy Handbook (GPH) which is available at @uref{http://www.gnupg.org/documentation/}. When using GnuPG, we recommend the use of the @code{gpg-agent} -program, which is distributed with versions 2.0 and later of GnuPG. +program, which is distributed with versions 2.0 and later of GnuPG@. This is a daemon to manage private keys independently from any protocol, and provides the most secure way to input and cache your 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. Use the command @kbd{M-x irc} to connect using the defaults. @xref{Configuration}, if you want to change the defaults. -Use @kbd{C-u M-x irc} if you don't want to use the defaults, eg. if you +Use @kbd{C-u M-x irc} if you don't want to use the defaults, e.g., if you want to connect to a different network, or connect to the same network using a different nick. This will prompt you for four things: @@ -514,7 +514,7 @@ like @code{rcirc-default-nick}. @cindex full name @cindex real name @cindex surname -This variable is used to set your ``real name'' on IRC. It defaults +This variable is used to set your ``real name'' on IRC@. It defaults to the name returned by @code{user-full-name}. If you want to hide your full name, you might want to set it to some pseudonym. 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 for Emacs Lisp files and info files. Also, enter the name of your Emacs executable (usually either @samp{emacs} or @samp{xemacs}). -Then, type +Then, type @example make @@ -353,7 +353,7 @@ PostScript or HTML files. @RefTeX{} needs to access all files which are part of a multifile document, and the BibTeX database files requested by the @code{\bibliography} command. To find these files, @RefTeX{} will -require a search path, i.e. a list of directories to check. Normally +require a search path, i.e., a list of directories to check. Normally this list is stored in the environment variables @code{TEXINPUTS} and @code{BIBINPUTS} which are also used by @RefTeX{}. However, on some systems these variables do not contain the full search path. If @@ -736,14 +736,14 @@ keymap @code{reftex-toc-map} may be used. @cindex Table of contents buffer, recentering @kindex C-c - If you call @code{reftex-toc} while the @file{*toc*} buffer already -exists, the cursor will immediately jump to the right place, i.e. the +exists, the cursor will immediately jump to the right place, i.e., the section from which @code{reftex-toc} was called will be highlighted. The command @kbd{C-c -} (@code{reftex-toc-recenter}) will only redisplay the @file{*toc*} buffer and highlight the correct line without actually selecting the @file{*toc*} window. This can be useful to quickly find out where in the document you currently are. You can also automate this by asking RefTeX to keep track of your current editing position in the -TOC. The TOC window will then be updated whenever you stop typing for +TOC@. The TOC window will then be updated whenever you stop typing for more than @code{reftex-idle-time} seconds. By default this works only with the dedicated @file{*TOC*} frame. But you can also force automatic recentering of the TOC window on the current frame with @@ -894,7 +894,7 @@ start a selection process and finally insert the complete @vindex reftex-ref-macro-prompt First, you can select which reference macro you want to use, -e.g. @samp{\ref} or @samp{\pageref}. Later in the process you have +e.g., @samp{\ref} or @samp{\pageref}. Later in the process you have another chance to make this selection and you can therefore disable this step by customizing @code{reftex-ref-macro-prompt} if you find it too intrusive. @xref{Reference Styles}. @@ -1021,7 +1021,7 @@ Cycle forward through active reference macros. The selected macro is displayed by the @samp{S<...>} indicator in the mode line of the selection buffer. This mechanism comes in handy if you are using @LaTeX{} packages like @code{varioref} or @code{fancyref} and want to -use the special referencing macros they provide (e.g. @code{\vref} or +use the special referencing macros they provide (e.g., @code{\vref} or @code{\fref}) instead of @code{\ref}. @item V @@ -1102,7 +1102,7 @@ keymap @code{reftex-select-label-map} may be used. @vindex reftex-label-alist-builtin @RefTeX{} needs to be aware of the environments which can be referenced -with a label (i.e. which carry their own counters). By default, @RefTeX{} +with a label (i.e., which carry their own counters). By default, @RefTeX{} recognizes all labeled environments and macros discussed in @cite{The @LaTeX{} Companion by Goossens, Mittelbach & Samarin, Addison-Wesley 1994.}. These are: @@ -1257,7 +1257,7 @@ to be used like this: So we need to tell @RefTeX{} that @code{theorem} and @code{axiom} are new labeled environments which define their own label categories. We can -either use Lisp to do this (e.g. in @file{.emacs}) or use the custom +either use Lisp to do this (e.g., in @file{.emacs}) or use the custom library. With Lisp it would look like this @lisp @@ -1712,7 +1712,7 @@ extra step for reference macro selection, you can disable it by customizing @code{reftex-ref-macro-prompt} and relying only on the selection facilities provided in the last step. -In the last step, i.e. the label selection, two key bindings are +In the last step, i.e., the label selection, two key bindings are provided to set the reference macro. Type @key{v} in order to cycle forward through the list of available macros or @key{V} to cycle 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 @code{reftex-ref-style-alist} to fit your liking. For each entry in @code{reftex-ref-style-alist} a function with the name -@code{reftex-<package>-<macro>} (e.g. @code{reftex-varioref-vref}) will +@code{reftex-<package>-<macro>} (e.g., @code{reftex-varioref-vref}) will be created automatically by @RefTeX{}. These functions can be used instead of @kbd{C-c )} and provide an alternative way of having your favorite referencing macro preselected and if cycling through the macros -seems inconvenient to you.@footnote{You could e.g. bind +seems inconvenient to you.@footnote{You could, e.g., bind @code{reftex-varioref-vref} to @kbd{C-c v} and @code{reftex-fancyref-fref} to @kbd{C-c f}.} @@ -3059,7 +3059,7 @@ Specify the full search path directly in @RefTeX{}'s variables. @item Some @TeX{} systems provide stand-alone programs to do the file search just -like @TeX{} and @BibTeX{}. E.g. Thomas Esser's @code{teTeX} uses the +like @TeX{} and @BibTeX{}. E.g., Thomas Esser's @code{teTeX} uses the @code{kpathsearch} library which provides the command @code{kpsewhich} to search for files. @RefTeX{} can be configured to use this program. Note that the exact syntax of the @code{kpsewhich} @@ -3353,7 +3353,7 @@ association with the @code{\documentclass} and @code{\usepackage} commands of a document (@pxref{Style Files,,,auctex}). Support for @RefTeX{} in such a style file is useful when the @LaTeX{} style defines macros or environments connected with labels, citations, or the -index. Many style files (e.g. @file{amsmath.el} or @file{natbib.el}) +index. Many style files (e.g., @file{amsmath.el} or @file{natbib.el}) distributed with @AUCTeX{} already support @RefTeX{} in this way. @@ -3541,7 +3541,7 @@ document. @xref{AUCTeX}. @cindex @code{iso-cvt}, Emacs package @cindex Emacs packages, @code{iso-cvt} When using packages which make the buffer representation of a file -different from its disk representation (e.g. x-symbol, isotex, +different from its disk representation (e.g., x-symbol, isotex, iso-cvt) you may find that @RefTeX{}'s parsing information sometimes reflects the disk state of a file. This happens only in @emph{unvisited} parts of a multifile document, because @RefTeX{} visits these files @@ -3555,7 +3555,7 @@ this: @vindex reftex-keep-temporary-buffers @code{(setq reftex-keep-temporary-buffers t)}@* This implies that @RefTeX{} will load all parts of a multifile -document into Emacs (i.e. there won't be any temporary buffers). +document into Emacs (i.e., there won't be any temporary buffers). @item @vindex reftex-initialize-temporary-buffers @code{(setq reftex-initialize-temporary-buffers t)}@* @@ -3573,7 +3573,7 @@ See also the variable @code{reftex-refontify-context}. @cindex @code{pf}, LaTeX package @cindex LaTeX packages, @code{pf} Some packages use an additional argument to a @code{\begin} macro -to specify a label. E.g. Lamport's @file{pf.sty} uses both +to specify a label. E.g., Lamport's @file{pf.sty} uses both @example \step@{@var{label}@}@{@var{claim}@} and \begin@{step+@}@{@var{label}@} @var{claim} @@ -3932,7 +3932,7 @@ commands always select the nearest entry with the correct new level. @end defopt @defopt reftex-toc-max-level -The maximum level of toc entries which will be included in the TOC. +The maximum level of toc entries which will be included in the TOC@. Section headings with a bigger level will be ignored. In RefTeX, chapters are level 1, sections level 2 etc. This variable can be 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, 1000 means to get text after the last macro argument. @item If a string, use as regexp to search @emph{backward} from the label. -Context is then the text following the end of the match. E.g. setting +Context is then the text following the end of the match. E.g., setting this to @samp{\\caption[[@{]} will use the caption in a figure or table environment. @samp{\\begin@{eqnarray@}\|\\\\} works for eqnarrays. @@ -4166,7 +4166,7 @@ context: Label context is used in two ways by @RefTeX{}: For display in the label menu, and to derive a label string. If you want to use a different method for each of these, specify them as a dotted pair. -E.g. @code{(nil . t)} uses the text after the label (@code{nil}) for +E.g., @code{(nil . t)} uses the text after the label (@code{nil}) for display, and text from the default position (@code{t}) to derive a label string. This is actually used for section labels. @@ -4237,13 +4237,13 @@ Possible values for this option are: t @r{This means to trust any label prefixes found.} regexp @r{If a regexp, only prefixes matched by the regexp are trusted.} list @r{List of accepted prefixes, as strings. The colon is part of} - @r{the prefix, e.g. ("fn:" "eqn:" "item:").} + @r{the prefix, e.g., ("fn:" "eqn:" "item:").} nil @r{Never trust a label prefix.} @end example The only disadvantage of using this feature is that the label context displayed in the label selection buffer along with each label is simply some text after the label definition. This is no problem if you -place labels keeping this in mind (e.g. @i{before} the equation, @i{at +place labels keeping this in mind (e.g., @i{before} the equation, @i{at the beginning} of a fig/tab caption ...). Anyway, it is probably best to use the regexp or the list value types to fine-tune this feature. For example, if your document contains thousands of footnotes with @@ -4446,7 +4446,7 @@ Controls if @code{reftex-reference} prompts for the reference macro. If non-@code{nil}, should be a function which produces the string to insert as a reference. Note that the insertion format can also be changed with @code{reftex-label-alist}. This hook also is used by the -special commands to insert e.g. @code{\vref} and @code{\fref} +special commands to insert, e.g., @code{\vref} and @code{\fref} references, so even if you set this, your setting will be ignored by the special commands. The function will be called with three arguments, the @var{label}, the @var{default format} which normally is @@ -4760,7 +4760,7 @@ The default can be selected with @key{RET} during selection or completion. Valid values of this variable are: @example nil @r{Do not provide a default index} -"tag" @r{The default index tag given as a string, e.g. "idx"} +"tag" @r{The default index tag given as a string, e.g., "idx"} last @r{The last used index tag will be offered as default} @end example @end defopt @@ -4770,7 +4770,7 @@ Format of index entries when copied from inside math mode. When @code{reftex-index-selection-or-word} is executed inside @TeX{} math mode, the index key copied from the buffer is processed with this format string through the @code{format} function. This can be used to add the -math delimiters (e.g. @samp{$}) to the string. Requires the +math delimiters (e.g., @samp{$}) to the string. Requires the @file{texmathp.el} library which is part of @AUCTeX{}. @end defopt @@ -5170,7 +5170,7 @@ Never refontify. @item t Always refontify. @item 1 -Refontify when necessary, e.g. with old versions of the x-symbol +Refontify when necessary, e.g., with old versions of the x-symbol package. @end table 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 the current region. @item New option @code{reftex-toc-split-windows-fraction} to set the size of -the window used by the TOC. This makes the old variable +the window used by the TOC@. This makes the old variable @code{reftex-toc-split-windows-horizontally-fraction} obsolete. @item A dedicated frame can show the TOC with the current section @@ -5812,7 +5812,7 @@ Fixed bug with AUCTeX @code{TeX-master}. @itemize @bullet @item The selection now uses a recursive edit, much like minibuffer input. -This removes all restrictions during selection. E.g. you can now +This removes all restrictions during selection. E.g., you can now switch buffers at will, use the mouse etc. @item New option @code{reftex-highlight-selection}. @@ -5888,7 +5888,7 @@ When no BibTeX database files are specified, citations can also use @noindent @b{Version 3.11} @itemize @bullet @item -Fixed bug which led to naked label in (e.g.) footnotes. +Fixed bug which led to naked label in (e.g.@:) footnotes. @item Added scroll-other-window functions to RefTeX-Select. @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 this mode is not trying to replace. Rather, it's how that data gets there that's the question. Most of the time, we just want to say "Remember so-and-so's phone number, or that I have to buy dinner for the -cats tonight." That's the FACT. How it's stored is really the +cats tonight." That's the FACT@. How it's stored is really the computer's problem. But at this point in time, it's most definitely also the user's problem, and sometimes so laboriously so that people 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. @cindex attribute, attributing Typical usage is as follows. You want to reply or followup to a message -in your MUA. You will probably hit @kbd{r} (i.e., ``reply'') or @kbd{f} +in your MUA@. You will probably hit @kbd{r} (i.e., ``reply'') or @kbd{f} (i.e., ``forward'') to begin composing the reply. In response, the MUA will create a reply buffer and initialize the outgoing mail headers 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 by calling a hook variable to which Supercite's top-level function @code{sc-cite-original} has been added. When @code{sc-cite-original} is executed, the original message must be set up in a very specific way, -but this is handled automatically by the MUA. @xref{Hints to MUA +but this is handled automatically by the MUA@. @xref{Hints to MUA Authors}.@refill @cindex info alist @@ -202,7 +202,7 @@ When the original message is cited by @code{sc-cite-original}, it will cited text and want to re-fill it, you must use an add-on package such as @cite{filladapt} or @cite{gin-mode}. These packages can recognize Supercited text and will fill them appropriately. Emacs's built-in -filling routines, e.g@. @code{fill-paragraph}, do not recognize cited +filling routines, e.g., @code{fill-paragraph}, do not recognize cited text and will not re-fill them properly because it cannot guess the @code{fill-prefix} being used. @xref{Post-yank Formatting Commands}, for details.@refill @@ -213,7 +213,7 @@ beautifications on the cited original text, maintaining consistent and informative citations throughout. Supercite tries to be as configurable as possible to allow for a wide range of personalized citation styles, but it is also immediately useful with the default configuration, once -it has been properly connected to your MUA. @xref{Getting Connected}, +it has been properly connected to your MUA@. @xref{Getting Connected}, for more details.@refill @node Citations @@ -388,7 +388,7 @@ change @code{sc-citation-root-regexp} you should always also change @dfn{Mail header information keys} are nuggets of information that Supercite extracts from the various mail headers of the original -message, placed in the reply buffer by the MUA. Information is kept in +message, placed in the reply buffer by the MUA@. Information is kept in the @dfn{Info Alist} as key-value pairs, and can be retrieved for use in various places within Supercite, such as in header rewrite functions and attribution selection. Other bits of data, composed and created by @@ -532,7 +532,7 @@ beginning at zero. @cindex header rewrite functions, built-in Below are examples of the various built-in header rewrite functions. -Please note the following:@: first, the text which appears in the +Please note the following: first, the text which appears in the examples below as @var{infokey} indicates that the corresponding value of the info key from the info alist will be inserted there. (@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: @example @group -(@var{infokey} ((@var{regexp} @. @var{attribution}) - (@var{regexp} @. @var{attribution}) +(@var{infokey} ((@var{regexp} . @var{attribution}) + (@var{regexp} . @var{attribution}) (@dots{}))) @end group @end example @@ -1240,7 +1240,7 @@ post-selection hook, the local variables @code{attribution} and variables in your hook functions, you change the attribution and citation strings used by Supercite. One possible use of this would be to override any automatically derived attribution string when it is only -one character long; e.g. you prefer to use @code{"initials"} but the +one character long; e.g., you prefer to use @code{"initials"} but the author only has one name.@refill @node Author Names @@ -1284,7 +1284,7 @@ is used for this purpose. As implied by its name, this variable is an association list, where each element is a cons cell of the form: @example -(@var{regexp} @. @var{position}) +(@var{regexp} . @var{position}) @end example @noindent @@ -1295,7 +1295,7 @@ Thus to strip out all titles of ``Dr.'', ``Mr.'', etc. from the name, @code{sc-name-filter-alist} would have an entry such as: @example -("^\\(Mr\\|Mrs\\|Ms\\|Dr\\)[.]?$" @. 0) +("^\\(Mr\\|Mrs\\|Ms\\|Dr\\)[.]?$" . 0) @end example @noindent @@ -1486,8 +1486,8 @@ consulted to find the frame to use (@code{sc-cite-frame-alist}, respectively). These frames can contain alists of the form: @example -((@var{infokey} (@var{regexp} @. @var{frame}) (@var{regexp} @. @var{frame}) @dots{}) - (@var{infokey} (@var{regexp} @. @var{frame}) (@var{regexp} @. @var{frame}) @dots{}) +((@var{infokey} (@var{regexp} . @var{frame}) (@var{regexp} . @var{frame}) @dots{}) + (@var{infokey} (@var{regexp} . @var{frame}) (@var{regexp} . @var{frame}) @dots{}) (@dots{})) @end example @@ -1819,7 +1819,7 @@ steps: @item Insert the original message, including the mail headers into the reply buffer. At this point you should not modify the raw text in any way -(except for any necessary decoding, e.g. of quoted-printable text), and +(except for any necessary decoding, e.g., of quoted-printable text), and you should place all the original headers into the body of the reply. This means that many of the mail headers will be duplicated, one copy 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 which auxiliary modes are enabled; the defaults are SemanticDB mode (@pxref{SemanticDB}) and Global Semantic Idle Scheduler mode (@pxref{Idle Scheduler}). You can also toggle the auxiliary minor -modes separately, using their mode functions (e.g. @kbd{M-x +modes separately, using their mode functions (e.g., @kbd{M-x semanticdb-minor-mode}), or via the @samp{Development} menu. The various auxiliary minor modes are described in the following sections. @@ -105,7 +105,7 @@ valid mode symbols are: Semantic mode provides a number of commands for navigating, querying, and editing source code in a language-aware manner. These commands generally act on @dfn{tags}, which are the source-code units deemed -``important'' by the present programming language (e.g. functions in +``important'' by the present programming language (e.g., functions in the C programming language). 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 a70bb9c407e..0c50bb2a1e4 100644 --- a/doc/misc/ses.texi +++ b/doc/misc/ses.texi @@ -853,7 +853,7 @@ You can edit the data area, but don't insert or delete any newlines except in the local-variables part, since SES locates things by counting newlines. Use @kbd{C-x C-e} at the end of a line to install your edits into the spreadsheet data structures (this does not update -the print area, use e.g. @kbd{C-c C-l} for that). +the print area, use, e.g., @kbd{C-c C-l} for that). The data area is maintained as an image of spreadsheet data 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. @cindex IMAP When your computer is not always connected to the internet, you must get the mail from the remote mail host using a protocol such as -POP3 or IMAP. POP3 essentially downloads all your mail from the mail +POP3 or IMAP@. POP3 essentially downloads all your mail from the mail host to your computer. The mail is stored in some file on your computer, and again, all your MUA has to do is read mail from the spool. @@ -219,7 +219,7 @@ The following example illustrates what you could put in @cindex user name Most SMTP servers require clients to authenticate themselves before they are allowed to send mail. Authentication usually involves -supplying a user name and password. +supplying a user name and password. If you have not configured anything, then the first time you try to 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}. The process by which the SMTP library authenticates you to the server is known as ``Simple Authentication and Security Layer'' (SASL). There are various SASL mechanisms, and this library supports three of -them: CRAM-MD5, PLAIN, and LOGIN. It tries each of them, in that order, +them: CRAM-MD5, PLAIN, and LOGIN@. It tries each of them, in that order, until one succeeds. The first uses a form of encryption to obscure your password, while the other two do not. diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index 020a6e55833..5d0d943823e 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi @@ -715,7 +715,7 @@ This is another method from the Kerberos suite. It behaves like @option{su}. @cindex plink method This method is mostly interesting for Windows users using the PuTTY -implementation of SSH. It uses @samp{plink -ssh} to log in to the +implementation of SSH@. It uses @samp{plink -ssh} to log in to the remote host. This supports the @samp{-P} argument. @@ -995,7 +995,7 @@ XP, MS Windows Vista, and MS Windows 7. The first directory in the localname must be a share name on the remote host. Remember that the @code{$} character, in which default shares usually end, must be written @code{$$} due to environment variable -substitution in file names. If no share name is given (i.e. remote +substitution in file names. If no share name is given (i.e., remote directory @code{/}), all available shares are listed. Since authorization is done on share level, you will always be @@ -1042,7 +1042,7 @@ name. The connection methods described in this section are based on GVFS @uref{http://en.wikipedia.org/wiki/GVFS}. Via GVFS, the remote -filesystem is mounted locally through FUSE. @value{tramp} uses +filesystem is mounted locally through FUSE@. @value{tramp} uses this local mounted directory internally. The communication with GVFS is implemented via D-Bus messages. @@ -1082,7 +1082,7 @@ FUSE, it also needs the SYNCE-GVFS plugin. @defopt tramp-gvfs-methods This customer option, a list, defines the external methods which -shall be used with GVFS. Per default, these are @option{dav}, +shall be used with GVFS@. Per default, these are @option{dav}, @option{davs}, @option{obex} and @option{synce}. Other possible values are @option{ftp}, @option{sftp} and @option{smb}. @end defopt @@ -2928,7 +2928,7 @@ to @code{nil}, @ref{Filename completion}. Disable version control. If you access remote files which are not under version control, a lot of check operations can be avoided by -disabling VC. This can be achieved by +disabling VC@. This can be achieved by @lisp (setq vc-ignore-dir-regexp @@ -3257,7 +3257,7 @@ local host as @samp{root} user, is possible just by @kbd{C-x C-f @item Use configuration possibilities of your method: -Several connection methods (i.e. the programs used) offer powerful +Several connection methods (i.e., the programs used) offer powerful configuration possibilities (@pxref{Customizing Completion}). In the given case, this could be @file{~/.ssh/config}: diff --git a/doc/misc/url.texi b/doc/misc/url.texi index fdb3ab452f2..1f53ccee353 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. @cindex parsed URI The return value of @code{url-generic-parse-url}, and the argument expected by @code{url-recreate-url}, is a @dfn{parsed URI}: a CL -structure whose slots hold the various components of the URI. +structure whose slots hold the various components of the URI@. @xref{top,the CL Manual,,cl,GNU Emacs Common Lisp Emulation}, for details about CL structures. Most of the other functions in the @code{url} library act on parsed URIs. @@ -154,7 +154,7 @@ details about CL structures. Most of the other functions in the @table @code @item type -The URI scheme (a string, e.g.@: @code{http}). @xref{Supported URL +The URI scheme (a string, e.g., @code{http}). @xref{Supported URL Types}, for a list of schemes that the @code{url} library knows how to process. This slot can also be @code{nil}, if the URI is not fully specified. @@ -190,7 +190,7 @@ component specifies a ``secondary resource'', such as a section of a webpage. @item fullness -This is @code{t} if the URI is fully specified, i.e.@: the +This is @code{t} if the URI is fully specified, i.e., the hierarchical components of the URI (the hostname and/or username and/or password) are preceded by @samp{//}. @end table @@ -239,7 +239,7 @@ percent-encoded in accordance with RFC 3986. @defun url-encode-url url-string This function return a properly URI-encoded version of @var{url-string}. It also performs @dfn{URI normalization}, -e.g.@: converting the scheme component to lowercase if it was +e.g., converting the scheme component to lowercase if it was previously uppercase. @end defun @@ -278,7 +278,7 @@ carriage returns and line feeds, which are normally forbidden in URIs. @chapter Retrieving URLs The @code{url} library defines the following three functions for -retrieving the data specified by a URL. The actual retrieval protocol +retrieving the data specified by a URL@. The actual retrieval protocol depends on the URL's URI scheme, and is performed by lower-level scheme-specific functions. (Those lower-level functions are not documented here, and generally should not be called directly.) @@ -385,7 +385,7 @@ The @code{http} scheme refers to the Hypertext Transfer Protocol. The Its default port is 80. The @code{https} scheme is a secure version of @code{http}, with -transmission via SSL. It is defined in RFC 2069, and its default port +transmission via SSL@. It is defined in RFC 2069, and its default port is 443. When using @code{https}, the @code{url} library performs SSL encryption via the @code{ssl} library, by forcing the @code{ssl} gateway method to be used. @xref{Gateways in general}. @@ -485,7 +485,7 @@ HTTP supports an @samp{OPTIONS} method describing things supported by the URL@. @defun url-http-options url -Returns a property list describing options available for URL. The +Returns a property list describing options available for URL@. The property list members are: @table @code @@ -583,7 +583,7 @@ A @code{mailto} URL specifies an email message to be sent to a given email address. For example, @samp{mailto:foo@@bar.com} specifies sending a message to @samp{foo@@bar.com}. The ``retrieval method'' for such URLs is to open a mail composition buffer in which the -appropriate content (e.g.@: the recipient address) has been filled in. +appropriate content (e.g., the recipient address) has been filled in. As defined in RFC 2368, a @code{mailto} URL has the form @@ -652,7 +652,7 @@ tunneled through SSL and has default port 563. @vindex NNTPSERVER @defopt url-news-server This variable specifies the default news server from which to fetch -news, if no server was specified in the URL. The default value, +news, if no server was specified in the URL@. The default value, @code{nil}, means to use the server specified by the standard environment variable @samp{NNTPSERVER}, or @samp{news} if that 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 VIP. It is recommended that you read nodes on survey and on customization before -you start using VIP. Other nodes may be visited as needed. +you start using VIP@. Other nodes may be visited as needed. Comments and bug reports are welcome. Please send messages to @code{ms@@Sail.Stanford.Edu} if you are outside of Japan and to @code{masahiko@@sato.riec.tohoku.junet} if you are in Japan.@refill -@insertcopying +@insertcopying @end ifnottex @@ -83,7 +83,7 @@ concentrate mainly on differences from Vi, especially features unique to VIP. It is recommended that you read chapters on survey and on customization -before you start using VIP. Other chapters may be used as future +before you start using VIP@. Other chapters may be used as future references. Comments and bug reports are welcome. Please send messages to @@ -263,7 +263,7 @@ emacs mode vi mode insert mode @kindex 032 @kbd{C-z} (@code{vip-change-mode-to-vi}) -You will be in this mode just after you loaded VIP. You can do all +You will be in this mode just after you loaded VIP@. You can do all normal Emacs editing in this mode. Note that the key @kbd{C-z} is globally bound to @code{vip-change-mode-to-vi}. So, if you type @kbd{C-z} in this mode then you will be in vi mode.@refill @@ -688,7 +688,7 @@ Replace. @chapter Vi Commands This chapter describes Vi commands other than Ex commands implemented in -VIP. Except for the last section which discusses insert mode, all the +VIP@. Except for the last section which discusses insert mode, all the commands described in this chapter are to be used in vi mode. @menu @@ -1716,7 +1716,7 @@ character @samp{|}. @end menu @node Ex Command Reference, Customization, Ex Commands, Ex Commands @section Ex Command Reference -In this section we briefly explain all the Ex commands supported by VIP. +In this section we briefly explain all the Ex commands supported by VIP@. Most Ex commands expect @var{address} as their argument, and they use default addresses if they are not explicitly given. In the following, such default addresses will be shown in parentheses. @@ -1875,7 +1875,7 @@ customizing VIP. @node Customizing Constants, Customizing Key Bindings, Customization, Customization @section Customizing Constants An easy way to customize VIP is to change the values of constants used -in VIP. Here is the list of the constants used in VIP and their default +in VIP@. Here is the list of the constants used in VIP and their default values. @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}. A @dfn{point} is always between 2 characters, and is @dfn{looking at} the right hand character. The cursor is positioned on the right hand character. Thus, when the @dfn{point} is looking at the end-of-line, -the cursor is on the end-of-line character, i.e.@: beyond the last +the cursor is on the end-of-line character, i.e., beyond the last character on the line. This is the default Emacs behavior.@refill 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. more information.@refill Emacs uses Control and Meta modifiers. These are denoted as C and M, -e.g.@: @kbd{^Z} as @kbd{C-z} and @kbd{Meta-x} as @kbd{M-x}. The Meta key is +e.g., @kbd{^Z} as @kbd{C-z} and @kbd{Meta-x} as @kbd{M-x}. The Meta key is usually located on each side of the Space bar; it is used in a manner similar to the Control key, e.g., @kbd{M-x} means typing @kbd{x} while 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 configuration. However, this may require some getting used to. For instance, if you are typing in a frame, A, and then move the mouse to frame B and click to invoke mouse search, search (or insertion) will be performed -in frame A. To perform search/insertion in frame B, you will first have to +in frame A@. To perform search/insertion in frame B, you will first have to shift focus there, which doesn't happen until you type a character or perform some other action in frame B---mouse search doesn't shift focus. @@ -3670,7 +3670,7 @@ Join <count> lines (default 2). @item :[x,y]s/<pat>/<repl>/<f> Substitute (on lines x through y) the pattern <pat> (default the last pattern) with <repl>. Useful -flags <f> are @samp{g} for @samp{global} (i.e.@: change every +flags <f> are @samp{g} for @samp{global} (i.e., change every non-overlapping occurrence of <pat>) and @samp{c} for @samp{confirm} (type @samp{y} to confirm a particular substitution, else @samp{n} ). Instead of @kbd{/} any @@ -3694,7 +3694,7 @@ Same as @kbd{:copy}. @item :[x,y]move [z] Move text between @kbd{x} and @kbd{y} to the position after @kbd{z}. @item & -Repeat latest Ex substitute command, e.g. +Repeat latest Ex substitute command, e.g., @kbd{:s/wrong/right}. @item :x,yp @itemx :g/Pat/p @@ -3794,7 +3794,7 @@ Search in the tags file where <name> is defined (file, line), and go to it. @item :[x,y]s/<pat>/<repl>/<f> Substitute (on lines x through y) the pattern <pat> (default the last pattern) with <repl>. Useful -flags <f> are @samp{g} for @samp{global} (i.e.@: change every +flags <f> are @samp{g} for @samp{global} (i.e., change every non-overlapping occurrence of <pat>) and @samp{c} for @samp{confirm} (type @samp{y} to confirm a particular substitution, else @samp{n}). Instead of @kbd{/} any @@ -3804,7 +3804,7 @@ delimiter. Note: @emph{The newline character (inserted as @kbd{C-qC-j}) can be used in <repl>}. @item & -Repeat latest Ex substitute command, e.g.@: @kbd{:s/wrong/right}. +Repeat latest Ex substitute command, e.g., @kbd{:s/wrong/right}. @item :global /<pattern>/<ex-command> @itemx :g /<pattern>/<ex-command> Execute <ex-command> on all lines that match <pattern>. @@ -4476,12 +4476,12 @@ dxc@@xprt.net (David X Callaway), edmonds@@edmonds.home.cs.ubc.ca (Brian Edmonds), gin@@mo.msk.ru (Golubev I.N.), gviswana@@cs.wisc.edu (Guhan Viswanathan), -gvr@@halcyon.com (George V.@: Reilly), +gvr@@halcyon.com (George V. Reilly), hatazaki@@bach.convex.com (Takao Hatazaki), hpz@@ibmhpz.aug.ipp-garching.mpg.de (Hans-Peter Zehrfeld), irie@@t.email.ne.jp (Irie Tetsuya), jackr@@dblues.engr.sgi.com (Jack Repenning), -jamesm@@bga.com (D.J.@: Miller II), +jamesm@@bga.com (D.J. Miller II), jjm@@hplb.hpl.hp.com (Jean-Jacques Moreau), jl@@cse.ogi.edu (John Launchbury), 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} @vindex parent@r{ keyword} @item :parent -The parent of a nested widget (e.g.@: a @code{menu-choice} item or an +The parent of a nested widget (e.g., a @code{menu-choice} item or an element of a @code{editable-list} widget). @vindex sibling-args@r{ keyword} @@ -813,7 +813,7 @@ Face used for highlighting the editable field. Default is @vindex secret@r{ keyword} @item :secret -Character used to display the value. You can set this to e.g.@: @code{?*} +Character used to display the value. You can set this to, e.g., @code{?*} if the field contains a password or other secret information. By default, this is @code{nil}, and the value is not secret. @@ -918,8 +918,8 @@ Insert a literal @samp{%}. @vindex button-args@r{ keyword} @item :button-args -A list of keywords to pass to the radio buttons. Useful for setting -e.g.@: the @samp{:help-echo} for each button. +A list of keywords to pass to the radio buttons. Useful for setting, +e.g., the @samp{:help-echo} for each button. @vindex buttons@r{ keyword} @item :buttons @@ -1068,12 +1068,12 @@ Usually a checklist will only match if the items are in the exact sequence given in the specification. By setting @code{:greedy} to non-@code{nil}, it will allow the items to come in any sequence. However, if you extract the value they will be in the sequence given -in the checklist, i.e.@: the original sequence is forgotten. +in the checklist, i.e., the original sequence is forgotten. @vindex button-args@r{ keyword} @item :button-args -A list of keywords to pass to the checkboxes. Useful for setting -e.g.@: the @samp{:help-echo} for each checkbox. +A list of keywords to pass to the checkboxes. Useful for setting, +e.g., the @samp{:help-echo} for each checkbox. @vindex buttons@r{ keyword} @item :buttons @@ -1464,7 +1464,7 @@ property @var{property}. @end defun Occasionally it can be useful to know which kind of widget you have, -i.e.@: the name of the widget type you gave when the widget was created. +i.e., the name of the widget type you gave when the widget was created. @defun widget-type widget 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 similar), which seems to be the standard mechanism under GNU/Linux, then it parses that. To be precise, ``something very similar'' means starting with @samp{man} and ending with @samp{.conf} and possibly more -lowercase letters, e.g.@: @file{manual.configuration}. +lowercase letters, e.g., @file{manual.configuration}. The search path and/or precise full path name for this file are set by the value of the customizable user option @code{woman-man.conf-path}. 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 network is involved. For this reason, it caches various amounts of information, after which retrieving it from the cache is very fast. If the cache ever gets out of synchronism with reality, running the -@code{woman} command with a prefix argument (e.g.@: @kbd{C-u M-x woman}) +@code{woman} command with a prefix argument (e.g., @kbd{C-u M-x woman}) will force it to rebuild its cache. This is necessary only if the names or locations of any man files change; it is not necessary if only their 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 to a non-@code{nil} value (using @code{let}), in which case @code{woman} will can use the suggested topic without confirmation if possible. This may be useful to provide special private key bindings, -e.g.@: this key binding for @kbd{C-c w} runs WoMan on the topic at +e.g., this key binding for @kbd{C-c w} runs WoMan on the topic at point without seeking confirmation: @lisp @@ -511,7 +511,7 @@ The filename interface is accessed principally via the extended command all (provided WoMan is installed and loaded or set up to autoload). This command can be used to browse any accessible man file, regardless of its filename or location. If the file is compressed then automatic -file decompression must already be turned on (e.g.@: see the +file decompression must already be turned on (e.g., see the @samp{Help->Options} submenu)---it is turned on automatically only by the @code{woman} topic interface. @@ -554,7 +554,7 @@ primarily used internally by WoMan. Emacs provides an interface to detect automatically the format of a file and decode it when it is visited. It is used primarily by the -facilities for editing rich (i.e.@: formatted) text, as a way to store +facilities for editing rich (i.e., formatted) text, as a way to store formatting information transparently as @acronym{ASCII} markup. WoMan can in principle use this interface, but it must be configured explicitly. @@ -686,7 +686,7 @@ described by @code{Man-see-also-regexp}. Man pages usually contain a ``SEE ALSO'' section containing references to other man pages. If these man pages are installed then WoMan can -easily be directed to follow the reference, i.e.@: to find and format the +easily be directed to follow the reference, i.e., to find and format the man page. When the mouse is passed over a correctly formatted reference it is highlighted, in which case clicking the middle button @kbd{Mouse-2} will cause WoMan to follow the reference. Alternatively, @@ -763,13 +763,13 @@ item had been used. @kindex q @findex Man-quit Bury the buffer containing the current man page (@code{Man-quit}), -i.e.@: move it to the bottom of the buffer stack. +i.e., move it to the bottom of the buffer stack. @item k @kindex k @findex Man-kill Kill the buffer containing the current man page (@code{Man-kill}), -i.e.@: delete it completely so that it can be retrieved only by formatting +i.e., delete it completely so that it can be retrieved only by formatting the page again. @item M-p @@ -786,7 +786,7 @@ Find the next WoMan buffer (@code{WoMan-next-manpage}). @kindex R @findex woman-reformat-last-file Call WoMan to reformat the last man page formatted by WoMan -(@code{woman-reformat-last-file}), e.g.@: after changing the fill column. +(@code{woman-reformat-last-file}), e.g., after changing the fill column. @end table @@ -862,7 +862,7 @@ All WoMan user options are customizable, and it is recommended to change them only via the standard Emacs customization facilities. WoMan defines a top-level customization group called @code{WoMan} under the parent group @code{Help}. It can be accessed either via the -standard Emacs facilities, e.g.@: via the @samp{Help->Customize} +standard Emacs facilities, e.g., via the @samp{Help->Customize} submenu, or via the WoMan major mode menu. 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. @vtable @code @item woman-show-log A boolean value that defaults to @code{nil}. If non-@code{nil} then show the -@code{*WoMan-Log*} buffer if appropriate, i.e.@: if any warning messages +@code{*WoMan-Log*} buffer if appropriate, i.e., if any warning messages are written to it. @xref{Log, , The *WoMan-Log* Buffer}. @item woman-pre-format-hook @@ -960,13 +960,13 @@ is @end lisp Any environment variables (names of which must have the Unix-style form -@code{$NAME}, e.g.@: @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR}, +@code{$NAME}, e.g., @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR}, regardless of platform) are evaluated first but each element must evaluate to a @emph{single} directory name. Trailing @file{/}s are ignored. (Specific directories in @code{woman-path} are also searched.) On Microsoft platforms I recommend including drive letters explicitly, -e.g. +e.g.: @lisp ("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 and on other platforms is @code{nil}. Any environment variables (names of which must have the Unix-style form -@code{$NAME}, e.g.@: @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR}, +@code{$NAME}, e.g., @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR}, regardless of platform) are evaluated first but each element must evaluate to a @emph{single} directory name (regexp, see above). For example @@ -1064,7 +1064,7 @@ suppresses this action. The ``standard'' non-@code{nil} filename is @item woman-dired-keys A list of @code{dired} mode keys to be defined to run WoMan on the -current file, e.g.@: @code{("w" "W")} or any non-@code{nil} atom to +current file, e.g., @code{("w" "W")} or any non-@code{nil} atom to automatically define @kbd{w} and @kbd{W} if they are unbound, or @code{nil} to do nothing. Default is @code{t}. @@ -1229,7 +1229,7 @@ WoMan provides partial experimental support for special symbols, initially only for MS-Windows and only for MS-Windows fonts. This includes both non-@acronym{ASCII} characters from the main text font and use of a separate symbol font. Later, support will be added for other font -types (e.g.@: @code{bdf} fonts) and for the X Window System. In Emacs +types (e.g., @code{bdf} fonts) and for the X Window System. In Emacs 20.7, the current support works partially under Windows 9x but may not work on any other platform. @@ -1312,7 +1312,7 @@ is output. @cindex reporting bugs @cindex bugs, reporting -If WoMan fails completely, or formats a file incorrectly (i.e.@: +If WoMan fails completely, or formats a file incorrectly (i.e., obviously wrongly or significantly differently from @code{man}) or inelegantly, then please |