diff options
| author | Glenn Morris | 2013-10-23 13:20:09 -0400 |
|---|---|---|
| committer | Glenn Morris | 2013-10-23 13:20:09 -0400 |
| commit | 76f1a3c3143b61dd58c02a3bd2eb533802646679 (patch) | |
| tree | d7f68bdff0336c45c976ca5dae661d9a37027b65 /doc | |
| parent | bc4aaa31e2538c6992f9408f0190460eef79b655 (diff) | |
| download | emacs-76f1a3c3143b61dd58c02a3bd2eb533802646679.tar.gz emacs-76f1a3c3143b61dd58c02a3bd2eb533802646679.zip | |
Remove remaining @refills from doc/*/*.texi files
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/emacs/ChangeLog | 3 | ||||
| -rw-r--r-- | doc/emacs/files.texi | 2 | ||||
| -rw-r--r-- | doc/emacs/glossary.texi | 2 | ||||
| -rw-r--r-- | doc/emacs/killing.texi | 2 | ||||
| -rw-r--r-- | doc/emacs/search.texi | 12 | ||||
| -rw-r--r-- | doc/emacs/sending.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/ChangeLog | 6 | ||||
| -rw-r--r-- | doc/lispref/eval.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/files.texi | 6 | ||||
| -rw-r--r-- | doc/lispref/intro.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/objects.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/searching.texi | 18 | ||||
| -rw-r--r-- | doc/misc/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/misc/dired-x.texi | 3 | ||||
| -rw-r--r-- | doc/misc/ebrowse.texi | 16 | ||||
| -rw-r--r-- | doc/misc/ede.texi | 85 | ||||
| -rw-r--r-- | doc/misc/eieio.texi | 1 | ||||
| -rw-r--r-- | doc/misc/eshell.texi | 12 | ||||
| -rw-r--r-- | doc/misc/pcl-cvs.texi | 88 | ||||
| -rw-r--r-- | doc/misc/sc.texi | 106 | ||||
| -rw-r--r-- | doc/misc/srecode.texi | 3 | ||||
| -rw-r--r-- | doc/misc/vip.texi | 51 | ||||
| -rw-r--r-- | doc/misc/viper.texi | 74 | ||||
| -rw-r--r-- | doc/misc/widget.texi | 5 |
24 files changed, 212 insertions, 295 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index eb82535031f..cdb1ac845c9 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,5 +1,8 @@ | |||
| 1 | 2013-10-23 Glenn Morris <rgm@gnu.org> | 1 | 2013-10-23 Glenn Morris <rgm@gnu.org> |
| 2 | 2 | ||
| 3 | * files.texi, glossary.texi, killing.texi, search.texi, sending.texi: | ||
| 4 | Nuke @refill. | ||
| 5 | |||
| 3 | * Makefile.in (install-dvi, install-html, install-pdf) | 6 | * Makefile.in (install-dvi, install-html, install-pdf) |
| 4 | (install-ps, uninstall-dvi, uninstall-html, uninstall-ps) | 7 | (install-ps, uninstall-dvi, uninstall-html, uninstall-ps) |
| 5 | (uninstall-pdf): Quote entities that might contain whitespace. | 8 | (uninstall-pdf): Quote entities that might contain whitespace. |
diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi index 1ebe4caa290..4117248cbe4 100644 --- a/doc/emacs/files.texi +++ b/doc/emacs/files.texi | |||
| @@ -1089,7 +1089,7 @@ of data with the command @kbd{M-x recover-file @key{RET} @var{file} | |||
| 1089 | restores the contents from its auto-save file @file{#@var{file}#}. | 1089 | restores the contents from its auto-save file @file{#@var{file}#}. |
| 1090 | You can then save with @kbd{C-x C-s} to put the recovered text into | 1090 | You can then save with @kbd{C-x C-s} to put the recovered text into |
| 1091 | @var{file} itself. For example, to recover file @file{foo.c} from its | 1091 | @var{file} itself. For example, to recover file @file{foo.c} from its |
| 1092 | auto-save file @file{#foo.c#}, do:@refill | 1092 | auto-save file @file{#foo.c#}, do: |
| 1093 | 1093 | ||
| 1094 | @example | 1094 | @example |
| 1095 | M-x recover-file @key{RET} foo.c @key{RET} | 1095 | M-x recover-file @key{RET} foo.c @key{RET} |
diff --git a/doc/emacs/glossary.texi b/doc/emacs/glossary.texi index e4693a5293f..c8b4b40416f 100644 --- a/doc/emacs/glossary.texi +++ b/doc/emacs/glossary.texi | |||
| @@ -256,7 +256,7 @@ abbreviation for a name into the entire name. Completion is done for | |||
| 256 | minibuffer (q.v.@:) arguments when the set of possible valid inputs | 256 | minibuffer (q.v.@:) arguments when the set of possible valid inputs |
| 257 | is known; for example, on command names, buffer names, and | 257 | is known; for example, on command names, buffer names, and |
| 258 | file names. Completion usually occurs when @key{TAB}, @key{SPC} or | 258 | file names. Completion usually occurs when @key{TAB}, @key{SPC} or |
| 259 | @key{RET} is typed. @xref{Completion}.@refill | 259 | @key{RET} is typed. @xref{Completion}. |
| 260 | 260 | ||
| 261 | @anchor{Glossary---Continuation Line} | 261 | @anchor{Glossary---Continuation Line} |
| 262 | @item Continuation Line | 262 | @item Continuation Line |
diff --git a/doc/emacs/killing.texi b/doc/emacs/killing.texi index cb33327faa1..30b3a2c5ff0 100644 --- a/doc/emacs/killing.texi +++ b/doc/emacs/killing.texi | |||
| @@ -423,7 +423,7 @@ ring. But you can force it to append by first typing the command | |||
| 423 | tells the following command, if it is a kill command, to append the text | 423 | tells the following command, if it is a kill command, to append the text |
| 424 | it kills to the last killed text, instead of starting a new entry. With | 424 | it kills to the last killed text, instead of starting a new entry. With |
| 425 | @kbd{C-M-w}, you can kill several separated pieces of text and | 425 | @kbd{C-M-w}, you can kill several separated pieces of text and |
| 426 | accumulate them to be yanked back in one place.@refill | 426 | accumulate them to be yanked back in one place. |
| 427 | 427 | ||
| 428 | A kill command following @kbd{M-w} (@code{kill-ring-save}) does not | 428 | A kill command following @kbd{M-w} (@code{kill-ring-save}) does not |
| 429 | append to the text that @kbd{M-w} copied into the kill ring. | 429 | append to the text that @kbd{M-w} copied into the kill ring. |
diff --git a/doc/emacs/search.texi b/doc/emacs/search.texi index ead7c3cbf16..13e61b70264 100644 --- a/doc/emacs/search.texi +++ b/doc/emacs/search.texi | |||
| @@ -668,7 +668,7 @@ it possible to match the rest of the pattern. For example, in matching | |||
| 668 | tries to match all three @samp{a}s; but the rest of the pattern is | 668 | tries to match all three @samp{a}s; but the rest of the pattern is |
| 669 | @samp{ar} and there is only @samp{r} left to match, so this try fails. | 669 | @samp{ar} and there is only @samp{r} left to match, so this try fails. |
| 670 | The next alternative is for @samp{a*} to match only two @samp{a}s. | 670 | The next alternative is for @samp{a*} to match only two @samp{a}s. |
| 671 | With this choice, the rest of the regexp matches successfully.@refill | 671 | With this choice, the rest of the regexp matches successfully. |
| 672 | 672 | ||
| 673 | @item @kbd{+} | 673 | @item @kbd{+} |
| 674 | is a postfix operator, similar to @samp{*} except that it must match | 674 | is a postfix operator, similar to @samp{*} except that it must match |
| @@ -830,11 +830,11 @@ either @var{a} matches it or @var{b} matches it. It works by trying to | |||
| 830 | match @var{a}, and if that fails, by trying to match @var{b}. | 830 | match @var{a}, and if that fails, by trying to match @var{b}. |
| 831 | 831 | ||
| 832 | Thus, @samp{foo\|bar} matches either @samp{foo} or @samp{bar} | 832 | Thus, @samp{foo\|bar} matches either @samp{foo} or @samp{bar} |
| 833 | but no other string.@refill | 833 | but no other string. |
| 834 | 834 | ||
| 835 | @samp{\|} applies to the largest possible surrounding expressions. Only a | 835 | @samp{\|} applies to the largest possible surrounding expressions. Only a |
| 836 | surrounding @samp{\( @dots{} \)} grouping can limit the grouping power of | 836 | surrounding @samp{\( @dots{} \)} grouping can limit the grouping power of |
| 837 | @samp{\|}.@refill | 837 | @samp{\|}. |
| 838 | 838 | ||
| 839 | Full backtracking capability exists to handle multiple uses of @samp{\|}. | 839 | Full backtracking capability exists to handle multiple uses of @samp{\|}. |
| 840 | 840 | ||
| @@ -850,7 +850,7 @@ Thus, @samp{\(foo\|bar\)x} matches either @samp{foox} or @samp{barx}. | |||
| 850 | To enclose a complicated expression for the postfix operators @samp{*}, | 850 | To enclose a complicated expression for the postfix operators @samp{*}, |
| 851 | @samp{+} and @samp{?} to operate on. Thus, @samp{ba\(na\)*} matches | 851 | @samp{+} and @samp{?} to operate on. Thus, @samp{ba\(na\)*} matches |
| 852 | @samp{bananana}, etc., with any (zero or more) number of @samp{na} | 852 | @samp{bananana}, etc., with any (zero or more) number of @samp{na} |
| 853 | strings.@refill | 853 | strings. |
| 854 | 854 | ||
| 855 | @item | 855 | @item |
| 856 | To record a matched substring for future reference. | 856 | To record a matched substring for future reference. |
| @@ -912,7 +912,7 @@ matches the empty string, but only at point. | |||
| 912 | matches the empty string, but only at the beginning or | 912 | matches the empty string, but only at the beginning or |
| 913 | end of a word. Thus, @samp{\bfoo\b} matches any occurrence of | 913 | end of a word. Thus, @samp{\bfoo\b} matches any occurrence of |
| 914 | @samp{foo} as a separate word. @samp{\bballs?\b} matches | 914 | @samp{foo} as a separate word. @samp{\bballs?\b} matches |
| 915 | @samp{ball} or @samp{balls} as a separate word.@refill | 915 | @samp{ball} or @samp{balls} as a separate word. |
| 916 | 916 | ||
| 917 | @samp{\b} matches at the beginning or end of the buffer | 917 | @samp{\b} matches at the beginning or end of the buffer |
| 918 | regardless of what text appears next to it. | 918 | regardless of what text appears next to it. |
| @@ -1005,7 +1005,7 @@ searching through, if you specify the text in lower case. Thus, if | |||
| 1005 | you specify searching for @samp{foo}, then @samp{Foo} and @samp{foo} | 1005 | you specify searching for @samp{foo}, then @samp{Foo} and @samp{foo} |
| 1006 | also match. Regexps, and in particular character sets, behave | 1006 | also match. Regexps, and in particular character sets, behave |
| 1007 | likewise: @samp{[ab]} matches @samp{a} or @samp{A} or @samp{b} or | 1007 | likewise: @samp{[ab]} matches @samp{a} or @samp{A} or @samp{b} or |
| 1008 | @samp{B}.@refill | 1008 | @samp{B}. |
| 1009 | 1009 | ||
| 1010 | An upper-case letter anywhere in the incremental search string makes | 1010 | An upper-case letter anywhere in the incremental search string makes |
| 1011 | the search case-sensitive. Thus, searching for @samp{Foo} does not find | 1011 | the search case-sensitive. Thus, searching for @samp{Foo} does not find |
diff --git a/doc/emacs/sending.texi b/doc/emacs/sending.texi index 1402d8a85be..ac723fb63ad 100644 --- a/doc/emacs/sending.texi +++ b/doc/emacs/sending.texi | |||
| @@ -256,7 +256,7 @@ This means that @var{nick} should expand into @var{fulladdresses}, | |||
| 256 | where @var{fulladdresses} can be either a single address, or multiple | 256 | where @var{fulladdresses} can be either a single address, or multiple |
| 257 | addresses separated with spaces. For instance, to make @code{maingnu} | 257 | addresses separated with spaces. For instance, to make @code{maingnu} |
| 258 | stand for @code{gnu@@gnu.org} plus a local address of your own, put in | 258 | stand for @code{gnu@@gnu.org} plus a local address of your own, put in |
| 259 | this line:@refill | 259 | this line: |
| 260 | 260 | ||
| 261 | @example | 261 | @example |
| 262 | alias maingnu gnu@@gnu.org local-gnu | 262 | alias maingnu gnu@@gnu.org local-gnu |
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 7efe70f683d..944c7f7649b 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,12 +1,16 @@ | |||
| 1 | 2013-10-23 Glenn Morris <rgm@gnu.org> | 1 | 2013-10-23 Glenn Morris <rgm@gnu.org> |
| 2 | 2 | ||
| 3 | * eval.texi, files.texi, intro.texi, objects.texi, searching.texi: | ||
| 4 | Nuke @refill. | ||
| 5 | |||
| 3 | * Makefile.in (install-dvi, install-html, install-pdf) | 6 | * Makefile.in (install-dvi, install-html, install-pdf) |
| 4 | (install-ps, uninstall-dvi, uninstall-html, uninstall-ps) | 7 | (install-ps, uninstall-dvi, uninstall-html, uninstall-ps) |
| 5 | (uninstall-pdf): Quote entities that might contain whitespace. | 8 | (uninstall-pdf): Quote entities that might contain whitespace. |
| 6 | 9 | ||
| 7 | 2013-10-19 Xue Fuqiao <xfq.free@gmail.com> | 10 | 2013-10-19 Xue Fuqiao <xfq.free@gmail.com> |
| 8 | 11 | ||
| 9 | * display.texi (Face Attributes): Add indexes for the ‘:box’ face attribute. | 12 | * display.texi (Face Attributes): Add indexes for the ‘:box’ |
| 13 | face attribute. | ||
| 10 | 14 | ||
| 11 | 2013-10-18 Xue Fuqiao <xfq.free@gmail.com> | 15 | 2013-10-18 Xue Fuqiao <xfq.free@gmail.com> |
| 12 | 16 | ||
diff --git a/doc/lispref/eval.texi b/doc/lispref/eval.texi index 4b83d575fef..1139331f0ef 100644 --- a/doc/lispref/eval.texi +++ b/doc/lispref/eval.texi | |||
| @@ -523,7 +523,7 @@ GNU Emacs Lisp and Common Lisp. @code{setq}, @code{if}, and | |||
| 523 | doesn't exist in Common Lisp. @code{throw} is a special form in | 523 | doesn't exist in Common Lisp. @code{throw} is a special form in |
| 524 | Common Lisp (because it must be able to throw multiple values), but it | 524 | Common Lisp (because it must be able to throw multiple values), but it |
| 525 | is a function in Emacs Lisp (which doesn't have multiple | 525 | is a function in Emacs Lisp (which doesn't have multiple |
| 526 | values).@refill | 526 | values). |
| 527 | @end quotation | 527 | @end quotation |
| 528 | 528 | ||
| 529 | @node Autoloading | 529 | @node Autoloading |
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index 1f7169522cc..944a1e37cc4 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi | |||
| @@ -2378,7 +2378,7 @@ buffer's default directory is prepended to @var{directory}, if | |||
| 2378 | In the following example, suppose that @file{~rms/lewis} is the current | 2378 | In the following example, suppose that @file{~rms/lewis} is the current |
| 2379 | default directory, and has five files whose names begin with @samp{f}: | 2379 | default directory, and has five files whose names begin with @samp{f}: |
| 2380 | @file{foo}, @file{file~}, @file{file.c}, @file{file.c.~1~}, and | 2380 | @file{foo}, @file{file~}, @file{file.c}, @file{file.c.~1~}, and |
| 2381 | @file{file.c.~2~}.@refill | 2381 | @file{file.c.~2~}. |
| 2382 | 2382 | ||
| 2383 | @example | 2383 | @example |
| 2384 | @group | 2384 | @group |
| @@ -2409,7 +2409,7 @@ function returns @code{t}. The function returns @code{nil} if directory | |||
| 2409 | In the following example, suppose that the current default directory | 2409 | In the following example, suppose that the current default directory |
| 2410 | has five files whose names begin with @samp{f}: @file{foo}, | 2410 | has five files whose names begin with @samp{f}: @file{foo}, |
| 2411 | @file{file~}, @file{file.c}, @file{file.c.~1~}, and | 2411 | @file{file~}, @file{file.c}, @file{file.c.~1~}, and |
| 2412 | @file{file.c.~2~}.@refill | 2412 | @file{file.c.~2~}. |
| 2413 | 2413 | ||
| 2414 | @example | 2414 | @example |
| 2415 | @group | 2415 | @group |
| @@ -2438,7 +2438,7 @@ has five files whose names begin with @samp{f}: @file{foo}, | |||
| 2438 | @code{file-name-completion} usually ignores file names that end in any | 2438 | @code{file-name-completion} usually ignores file names that end in any |
| 2439 | string in this list. It does not ignore them when all the possible | 2439 | string in this list. It does not ignore them when all the possible |
| 2440 | completions end in one of these suffixes. This variable has no effect | 2440 | completions end in one of these suffixes. This variable has no effect |
| 2441 | on @code{file-name-all-completions}.@refill | 2441 | on @code{file-name-all-completions}. |
| 2442 | 2442 | ||
| 2443 | A typical value might look like this: | 2443 | A typical value might look like this: |
| 2444 | 2444 | ||
diff --git a/doc/lispref/intro.texi b/doc/lispref/intro.texi index 84da0bd3769..82c4d851762 100644 --- a/doc/lispref/intro.texi +++ b/doc/lispref/intro.texi | |||
| @@ -456,7 +456,7 @@ described using a format like that for functions, except that there | |||
| 456 | are no arguments. | 456 | are no arguments. |
| 457 | 457 | ||
| 458 | Here is a description of the imaginary @code{electric-future-map} | 458 | Here is a description of the imaginary @code{electric-future-map} |
| 459 | variable.@refill | 459 | variable. |
| 460 | 460 | ||
| 461 | @defvar electric-future-map | 461 | @defvar electric-future-map |
| 462 | The value of this variable is a full keymap used by Electric Command | 462 | The value of this variable is a full keymap used by Electric Command |
diff --git a/doc/lispref/objects.texi b/doc/lispref/objects.texi index 3b7dc41335b..a145b1e9bd2 100644 --- a/doc/lispref/objects.texi +++ b/doc/lispref/objects.texi | |||
| @@ -1301,7 +1301,7 @@ called @dfn{subrs} or @dfn{built-in functions}. (The word ``subr'' is | |||
| 1301 | derived from ``subroutine''.) Most primitive functions evaluate all | 1301 | derived from ``subroutine''.) Most primitive functions evaluate all |
| 1302 | their arguments when they are called. A primitive function that does | 1302 | their arguments when they are called. A primitive function that does |
| 1303 | not evaluate all its arguments is called a @dfn{special form} | 1303 | not evaluate all its arguments is called a @dfn{special form} |
| 1304 | (@pxref{Special Forms}).@refill | 1304 | (@pxref{Special Forms}). |
| 1305 | 1305 | ||
| 1306 | It does not matter to the caller of a function whether the function is | 1306 | It does not matter to the caller of a function whether the function is |
| 1307 | primitive. However, this does matter if you try to redefine a primitive | 1307 | primitive. However, this does matter if you try to redefine a primitive |
diff --git a/doc/lispref/searching.texi b/doc/lispref/searching.texi index 4a222a6e7af..15aa23f77ea 100644 --- a/doc/lispref/searching.texi +++ b/doc/lispref/searching.texi | |||
| @@ -273,12 +273,12 @@ expression is ordinary, unless a @samp{\} precedes it. | |||
| 273 | therefore @samp{f} is a regular expression that matches the string | 273 | therefore @samp{f} is a regular expression that matches the string |
| 274 | @samp{f} and no other string. (It does @emph{not} match the string | 274 | @samp{f} and no other string. (It does @emph{not} match the string |
| 275 | @samp{fg}, but it does match a @emph{part} of that string.) Likewise, | 275 | @samp{fg}, but it does match a @emph{part} of that string.) Likewise, |
| 276 | @samp{o} is a regular expression that matches only @samp{o}.@refill | 276 | @samp{o} is a regular expression that matches only @samp{o}. |
| 277 | 277 | ||
| 278 | Any two regular expressions @var{a} and @var{b} can be concatenated. The | 278 | Any two regular expressions @var{a} and @var{b} can be concatenated. The |
| 279 | result is a regular expression that matches a string if @var{a} matches | 279 | result is a regular expression that matches a string if @var{a} matches |
| 280 | some amount of the beginning of that string and @var{b} matches the rest of | 280 | some amount of the beginning of that string and @var{b} matches the rest of |
| 281 | the string.@refill | 281 | the string. |
| 282 | 282 | ||
| 283 | As a simple example, we can concatenate the regular expressions @samp{f} | 283 | As a simple example, we can concatenate the regular expressions @samp{f} |
| 284 | and @samp{o} to get the regular expression @samp{fo}, which matches only | 284 | and @samp{o} to get the regular expression @samp{fo}, which matches only |
| @@ -304,7 +304,7 @@ expression. | |||
| 304 | is a special character that matches any single character except a newline. | 304 | is a special character that matches any single character except a newline. |
| 305 | Using concatenation, we can make regular expressions like @samp{a.b}, which | 305 | Using concatenation, we can make regular expressions like @samp{a.b}, which |
| 306 | matches any three-character string that begins with @samp{a} and ends with | 306 | matches any three-character string that begins with @samp{a} and ends with |
| 307 | @samp{b}.@refill | 307 | @samp{b}. |
| 308 | 308 | ||
| 309 | @item @samp{*} | 309 | @item @samp{*} |
| 310 | @cindex @samp{*} in regexp | 310 | @cindex @samp{*} in regexp |
| @@ -488,7 +488,7 @@ example, the regular expression that matches the @samp{\} character is | |||
| 488 | @samp{\\}. To write a Lisp string that contains the characters | 488 | @samp{\\}. To write a Lisp string that contains the characters |
| 489 | @samp{\\}, Lisp syntax requires you to quote each @samp{\} with another | 489 | @samp{\\}, Lisp syntax requires you to quote each @samp{\} with another |
| 490 | @samp{\}. Therefore, the read syntax for a regular expression matching | 490 | @samp{\}. Therefore, the read syntax for a regular expression matching |
| 491 | @samp{\} is @code{"\\\\"}.@refill | 491 | @samp{\} is @code{"\\\\"}. |
| 492 | @end table | 492 | @end table |
| 493 | 493 | ||
| 494 | @strong{Please note:} For historical compatibility, special characters | 494 | @strong{Please note:} For historical compatibility, special characters |
| @@ -496,7 +496,7 @@ are treated as ordinary ones if they are in contexts where their special | |||
| 496 | meanings make no sense. For example, @samp{*foo} treats @samp{*} as | 496 | meanings make no sense. For example, @samp{*foo} treats @samp{*} as |
| 497 | ordinary since there is no preceding expression on which the @samp{*} | 497 | ordinary since there is no preceding expression on which the @samp{*} |
| 498 | can act. It is poor practice to depend on this behavior; quote the | 498 | can act. It is poor practice to depend on this behavior; quote the |
| 499 | special character anyway, regardless of where it appears.@refill | 499 | special character anyway, regardless of where it appears. |
| 500 | 500 | ||
| 501 | As a @samp{\} is not special inside a character alternative, it can | 501 | As a @samp{\} is not special inside a character alternative, it can |
| 502 | never remove the special meaning of @samp{-} or @samp{]}. So you | 502 | never remove the special meaning of @samp{-} or @samp{]}. So you |
| @@ -599,14 +599,14 @@ a table of the special @samp{\} constructs. | |||
| 599 | specifies an alternative. | 599 | specifies an alternative. |
| 600 | Two regular expressions @var{a} and @var{b} with @samp{\|} in | 600 | Two regular expressions @var{a} and @var{b} with @samp{\|} in |
| 601 | between form an expression that matches anything that either @var{a} or | 601 | between form an expression that matches anything that either @var{a} or |
| 602 | @var{b} matches.@refill | 602 | @var{b} matches. |
| 603 | 603 | ||
| 604 | Thus, @samp{foo\|bar} matches either @samp{foo} or @samp{bar} | 604 | Thus, @samp{foo\|bar} matches either @samp{foo} or @samp{bar} |
| 605 | but no other string.@refill | 605 | but no other string. |
| 606 | 606 | ||
| 607 | @samp{\|} applies to the largest possible surrounding expressions. Only a | 607 | @samp{\|} applies to the largest possible surrounding expressions. Only a |
| 608 | surrounding @samp{\( @dots{} \)} grouping can limit the grouping power of | 608 | surrounding @samp{\( @dots{} \)} grouping can limit the grouping power of |
| 609 | @samp{\|}.@refill | 609 | @samp{\|}. |
| 610 | 610 | ||
| 611 | If you need full backtracking capability to handle multiple uses of | 611 | If you need full backtracking capability to handle multiple uses of |
| 612 | @samp{\|}, use the POSIX regular expression functions (@pxref{POSIX | 612 | @samp{\|}, use the POSIX regular expression functions (@pxref{POSIX |
| @@ -785,7 +785,7 @@ matches the empty string, but only at point. | |||
| 785 | matches the empty string, but only at the beginning or | 785 | matches the empty string, but only at the beginning or |
| 786 | end of a word. Thus, @samp{\bfoo\b} matches any occurrence of | 786 | end of a word. Thus, @samp{\bfoo\b} matches any occurrence of |
| 787 | @samp{foo} as a separate word. @samp{\bballs?\b} matches | 787 | @samp{foo} as a separate word. @samp{\bballs?\b} matches |
| 788 | @samp{ball} or @samp{balls} as a separate word.@refill | 788 | @samp{ball} or @samp{balls} as a separate word. |
| 789 | 789 | ||
| 790 | @samp{\b} matches at the beginning or end of the buffer (or string) | 790 | @samp{\b} matches at the beginning or end of the buffer (or string) |
| 791 | regardless of what text appears next to it. | 791 | regardless of what text appears next to it. |
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 3563c1e768d..ad045fc6d5f 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,5 +1,9 @@ | |||
| 1 | 2013-10-23 Glenn Morris <rgm@gnu.org> | 1 | 2013-10-23 Glenn Morris <rgm@gnu.org> |
| 2 | 2 | ||
| 3 | * dired-x.texi, ebrowse.texi, ede.texi, eieio.texi, eshell.texi: | ||
| 4 | * pcl-cvs.texi, sc.texi, srecode.texi, vip.texi, viper.texi: | ||
| 5 | * widget.texi: Nuke @refill. | ||
| 6 | |||
| 3 | * Makefile.in (install-dvi, install-html, install-pdf) | 7 | * Makefile.in (install-dvi, install-html, install-pdf) |
| 4 | (install-ps, uninstall-dvi, uninstall-html, uninstall-ps) | 8 | (install-ps, uninstall-dvi, uninstall-html, uninstall-ps) |
| 5 | (uninstall-pdf): Quote entities that might contain whitespace. | 9 | (uninstall-pdf): Quote entities that might contain whitespace. |
diff --git a/doc/misc/dired-x.texi b/doc/misc/dired-x.texi index 1e3d11f6dc6..0b88604543e 100644 --- a/doc/misc/dired-x.texi +++ b/doc/misc/dired-x.texi | |||
| @@ -560,7 +560,7 @@ of marked files. | |||
| 560 | @vindex dired-guess-shell-alist-default | 560 | @vindex dired-guess-shell-alist-default |
| 561 | Predefined rules for shell commands. Set this to @code{nil} to turn guessing off. | 561 | Predefined rules for shell commands. Set this to @code{nil} to turn guessing off. |
| 562 | The elements of @code{dired-guess-shell-alist-user} (defined by the | 562 | The elements of @code{dired-guess-shell-alist-user} (defined by the |
| 563 | user) will override these rules.@refill | 563 | user) will override these rules. |
| 564 | 564 | ||
| 565 | @item dired-guess-shell-alist-user | 565 | @item dired-guess-shell-alist-user |
| 566 | @vindex dired-guess-shell-alist-user | 566 | @vindex dired-guess-shell-alist-user |
| @@ -568,7 +568,6 @@ If non-@code{nil}, a user-defined alist of file regexps and their suggested | |||
| 568 | commands. These rules take precedence over the predefined rules in the | 568 | commands. These rules take precedence over the predefined rules in the |
| 569 | variable @code{dired-guess-shell-alist-default} (to which they are prepended) | 569 | variable @code{dired-guess-shell-alist-default} (to which they are prepended) |
| 570 | when @code{dired-do-shell-command} is run). | 570 | when @code{dired-do-shell-command} is run). |
| 571 | @refill | ||
| 572 | 571 | ||
| 573 | Each element of the alist looks like | 572 | Each element of the alist looks like |
| 574 | 573 | ||
diff --git a/doc/misc/ebrowse.texi b/doc/misc/ebrowse.texi index c7f3e3b1a61..aa9df988969 100644 --- a/doc/misc/ebrowse.texi +++ b/doc/misc/ebrowse.texi | |||
| @@ -138,7 +138,7 @@ list of the pseudo-class @samp{*Globals*}; | |||
| 138 | 138 | ||
| 139 | @item | 139 | @item |
| 140 | Types (@code{enum}s, and @code{typedef}s defined with class | 140 | Types (@code{enum}s, and @code{typedef}s defined with class |
| 141 | scope).@refill | 141 | scope). |
| 142 | @end itemize | 142 | @end itemize |
| 143 | 143 | ||
| 144 | You can switch member buffers from one list to another, or to another | 144 | You can switch member buffers from one list to another, or to another |
| @@ -210,7 +210,7 @@ per line. | |||
| 210 | 210 | ||
| 211 | @findex --help | 211 | @findex --help |
| 212 | When invoked with option @samp{--help}, @command{ebrowse} prints a list of | 212 | When invoked with option @samp{--help}, @command{ebrowse} prints a list of |
| 213 | available command line options.@refill | 213 | available command line options. |
| 214 | 214 | ||
| 215 | @menu | 215 | @menu |
| 216 | * Input files:: Specifying which files to parse | 216 | * Input files:: Specifying which files to parse |
| @@ -478,12 +478,12 @@ name. | |||
| 478 | This command views the class declaration if the database | 478 | This command views the class declaration if the database |
| 479 | contains information about it. If you don't parse the entire source | 479 | contains information about it. If you don't parse the entire source |
| 480 | you are working on, some classes will only be known to exist but the | 480 | you are working on, some classes will only be known to exist but the |
| 481 | location of their declarations and definitions will not be known.@refill | 481 | location of their declarations and definitions will not be known. |
| 482 | 482 | ||
| 483 | @item RET | 483 | @item RET |
| 484 | Works like @kbd{SPC}, except that it finds the class | 484 | Works like @kbd{SPC}, except that it finds the class |
| 485 | declaration rather than viewing it, so that it is ready for | 485 | declaration rather than viewing it, so that it is ready for |
| 486 | editing.@refill | 486 | editing. |
| 487 | @end table | 487 | @end table |
| 488 | 488 | ||
| 489 | The same functionality is available from the menu opened with | 489 | The same functionality is available from the menu opened with |
| @@ -570,7 +570,7 @@ positions the cursor on the class in the class tree. | |||
| 570 | If the branch of the class tree containing the class searched for is | 570 | If the branch of the class tree containing the class searched for is |
| 571 | currently collapsed, the class itself and all its base classes are | 571 | currently collapsed, the class itself and all its base classes are |
| 572 | recursively made visible. (See also @ref{Expanding and | 572 | recursively made visible. (See also @ref{Expanding and |
| 573 | Collapsing}.)@refill | 573 | Collapsing}.) |
| 574 | 574 | ||
| 575 | This function is also available from the tree buffer's context menu. | 575 | This function is also available from the tree buffer's context menu. |
| 576 | 576 | ||
| @@ -634,7 +634,7 @@ Here is an example of a tree buffer with file names displayed. | |||
| 634 | You can expand and collapse parts of a tree to reduce the complexity of | 634 | You can expand and collapse parts of a tree to reduce the complexity of |
| 635 | large class hierarchies. Expanding or collapsing branches of a tree has | 635 | large class hierarchies. Expanding or collapsing branches of a tree has |
| 636 | no impact on the functionality of other commands, like @kbd{/}. (See | 636 | no impact on the functionality of other commands, like @kbd{/}. (See |
| 637 | also @ref{Go to Class}.)@refill | 637 | also @ref{Go to Class}.) |
| 638 | 638 | ||
| 639 | Collapsed branches are indicated with an ellipsis following the class | 639 | Collapsed branches are indicated with an ellipsis following the class |
| 640 | name like in the example below. | 640 | name like in the example below. |
| @@ -734,7 +734,7 @@ context menu. | |||
| 734 | 734 | ||
| 735 | Classes can be marked for operations similar to the standard Emacs | 735 | Classes can be marked for operations similar to the standard Emacs |
| 736 | commands @kbd{M-x tags-search} and @kbd{M-x tags-query-replace} (see | 736 | commands @kbd{M-x tags-search} and @kbd{M-x tags-query-replace} (see |
| 737 | also @xref{Tags-like Functions}.)@refill | 737 | also @xref{Tags-like Functions}.) |
| 738 | 738 | ||
| 739 | @table @kbd | 739 | @table @kbd |
| 740 | @cindex toggle mark | 740 | @cindex toggle mark |
| @@ -1292,7 +1292,7 @@ When jumping to a member declaration or definition with one of | |||
| 1292 | Ebrowse's commands, the position from where you performed the | 1292 | Ebrowse's commands, the position from where you performed the |
| 1293 | jump and the position where you jumped to are recorded in a | 1293 | jump and the position where you jumped to are recorded in a |
| 1294 | @dfn{position stack}. There are several ways in which you can quickly | 1294 | @dfn{position stack}. There are several ways in which you can quickly |
| 1295 | move to positions in the stack:@refill | 1295 | move to positions in the stack: |
| 1296 | 1296 | ||
| 1297 | @table @kbd | 1297 | @table @kbd |
| 1298 | @cindex return to original position | 1298 | @cindex return to original position |
diff --git a/doc/misc/ede.texi b/doc/misc/ede.texi index f2e787fd588..283082141dc 100644 --- a/doc/misc/ede.texi +++ b/doc/misc/ede.texi | |||
| @@ -1564,26 +1564,22 @@ Type: @code{string} @* | |||
| 1564 | Default Value: @code{"Untitled"} | 1564 | Default Value: @code{"Untitled"} |
| 1565 | 1565 | ||
| 1566 | The name used when generating distribution files. | 1566 | The name used when generating distribution files. |
| 1567 | @refill | ||
| 1568 | 1567 | ||
| 1569 | @item :version | 1568 | @item :version |
| 1570 | Type: @code{string} @* | 1569 | Type: @code{string} @* |
| 1571 | Default Value: @code{"1.0"} | 1570 | Default Value: @code{"1.0"} |
| 1572 | 1571 | ||
| 1573 | The version number used when distributing files. | 1572 | The version number used when distributing files. |
| 1574 | @refill | ||
| 1575 | 1573 | ||
| 1576 | @item :directory | 1574 | @item :directory |
| 1577 | Type: @code{string} | 1575 | Type: @code{string} |
| 1578 | 1576 | ||
| 1579 | Directory this project is associated with. | 1577 | Directory this project is associated with. |
| 1580 | @refill | ||
| 1581 | 1578 | ||
| 1582 | @item :file | 1579 | @item :file |
| 1583 | Type: @code{string} | 1580 | Type: @code{string} |
| 1584 | 1581 | ||
| 1585 | File name where this project is stored. | 1582 | File name where this project is stored. |
| 1586 | @refill | ||
| 1587 | 1583 | ||
| 1588 | @end table | 1584 | @end table |
| 1589 | 1585 | ||
| @@ -1656,35 +1652,30 @@ Make sure placeholder @var{THIS} is replaced with the real thing, and pass throu | |||
| 1656 | Type: @code{list} | 1652 | Type: @code{list} |
| 1657 | 1653 | ||
| 1658 | List of top level targets in this project. | 1654 | List of top level targets in this project. |
| 1659 | @refill | ||
| 1660 | 1655 | ||
| 1661 | @item :tool-cache | 1656 | @item :tool-cache |
| 1662 | Type: @code{list} | 1657 | Type: @code{list} |
| 1663 | 1658 | ||
| 1664 | List of tool cache configurations in this project. | 1659 | List of tool cache configurations in this project. |
| 1665 | This allows any tool to create, manage, and persist project-specific settings. | 1660 | This allows any tool to create, manage, and persist project-specific settings. |
| 1666 | @refill | ||
| 1667 | 1661 | ||
| 1668 | @item :web-site-url | 1662 | @item :web-site-url |
| 1669 | Type: @code{string} @* | 1663 | Type: @code{string} @* |
| 1670 | 1664 | ||
| 1671 | URL to this projects web site. | 1665 | URL to this projects web site. |
| 1672 | This is a URL to be sent to a web site for documentation. | 1666 | This is a URL to be sent to a web site for documentation. |
| 1673 | @refill | ||
| 1674 | 1667 | ||
| 1675 | @item :web-site-directory @* | 1668 | @item :web-site-directory @* |
| 1676 | 1669 | ||
| 1677 | A directory where web pages can be found by Emacs. | 1670 | A directory where web pages can be found by Emacs. |
| 1678 | For remote locations use a path compatible with ange-ftp or EFS@. | 1671 | For remote locations use a path compatible with ange-ftp or EFS@. |
| 1679 | You can also use TRAMP for use with rcp & scp. | 1672 | You can also use TRAMP for use with rcp & scp. |
| 1680 | @refill | ||
| 1681 | 1673 | ||
| 1682 | @item :web-site-file @* | 1674 | @item :web-site-file @* |
| 1683 | 1675 | ||
| 1684 | A file which contains the home page for this project. | 1676 | A file which contains the home page for this project. |
| 1685 | This file can be relative to slot @code{web-site-directory}. | 1677 | This file can be relative to slot @code{web-site-directory}. |
| 1686 | This can be a local file, use ange-ftp, EFS, or TRAMP. | 1678 | This can be a local file, use ange-ftp, EFS, or TRAMP. |
| 1687 | @refill | ||
| 1688 | 1679 | ||
| 1689 | @item :ftp-site | 1680 | @item :ftp-site |
| 1690 | Type: @code{string} @* | 1681 | Type: @code{string} @* |
| @@ -1692,7 +1683,6 @@ Type: @code{string} @* | |||
| 1692 | FTP site where this project's distribution can be found. | 1683 | FTP site where this project's distribution can be found. |
| 1693 | This FTP site should be in Emacs form, as needed by @code{ange-ftp}, but can | 1684 | This FTP site should be in Emacs form, as needed by @code{ange-ftp}, but can |
| 1694 | also be of a form used by TRAMP for use with scp, or rcp. | 1685 | also be of a form used by TRAMP for use with scp, or rcp. |
| 1695 | @refill | ||
| 1696 | 1686 | ||
| 1697 | @item :ftp-upload-site | 1687 | @item :ftp-upload-site |
| 1698 | Type: @code{string} @* | 1688 | Type: @code{string} @* |
| @@ -1700,7 +1690,6 @@ Type: @code{string} @* | |||
| 1700 | FTP Site to upload new distributions to. | 1690 | FTP Site to upload new distributions to. |
| 1701 | This FTP site should be in Emacs form as needed by @code{ange-ftp}. | 1691 | This FTP site should be in Emacs form as needed by @code{ange-ftp}. |
| 1702 | If this slot is @code{nil}, then use @code{ftp-site} instead. | 1692 | If this slot is @code{nil}, then use @code{ftp-site} instead. |
| 1703 | @refill | ||
| 1704 | 1693 | ||
| 1705 | @item :configurations | 1694 | @item :configurations |
| 1706 | Type: @code{list} @* | 1695 | Type: @code{list} @* |
| @@ -1709,19 +1698,16 @@ Default Value: @code{("debug" "release")} | |||
| 1709 | List of available configuration types. | 1698 | List of available configuration types. |
| 1710 | Individual target/project types can form associations between a configuration, | 1699 | Individual target/project types can form associations between a configuration, |
| 1711 | and target specific elements such as build variables. | 1700 | and target specific elements such as build variables. |
| 1712 | @refill | ||
| 1713 | 1701 | ||
| 1714 | @item :configuration-default @* | 1702 | @item :configuration-default @* |
| 1715 | Default Value: @code{"debug"} | 1703 | Default Value: @code{"debug"} |
| 1716 | 1704 | ||
| 1717 | The default configuration. | 1705 | The default configuration. |
| 1718 | @refill | ||
| 1719 | 1706 | ||
| 1720 | @item :local-variables @* | 1707 | @item :local-variables @* |
| 1721 | Default Value: @code{nil} | 1708 | Default Value: @code{nil} |
| 1722 | 1709 | ||
| 1723 | Project local variables | 1710 | Project local variables |
| 1724 | @refill | ||
| 1725 | 1711 | ||
| 1726 | @end table | 1712 | @end table |
| 1727 | 1713 | ||
| @@ -1966,7 +1952,6 @@ buffer's @code{default-directory} (not starting with a /). Directories | |||
| 1966 | that are relative to the project's root should start with a /, such | 1952 | that are relative to the project's root should start with a /, such |
| 1967 | as "/include", meaning the directory @code{include} off the project root | 1953 | as "/include", meaning the directory @code{include} off the project root |
| 1968 | directory. | 1954 | directory. |
| 1969 | @refill | ||
| 1970 | 1955 | ||
| 1971 | @item :system-include-path | 1956 | @item :system-include-path |
| 1972 | Type: @code{list} @* | 1957 | Type: @code{list} @* |
| @@ -1976,7 +1961,6 @@ The system include path for files in this project. | |||
| 1976 | C files initialized in an ede-cpp-root-project have their semantic | 1961 | C files initialized in an ede-cpp-root-project have their semantic |
| 1977 | system include path set to this value. If this is @code{nil}, then the | 1962 | system include path set to this value. If this is @code{nil}, then the |
| 1978 | semantic path is not modified. | 1963 | semantic path is not modified. |
| 1979 | @refill | ||
| 1980 | 1964 | ||
| 1981 | @item :spp-table | 1965 | @item :spp-table |
| 1982 | Type: @code{list} @* | 1966 | Type: @code{list} @* |
| @@ -1988,7 +1972,6 @@ These macros might be passed in through the command line compiler, or | |||
| 1988 | are critical symbols derived from header files. Providing header files | 1972 | are critical symbols derived from header files. Providing header files |
| 1989 | macro values through this slot improves accuracy and performance. | 1973 | macro values through this slot improves accuracy and performance. |
| 1990 | Use `:spp-files' to use these files directly. | 1974 | Use `:spp-files' to use these files directly. |
| 1991 | @refill | ||
| 1992 | 1975 | ||
| 1993 | @item :spp-files | 1976 | @item :spp-files |
| 1994 | Type: @code{list} @* | 1977 | Type: @code{list} @* |
| @@ -1998,14 +1981,12 @@ C header file with Preprocessor macros for your files. | |||
| 1998 | The PreProcessor symbols appearing in these files will be used while | 1981 | The PreProcessor symbols appearing in these files will be used while |
| 1999 | parsing files in this project. | 1982 | parsing files in this project. |
| 2000 | See @code{semantic-lex-c-preprocessor-symbol-map} for more on how this works. | 1983 | See @code{semantic-lex-c-preprocessor-symbol-map} for more on how this works. |
| 2001 | @refill | ||
| 2002 | 1984 | ||
| 2003 | @item :header-match-regexp | 1985 | @item :header-match-regexp |
| 2004 | Type: @code{string} @* | 1986 | Type: @code{string} @* |
| 2005 | Default Value: @code{"\\.\\(h\\(h\\|xx\\|pp\\|\\+\\+\\)?\\|H\\)$\\|\\<\\w+$"} | 1987 | Default Value: @code{"\\.\\(h\\(h\\|xx\\|pp\\|\\+\\+\\)?\\|H\\)$\\|\\<\\w+$"} |
| 2006 | 1988 | ||
| 2007 | Regexp used to identify C/C++ header files. | 1989 | Regexp used to identify C/C++ header files. |
| 2008 | @refill | ||
| 2009 | 1990 | ||
| 2010 | @item :locate-fcn | 1991 | @item :locate-fcn |
| 2011 | Type: @code{(or null function)} @* | 1992 | Type: @code{(or null function)} @* |
| @@ -2020,7 +2001,6 @@ The function symbol must take two arguments: | |||
| 2020 | 2001 | ||
| 2021 | It should return the fully qualified file name passed in from NAME@. If that file does not | 2002 | It should return the fully qualified file name passed in from NAME@. If that file does not |
| 2022 | exist, it should return nil. | 2003 | exist, it should return nil. |
| 2023 | @refill | ||
| 2024 | 2004 | ||
| 2025 | @end table | 2005 | @end table |
| 2026 | 2006 | ||
| @@ -2144,14 +2124,12 @@ The type of Makefile to generate. | |||
| 2144 | Can be one of @code{'Makefile}, 'Makefile.in, or 'Makefile.am. | 2124 | Can be one of @code{'Makefile}, 'Makefile.in, or 'Makefile.am. |
| 2145 | If this value is NOT @code{'Makefile}, then that overrides the @code{:makefile} slot | 2125 | If this value is NOT @code{'Makefile}, then that overrides the @code{:makefile} slot |
| 2146 | in targets. | 2126 | in targets. |
| 2147 | @refill | ||
| 2148 | 2127 | ||
| 2149 | @item :variables | 2128 | @item :variables |
| 2150 | Type: @code{list} @* | 2129 | Type: @code{list} @* |
| 2151 | Default Value: @code{nil} | 2130 | Default Value: @code{nil} |
| 2152 | 2131 | ||
| 2153 | Variables to set in this Makefile. | 2132 | Variables to set in this Makefile. |
| 2154 | @refill | ||
| 2155 | 2133 | ||
| 2156 | @item :configuration-variables | 2134 | @item :configuration-variables |
| 2157 | Type: @code{list} @* | 2135 | Type: @code{list} @* |
| @@ -2159,27 +2137,23 @@ Default Value: @code{("debug" (("DEBUG" . "1")))} | |||
| 2159 | 2137 | ||
| 2160 | Makefile variables to use in different configurations. | 2138 | Makefile variables to use in different configurations. |
| 2161 | These variables are used in the makefile when a configuration becomes active. | 2139 | These variables are used in the makefile when a configuration becomes active. |
| 2162 | @refill | ||
| 2163 | 2140 | ||
| 2164 | @item :inference-rules @* | 2141 | @item :inference-rules @* |
| 2165 | Default Value: @code{nil} | 2142 | Default Value: @code{nil} |
| 2166 | 2143 | ||
| 2167 | Inference rules to add to the makefile. | 2144 | Inference rules to add to the makefile. |
| 2168 | @refill | ||
| 2169 | 2145 | ||
| 2170 | @item :include-file @* | 2146 | @item :include-file @* |
| 2171 | Default Value: @code{nil} | 2147 | Default Value: @code{nil} |
| 2172 | 2148 | ||
| 2173 | Additional files to include. | 2149 | Additional files to include. |
| 2174 | These files can contain additional rules, variables, and customizations. | 2150 | These files can contain additional rules, variables, and customizations. |
| 2175 | @refill | ||
| 2176 | 2151 | ||
| 2177 | @item :automatic-dependencies | 2152 | @item :automatic-dependencies |
| 2178 | Type: @code{boolean} @* | 2153 | Type: @code{boolean} @* |
| 2179 | Default Value: @code{t} | 2154 | Default Value: @code{t} |
| 2180 | 2155 | ||
| 2181 | Non-@code{nil} to do implement automatic dependencies in the Makefile. | 2156 | Non-@code{nil} to do implement automatic dependencies in the Makefile. |
| 2182 | @refill | ||
| 2183 | 2157 | ||
| 2184 | @item :metasubproject | 2158 | @item :metasubproject |
| 2185 | Type: @code{boolean} @* | 2159 | Type: @code{boolean} @* |
| @@ -2190,7 +2164,6 @@ Usually, a subproject is determined by a parent project. If multiple top level | |||
| 2190 | projects are grouped into a large project not maintained by EDE, then you need | 2164 | projects are grouped into a large project not maintained by EDE, then you need |
| 2191 | to set this to non-nil. The only effect is that the @code{dist} rule will then avoid | 2165 | to set this to non-nil. The only effect is that the @code{dist} rule will then avoid |
| 2192 | making a tar file. | 2166 | making a tar file. |
| 2193 | @refill | ||
| 2194 | 2167 | ||
| 2195 | @end table | 2168 | @end table |
| 2196 | 2169 | ||
| @@ -2380,7 +2353,6 @@ Type: @code{list} @* | |||
| 2380 | Default Value: @code{nil} | 2353 | Default Value: @code{nil} |
| 2381 | 2354 | ||
| 2382 | Variables to set in this Makefile, at top of file. | 2355 | Variables to set in this Makefile, at top of file. |
| 2383 | @refill | ||
| 2384 | 2356 | ||
| 2385 | @item :additional-variables | 2357 | @item :additional-variables |
| 2386 | Type: @code{(or null list)} @* | 2358 | Type: @code{(or null list)} @* |
| @@ -2388,7 +2360,6 @@ Default Value: @code{nil} | |||
| 2388 | 2360 | ||
| 2389 | Arbitrary variables needed from this project. | 2361 | Arbitrary variables needed from this project. |
| 2390 | It is safe to leave this blank. | 2362 | It is safe to leave this blank. |
| 2391 | @refill | ||
| 2392 | 2363 | ||
| 2393 | @item :additional-rules | 2364 | @item :additional-rules |
| 2394 | Type: @code{(or null list)} @* | 2365 | Type: @code{(or null list)} @* |
| @@ -2396,7 +2367,6 @@ Default Value: @code{nil} | |||
| 2396 | 2367 | ||
| 2397 | Arbitrary rules and dependencies needed to make this target. | 2368 | Arbitrary rules and dependencies needed to make this target. |
| 2398 | It is safe to leave this blank. | 2369 | It is safe to leave this blank. |
| 2399 | @refill | ||
| 2400 | 2370 | ||
| 2401 | @item :installation-domain | 2371 | @item :installation-domain |
| 2402 | Type: @code{symbol} @* | 2372 | Type: @code{symbol} @* |
| @@ -2404,7 +2374,6 @@ Default Value: @code{user} | |||
| 2404 | 2374 | ||
| 2405 | Installation domain specification. | 2375 | Installation domain specification. |
| 2406 | The variable GNUSTEP_INSTALLATION_DOMAIN is set at this value. | 2376 | The variable GNUSTEP_INSTALLATION_DOMAIN is set at this value. |
| 2407 | @refill | ||
| 2408 | 2377 | ||
| 2409 | @item :preamble | 2378 | @item :preamble |
| 2410 | Type: @code{(or null list)} @* | 2379 | Type: @code{(or null list)} @* |
| @@ -2412,7 +2381,6 @@ Default Value: @code{(quote ("GNUmakefile.preamble"))} | |||
| 2412 | 2381 | ||
| 2413 | The auxiliary makefile for additional variables. | 2382 | The auxiliary makefile for additional variables. |
| 2414 | Included just before the specific target files. | 2383 | Included just before the specific target files. |
| 2415 | @refill | ||
| 2416 | 2384 | ||
| 2417 | @item :postamble | 2385 | @item :postamble |
| 2418 | Type: @code{(or null list)} @* | 2386 | Type: @code{(or null list)} @* |
| @@ -2420,7 +2388,6 @@ Default Value: @code{(quote ("GNUmakefile.postamble"))} | |||
| 2420 | 2388 | ||
| 2421 | The auxiliary makefile for additional rules. | 2389 | The auxiliary makefile for additional rules. |
| 2422 | Included just after the specific target files. | 2390 | Included just after the specific target files. |
| 2423 | @refill | ||
| 2424 | 2391 | ||
| 2425 | @item :metasubproject | 2392 | @item :metasubproject |
| 2426 | Type: @code{boolean} @* | 2393 | Type: @code{boolean} @* |
| @@ -2431,7 +2398,6 @@ Usually, a subproject is determined by a parent project. If multiple top level | |||
| 2431 | projects are grouped into a large project not maintained by EDE, then you need | 2398 | projects are grouped into a large project not maintained by EDE, then you need |
| 2432 | to set this to non-nil. The only effect is that the @code{dist} rule will then avoid | 2399 | to set this to non-nil. The only effect is that the @code{dist} rule will then avoid |
| 2433 | making a tar file. | 2400 | making a tar file. |
| 2434 | @refill | ||
| 2435 | 2401 | ||
| 2436 | @end table | 2402 | @end table |
| 2437 | 2403 | ||
| @@ -2536,21 +2502,18 @@ Commit change to local variables in @var{PROJ}. | |||
| 2536 | Type: @code{string} | 2502 | Type: @code{string} |
| 2537 | 2503 | ||
| 2538 | Name of this target. | 2504 | Name of this target. |
| 2539 | @refill | ||
| 2540 | 2505 | ||
| 2541 | @item :path | 2506 | @item :path |
| 2542 | Type: @code{string} | 2507 | Type: @code{string} |
| 2543 | 2508 | ||
| 2544 | The path to the sources of this target. | 2509 | The path to the sources of this target. |
| 2545 | Relative to the path of the project it belongs to. | 2510 | Relative to the path of the project it belongs to. |
| 2546 | @refill | ||
| 2547 | 2511 | ||
| 2548 | @item :source | 2512 | @item :source |
| 2549 | Type: @code{list} @* | 2513 | Type: @code{list} @* |
| 2550 | Default Value: @code{nil} | 2514 | Default Value: @code{nil} |
| 2551 | 2515 | ||
| 2552 | Source files in this target. | 2516 | Source files in this target. |
| 2553 | @refill | ||
| 2554 | 2517 | ||
| 2555 | @item :versionsource | 2518 | @item :versionsource |
| 2556 | Type: @code{list} @* | 2519 | Type: @code{list} @* |
| @@ -2560,7 +2523,6 @@ Source files with a version string in them. | |||
| 2560 | These files are checked for a version string whenever the EDE version | 2523 | These files are checked for a version string whenever the EDE version |
| 2561 | of the master project is changed. When strings are found, the version | 2524 | of the master project is changed. When strings are found, the version |
| 2562 | previously there is updated. | 2525 | previously there is updated. |
| 2563 | @refill | ||
| 2564 | 2526 | ||
| 2565 | @end table | 2527 | @end table |
| 2566 | 2528 | ||
| @@ -2752,14 +2714,12 @@ Retrieves the slot @code{menu} from an object of class @code{ede-target} | |||
| 2752 | Type: @code{string} | 2714 | Type: @code{string} |
| 2753 | 2715 | ||
| 2754 | Name of this target. | 2716 | Name of this target. |
| 2755 | @refill | ||
| 2756 | 2717 | ||
| 2757 | @item :path | 2718 | @item :path |
| 2758 | Type: @code{string} | 2719 | Type: @code{string} |
| 2759 | 2720 | ||
| 2760 | The path to the sources of this target. | 2721 | The path to the sources of this target. |
| 2761 | Relative to the path of the project it belongs to. | 2722 | Relative to the path of the project it belongs to. |
| 2762 | @refill | ||
| 2763 | 2723 | ||
| 2764 | @item :auxsource | 2724 | @item :auxsource |
| 2765 | Type: @code{list} @* | 2725 | Type: @code{list} @* |
| @@ -2768,7 +2728,6 @@ Default Value: @code{nil} | |||
| 2768 | Auxiliary source files included in this target. | 2728 | Auxiliary source files included in this target. |
| 2769 | Each of these is considered equivalent to a source file, but it is not | 2729 | Each of these is considered equivalent to a source file, but it is not |
| 2770 | distributed, and each should have a corresponding rule to build it. | 2730 | distributed, and each should have a corresponding rule to build it. |
| 2771 | @refill | ||
| 2772 | 2731 | ||
| 2773 | @item :compiler | 2732 | @item :compiler |
| 2774 | Type: @code{(or null symbol)} @* | 2733 | Type: @code{(or null symbol)} @* |
| @@ -2778,7 +2737,6 @@ The compiler to be used to compile this object. | |||
| 2778 | This should be a symbol, which contains the object defining the compiler. | 2737 | This should be a symbol, which contains the object defining the compiler. |
| 2779 | This enables save/restore to do so by name, permitting the sharing | 2738 | This enables save/restore to do so by name, permitting the sharing |
| 2780 | of these compiler resources, and global customization thereof. | 2739 | of these compiler resources, and global customization thereof. |
| 2781 | @refill | ||
| 2782 | 2740 | ||
| 2783 | @item :linker | 2741 | @item :linker |
| 2784 | Type: @code{(or null symbol)} @* | 2742 | Type: @code{(or null symbol)} @* |
| @@ -2788,7 +2746,6 @@ The linker to be used to link compiled sources for this object. | |||
| 2788 | This should be a symbol, which contains the object defining the linker. | 2746 | This should be a symbol, which contains the object defining the linker. |
| 2789 | This enables save/restore to do so by name, permitting the sharing | 2747 | This enables save/restore to do so by name, permitting the sharing |
| 2790 | of these linker resources, and global customization thereof. | 2748 | of these linker resources, and global customization thereof. |
| 2791 | @refill | ||
| 2792 | 2749 | ||
| 2793 | @end table | 2750 | @end table |
| 2794 | 2751 | ||
| @@ -2950,7 +2907,6 @@ Type: @code{string} @* | |||
| 2950 | Default Value: @code{"Makefile"} | 2907 | Default Value: @code{"Makefile"} |
| 2951 | 2908 | ||
| 2952 | File name of generated Makefile. | 2909 | File name of generated Makefile. |
| 2953 | @refill | ||
| 2954 | 2910 | ||
| 2955 | @item :partofall | 2911 | @item :partofall |
| 2956 | Type: @code{boolean} @* | 2912 | Type: @code{boolean} @* |
| @@ -2959,7 +2915,6 @@ Default Value: @code{t} | |||
| 2959 | Non @code{nil} means the rule created is part of the all target. | 2915 | Non @code{nil} means the rule created is part of the all target. |
| 2960 | Setting this to @code{nil} creates the rule to build this item, but does not | 2916 | Setting this to @code{nil} creates the rule to build this item, but does not |
| 2961 | include it in the ALL`all:' rule. | 2917 | include it in the ALL`all:' rule. |
| 2962 | @refill | ||
| 2963 | 2918 | ||
| 2964 | @item :configuration-variables | 2919 | @item :configuration-variables |
| 2965 | Type: @code{list} @* | 2920 | Type: @code{list} @* |
| @@ -2969,7 +2924,6 @@ Makefile variables appended to use in different configurations. | |||
| 2969 | These variables are used in the makefile when a configuration becomes active. | 2924 | These variables are used in the makefile when a configuration becomes active. |
| 2970 | Target variables are always renamed such as foo_CFLAGS, then included into | 2925 | Target variables are always renamed such as foo_CFLAGS, then included into |
| 2971 | commands where the variable would usually appear. | 2926 | commands where the variable would usually appear. |
| 2972 | @refill | ||
| 2973 | 2927 | ||
| 2974 | @item :rules | 2928 | @item :rules |
| 2975 | Type: @code{list} @* | 2929 | Type: @code{list} @* |
| @@ -2977,7 +2931,6 @@ Default Value: @code{nil} | |||
| 2977 | 2931 | ||
| 2978 | Arbitrary rules and dependencies needed to make this target. | 2932 | Arbitrary rules and dependencies needed to make this target. |
| 2979 | It is safe to leave this blank. | 2933 | It is safe to leave this blank. |
| 2980 | @refill | ||
| 2981 | 2934 | ||
| 2982 | @end table | 2935 | @end table |
| 2983 | 2936 | ||
| @@ -3221,7 +3174,6 @@ The linker flag "-l" is automatically prepended. Do not include a "lib" | |||
| 3221 | prefix, or a ".so" suffix. | 3174 | prefix, or a ".so" suffix. |
| 3222 | 3175 | ||
| 3223 | Note: Currently only used for Automake projects. | 3176 | Note: Currently only used for Automake projects. |
| 3224 | @refill | ||
| 3225 | 3177 | ||
| 3226 | @item :ldflags | 3178 | @item :ldflags |
| 3227 | Type: @code{list} @* | 3179 | Type: @code{list} @* |
| @@ -3232,7 +3184,6 @@ Use ldlibs to add addition libraries. Use this to specify specific | |||
| 3232 | options to the linker. | 3184 | options to the linker. |
| 3233 | 3185 | ||
| 3234 | Note: Not currently used. This bug needs to be fixed. | 3186 | Note: Not currently used. This bug needs to be fixed. |
| 3235 | @refill | ||
| 3236 | 3187 | ||
| 3237 | @end table | 3188 | @end table |
| 3238 | 3189 | ||
| @@ -3358,7 +3309,6 @@ Additional packages needed. | |||
| 3358 | There should only be one toplevel package per auxiliary tool needed. | 3309 | There should only be one toplevel package per auxiliary tool needed. |
| 3359 | These packages location is found, and added to the compile time | 3310 | These packages location is found, and added to the compile time |
| 3360 | load path. | 3311 | load path. |
| 3361 | @refill | ||
| 3362 | 3312 | ||
| 3363 | @end table | 3313 | @end table |
| 3364 | 3314 | ||
| @@ -3439,7 +3389,6 @@ Default Value: @code{"loaddefs.el"} | |||
| 3439 | The file that autoload definitions are placed in. | 3389 | The file that autoload definitions are placed in. |
| 3440 | There should be one load defs file for a given package. The load defs are created | 3390 | There should be one load defs file for a given package. The load defs are created |
| 3441 | for all Emacs Lisp sources that exist in the directory of the created target. | 3391 | for all Emacs Lisp sources that exist in the directory of the created target. |
| 3442 | @refill | ||
| 3443 | 3392 | ||
| 3444 | @item :autoload-dirs | 3393 | @item :autoload-dirs |
| 3445 | Type: @code{list} @* | 3394 | Type: @code{list} @* |
| @@ -3447,7 +3396,6 @@ Default Value: @code{nil} | |||
| 3447 | 3396 | ||
| 3448 | The directories to scan for autoload definitions. | 3397 | The directories to scan for autoload definitions. |
| 3449 | If @code{nil} defaults to the current directory. | 3398 | If @code{nil} defaults to the current directory. |
| 3450 | @refill | ||
| 3451 | 3399 | ||
| 3452 | @end table | 3400 | @end table |
| 3453 | 3401 | ||
| @@ -3547,7 +3495,6 @@ Default Value: @code{""} | |||
| 3547 | 3495 | ||
| 3548 | Miscellaneous sources which have a specialized makefile. | 3496 | Miscellaneous sources which have a specialized makefile. |
| 3549 | The sub-makefile is used to build this target. | 3497 | The sub-makefile is used to build this target. |
| 3550 | @refill | ||
| 3551 | 3498 | ||
| 3552 | @end table | 3499 | @end table |
| 3553 | 3500 | ||
| @@ -3604,7 +3551,6 @@ Default Value: @code{""} | |||
| 3604 | 3551 | ||
| 3605 | The main menu resides in this file. | 3552 | The main menu resides in this file. |
| 3606 | All other sources should be included independently. | 3553 | All other sources should be included independently. |
| 3607 | @refill | ||
| 3608 | 3554 | ||
| 3609 | @end table | 3555 | @end table |
| 3610 | 3556 | ||
| @@ -3687,7 +3633,6 @@ Type: @code{string} @* | |||
| 3687 | Default Value: @code{"guile"} | 3633 | Default Value: @code{"guile"} |
| 3688 | 3634 | ||
| 3689 | The preferred interpreter for this code. | 3635 | The preferred interpreter for this code. |
| 3690 | @refill | ||
| 3691 | 3636 | ||
| 3692 | @end table | 3637 | @end table |
| 3693 | 3638 | ||
| @@ -3817,7 +3762,6 @@ No children | |||
| 3817 | Default Value: @code{nil} | 3762 | Default Value: @code{nil} |
| 3818 | 3763 | ||
| 3819 | Additional LD args. | 3764 | Additional LD args. |
| 3820 | @refill | ||
| 3821 | @end table | 3765 | @end table |
| 3822 | @end table | 3766 | @end table |
| 3823 | 3767 | ||
| @@ -3949,7 +3893,6 @@ No children | |||
| 3949 | Default Value: @code{nil} | 3893 | Default Value: @code{nil} |
| 3950 | 3894 | ||
| 3951 | Additional texinfo included in this one. | 3895 | Additional texinfo included in this one. |
| 3952 | @refill | ||
| 3953 | 3896 | ||
| 3954 | @end table | 3897 | @end table |
| 3955 | @end table | 3898 | @end table |
| @@ -4036,21 +3979,18 @@ Type: @code{eieio-instance-inheritor-child} | |||
| 4036 | The parent of this instance. | 3979 | The parent of this instance. |
| 4037 | If a slot of this class is reference, and is unbound, then the parent | 3980 | If a slot of this class is reference, and is unbound, then the parent |
| 4038 | is checked for a value. | 3981 | is checked for a value. |
| 4039 | @refill | ||
| 4040 | 3982 | ||
| 4041 | @item :name | 3983 | @item :name |
| 4042 | Type: @code{string} | 3984 | Type: @code{string} |
| 4043 | 3985 | ||
| 4044 | The name of this type of source code. | 3986 | The name of this type of source code. |
| 4045 | Such as "C" or "Emacs Lisp" | 3987 | Such as "C" or "Emacs Lisp" |
| 4046 | @refill | ||
| 4047 | 3988 | ||
| 4048 | @item :sourcepattern | 3989 | @item :sourcepattern |
| 4049 | Type: @code{string} @* | 3990 | Type: @code{string} @* |
| 4050 | Default Value: @code{".*"} | 3991 | Default Value: @code{".*"} |
| 4051 | 3992 | ||
| 4052 | Emacs regex matching sourcecode this target accepts. | 3993 | Emacs regex matching sourcecode this target accepts. |
| 4053 | @refill | ||
| 4054 | 3994 | ||
| 4055 | @item :auxsourcepattern | 3995 | @item :auxsourcepattern |
| 4056 | Type: @code{(or null string)} @* | 3996 | Type: @code{(or null string)} @* |
| @@ -4059,7 +3999,6 @@ Default Value: @code{nil} | |||
| 4059 | Emacs regex matching auxiliary source code this target accepts. | 3999 | Emacs regex matching auxiliary source code this target accepts. |
| 4060 | Aux source are source code files needed for compilation, which are not compiled | 4000 | Aux source are source code files needed for compilation, which are not compiled |
| 4061 | themselves. | 4001 | themselves. |
| 4062 | @refill | ||
| 4063 | 4002 | ||
| 4064 | @item :enable-subdirectories | 4003 | @item :enable-subdirectories |
| 4065 | Type: @code{boolean} @* | 4004 | Type: @code{boolean} @* |
| @@ -4069,7 +4008,6 @@ Non @code{nil} if this sourcecode type uses subdirectores. | |||
| 4069 | If sourcecode always lives near the target creating it, this should be nil. | 4008 | If sourcecode always lives near the target creating it, this should be nil. |
| 4070 | If sourcecode can, or typically lives in a subdirectory of the owning | 4009 | If sourcecode can, or typically lives in a subdirectory of the owning |
| 4071 | target, set this to t. | 4010 | target, set this to t. |
| 4072 | @refill | ||
| 4073 | 4011 | ||
| 4074 | @item :garbagepattern | 4012 | @item :garbagepattern |
| 4075 | Type: @code{list} @* | 4013 | Type: @code{list} @* |
| @@ -4078,7 +4016,6 @@ Default Value: @code{nil} | |||
| 4078 | Shell file regex matching files considered as garbage. | 4016 | Shell file regex matching files considered as garbage. |
| 4079 | This is a list of items added to an @code{rm} command when executing a @code{clean} | 4017 | This is a list of items added to an @code{rm} command when executing a @code{clean} |
| 4080 | type directive. | 4018 | type directive. |
| 4081 | @refill | ||
| 4082 | 4019 | ||
| 4083 | @end table | 4020 | @end table |
| 4084 | 4021 | ||
| @@ -4158,13 +4095,11 @@ Type: @code{eieio-instance-inheritor-child} | |||
| 4158 | The parent of this instance. | 4095 | The parent of this instance. |
| 4159 | If a slot of this class is reference, and is unbound, then the parent | 4096 | If a slot of this class is reference, and is unbound, then the parent |
| 4160 | is checked for a value. | 4097 | is checked for a value. |
| 4161 | @refill | ||
| 4162 | 4098 | ||
| 4163 | @item :name | 4099 | @item :name |
| 4164 | Type: @code{string} | 4100 | Type: @code{string} |
| 4165 | 4101 | ||
| 4166 | Name of this type of compiler. | 4102 | Name of this type of compiler. |
| 4167 | @refill | ||
| 4168 | 4103 | ||
| 4169 | @item :variables | 4104 | @item :variables |
| 4170 | Type: @code{list} | 4105 | Type: @code{list} |
| @@ -4173,7 +4108,6 @@ Variables needed in the Makefile for this compiler. | |||
| 4173 | An assoc list where each element is (VARNAME . VALUE) where VARNAME | 4108 | An assoc list where each element is (VARNAME . VALUE) where VARNAME |
| 4174 | is a string, and VALUE is either a string, or a list of strings. | 4109 | is a string, and VALUE is either a string, or a list of strings. |
| 4175 | For example, GCC would define CC=gcc, and emacs would define EMACS=emacs. | 4110 | For example, GCC would define CC=gcc, and emacs would define EMACS=emacs. |
| 4176 | @refill | ||
| 4177 | 4111 | ||
| 4178 | @item :sourcetype | 4112 | @item :sourcetype |
| 4179 | Type: @code{list} | 4113 | Type: @code{list} |
| @@ -4181,7 +4115,6 @@ Type: @code{list} | |||
| 4181 | A list of @code{ede-sourcecode} @xref{ede-sourcecode}. objects this class will handle. | 4115 | A list of @code{ede-sourcecode} @xref{ede-sourcecode}. objects this class will handle. |
| 4182 | This is used to match target objects with the compilers and linkers | 4116 | This is used to match target objects with the compilers and linkers |
| 4183 | they can use, and which files this object is interested in. | 4117 | they can use, and which files this object is interested in. |
| 4184 | @refill | ||
| 4185 | 4118 | ||
| 4186 | @item :rules | 4119 | @item :rules |
| 4187 | Type: @code{list} @* | 4120 | Type: @code{list} @* |
| @@ -4189,7 +4122,6 @@ Default Value: @code{nil} | |||
| 4189 | 4122 | ||
| 4190 | Auxiliary rules needed for this compiler to run. | 4123 | Auxiliary rules needed for this compiler to run. |
| 4191 | For example, yacc/lex files need additional chain rules, or inferences. | 4124 | For example, yacc/lex files need additional chain rules, or inferences. |
| 4192 | @refill | ||
| 4193 | 4125 | ||
| 4194 | @item :commands | 4126 | @item :commands |
| 4195 | Type: @code{list} | 4127 | Type: @code{list} |
| @@ -4197,7 +4129,6 @@ Type: @code{list} | |||
| 4197 | The commands used to execute this compiler. | 4129 | The commands used to execute this compiler. |
| 4198 | The object which uses this compiler will place these commands after | 4130 | The object which uses this compiler will place these commands after |
| 4199 | it's rule definition. | 4131 | it's rule definition. |
| 4200 | @refill | ||
| 4201 | 4132 | ||
| 4202 | @item :autoconf | 4133 | @item :autoconf |
| 4203 | Type: @code{list} @* | 4134 | Type: @code{list} @* |
| @@ -4208,14 +4139,12 @@ When a project is in Automake mode, this defines the autoconf function to | |||
| 4208 | call to initialize automake to use this compiler. | 4139 | call to initialize automake to use this compiler. |
| 4209 | For example, there may be multiple C compilers, but they all probably | 4140 | For example, there may be multiple C compilers, but they all probably |
| 4210 | use the same autoconf form. | 4141 | use the same autoconf form. |
| 4211 | @refill | ||
| 4212 | 4142 | ||
| 4213 | @item :objectextention | 4143 | @item :objectextention |
| 4214 | Type: @code{string} | 4144 | Type: @code{string} |
| 4215 | 4145 | ||
| 4216 | A string which is the extension used for object files. | 4146 | A string which is the extension used for object files. |
| 4217 | For example, C code uses .o on unix, and Emacs Lisp uses .elc. | 4147 | For example, C code uses .o on unix, and Emacs Lisp uses .elc. |
| 4218 | @refill | ||
| 4219 | 4148 | ||
| 4220 | @end table | 4149 | @end table |
| 4221 | 4150 | ||
| @@ -4285,13 +4214,11 @@ Type: @code{eieio-instance-inheritor-child} | |||
| 4285 | The parent of this instance. | 4214 | The parent of this instance. |
| 4286 | If a slot of this class is reference, and is unbound, then the parent | 4215 | If a slot of this class is reference, and is unbound, then the parent |
| 4287 | is checked for a value. | 4216 | is checked for a value. |
| 4288 | @refill | ||
| 4289 | 4217 | ||
| 4290 | @item :name | 4218 | @item :name |
| 4291 | Type: @code{string} | 4219 | Type: @code{string} |
| 4292 | 4220 | ||
| 4293 | Name of this type of compiler. | 4221 | Name of this type of compiler. |
| 4294 | @refill | ||
| 4295 | 4222 | ||
| 4296 | @item :variables | 4223 | @item :variables |
| 4297 | Type: @code{list} | 4224 | Type: @code{list} |
| @@ -4300,7 +4227,6 @@ Variables needed in the Makefile for this compiler. | |||
| 4300 | An assoc list where each element is (VARNAME . VALUE) where VARNAME | 4227 | An assoc list where each element is (VARNAME . VALUE) where VARNAME |
| 4301 | is a string, and VALUE is either a string, or a list of strings. | 4228 | is a string, and VALUE is either a string, or a list of strings. |
| 4302 | For example, GCC would define CC=gcc, and emacs would define EMACS=emacs. | 4229 | For example, GCC would define CC=gcc, and emacs would define EMACS=emacs. |
| 4303 | @refill | ||
| 4304 | 4230 | ||
| 4305 | @item :sourcetype | 4231 | @item :sourcetype |
| 4306 | Type: @code{list} | 4232 | Type: @code{list} |
| @@ -4308,7 +4234,6 @@ Type: @code{list} | |||
| 4308 | A list of @code{ede-sourcecode} @xref{ede-sourcecode}. objects this class will handle. | 4234 | A list of @code{ede-sourcecode} @xref{ede-sourcecode}. objects this class will handle. |
| 4309 | This is used to match target objects with the compilers and linkers | 4235 | This is used to match target objects with the compilers and linkers |
| 4310 | they can use, and which files this object is interested in. | 4236 | they can use, and which files this object is interested in. |
| 4311 | @refill | ||
| 4312 | 4237 | ||
| 4313 | @item :commands | 4238 | @item :commands |
| 4314 | Type: @code{list} | 4239 | Type: @code{list} |
| @@ -4316,21 +4241,18 @@ Type: @code{list} | |||
| 4316 | The commands used to execute this compiler. | 4241 | The commands used to execute this compiler. |
| 4317 | The object which uses this compiler will place these commands after | 4242 | The object which uses this compiler will place these commands after |
| 4318 | it's rule definition. | 4243 | it's rule definition. |
| 4319 | @refill | ||
| 4320 | 4244 | ||
| 4321 | @item :objectextention | 4245 | @item :objectextention |
| 4322 | Type: @code{string} | 4246 | Type: @code{string} |
| 4323 | 4247 | ||
| 4324 | A string which is the extension used for object files. | 4248 | A string which is the extension used for object files. |
| 4325 | For example, C code uses .o on unix, and Emacs Lisp uses .elc. | 4249 | For example, C code uses .o on unix, and Emacs Lisp uses .elc. |
| 4326 | @refill | ||
| 4327 | 4250 | ||
| 4328 | @item :makedepends | 4251 | @item :makedepends |
| 4329 | Type: @code{boolean} @* | 4252 | Type: @code{boolean} @* |
| 4330 | Default Value: @code{nil} | 4253 | Default Value: @code{nil} |
| 4331 | 4254 | ||
| 4332 | Non-@code{nil} if this compiler can make dependencies. | 4255 | Non-@code{nil} if this compiler can make dependencies. |
| 4333 | @refill | ||
| 4334 | 4256 | ||
| 4335 | @item :uselinker | 4257 | @item :uselinker |
| 4336 | Type: @code{boolean} @* | 4258 | Type: @code{boolean} @* |
| @@ -4339,7 +4261,6 @@ Default Value: @code{nil} | |||
| 4339 | Non-@code{nil} if this compiler creates code that can be linked. | 4261 | Non-@code{nil} if this compiler creates code that can be linked. |
| 4340 | This requires that the containing target also define a list of available | 4262 | This requires that the containing target also define a list of available |
| 4341 | linkers that can be used. | 4263 | linkers that can be used. |
| 4342 | @refill | ||
| 4343 | 4264 | ||
| 4344 | @end table | 4265 | @end table |
| 4345 | 4266 | ||
| @@ -4399,7 +4320,6 @@ Default Value: @code{t} | |||
| 4399 | Type: @code{list} | 4320 | Type: @code{list} |
| 4400 | 4321 | ||
| 4401 | A variable dedicated to dependency generation. | 4322 | A variable dedicated to dependency generation. |
| 4402 | @refill | ||
| 4403 | @end table | 4323 | @end table |
| 4404 | @end table | 4324 | @end table |
| 4405 | 4325 | ||
| @@ -4439,7 +4359,6 @@ No children | |||
| 4439 | Type: @code{string} | 4359 | Type: @code{string} |
| 4440 | 4360 | ||
| 4441 | Name of this type of compiler. | 4361 | Name of this type of compiler. |
| 4442 | @refill | ||
| 4443 | 4362 | ||
| 4444 | @item :variables | 4363 | @item :variables |
| 4445 | Type: @code{list} | 4364 | Type: @code{list} |
| @@ -4448,7 +4367,6 @@ Variables needed in the Makefile for this compiler. | |||
| 4448 | An assoc list where each element is (VARNAME . VALUE) where VARNAME | 4367 | An assoc list where each element is (VARNAME . VALUE) where VARNAME |
| 4449 | is a string, and VALUE is either a string, or a list of strings. | 4368 | is a string, and VALUE is either a string, or a list of strings. |
| 4450 | For example, GCC would define CC=gcc, and emacs would define EMACS=emacs. | 4369 | For example, GCC would define CC=gcc, and emacs would define EMACS=emacs. |
| 4451 | @refill | ||
| 4452 | 4370 | ||
| 4453 | @item :sourcetype | 4371 | @item :sourcetype |
| 4454 | Type: @code{list} | 4372 | Type: @code{list} |
| @@ -4456,7 +4374,6 @@ Type: @code{list} | |||
| 4456 | A list of @code{ede-sourcecode} @xref{ede-sourcecode}. objects this class will handle. | 4374 | A list of @code{ede-sourcecode} @xref{ede-sourcecode}. objects this class will handle. |
| 4457 | This is used to match target objects with the compilers and linkers | 4375 | This is used to match target objects with the compilers and linkers |
| 4458 | they can use, and which files this object is interested in. | 4376 | they can use, and which files this object is interested in. |
| 4459 | @refill | ||
| 4460 | 4377 | ||
| 4461 | @item :commands | 4378 | @item :commands |
| 4462 | Type: @code{list} | 4379 | Type: @code{list} |
| @@ -4464,14 +4381,12 @@ Type: @code{list} | |||
| 4464 | The commands used to execute this compiler. | 4381 | The commands used to execute this compiler. |
| 4465 | The object which uses this compiler will place these commands after | 4382 | The object which uses this compiler will place these commands after |
| 4466 | it's rule definition. | 4383 | it's rule definition. |
| 4467 | @refill | ||
| 4468 | 4384 | ||
| 4469 | @item :objectextention | 4385 | @item :objectextention |
| 4470 | Type: @code{string} | 4386 | Type: @code{string} |
| 4471 | 4387 | ||
| 4472 | A string which is the extension used for object files. | 4388 | A string which is the extension used for object files. |
| 4473 | For example, C code uses .o on unix, and Emacs Lisp uses .elc. | 4389 | For example, C code uses .o on unix, and Emacs Lisp uses .elc. |
| 4474 | @refill | ||
| 4475 | 4390 | ||
| 4476 | @end table | 4391 | @end table |
| 4477 | @end table | 4392 | @end table |
diff --git a/doc/misc/eieio.texi b/doc/misc/eieio.texi index e199417aa9d..5b9f3a8e004 100644 --- a/doc/misc/eieio.texi +++ b/doc/misc/eieio.texi | |||
| @@ -1625,7 +1625,6 @@ inherit from a special class stored in | |||
| 1625 | with it, certain default methods or attributes can be added to all | 1625 | with it, certain default methods or attributes can be added to all |
| 1626 | objects. In CLOS, this would be named @code{STANDARD-CLASS}, and that | 1626 | objects. In CLOS, this would be named @code{STANDARD-CLASS}, and that |
| 1627 | symbol is an alias to @code{eieio-default-superclass}. | 1627 | symbol is an alias to @code{eieio-default-superclass}. |
| 1628 | @refill | ||
| 1629 | 1628 | ||
| 1630 | Currently, the default superclass is defined as follows: | 1629 | Currently, the default superclass is defined as follows: |
| 1631 | 1630 | ||
diff --git a/doc/misc/eshell.texi b/doc/misc/eshell.texi index bbe741a7a1d..e8fab42b899 100644 --- a/doc/misc/eshell.texi +++ b/doc/misc/eshell.texi | |||
| @@ -158,25 +158,25 @@ The following persons have made contributions to Eshell. | |||
| 158 | @item | 158 | @item |
| 159 | Eli Zaretskii made it possible for Eshell to run without requiring | 159 | Eli Zaretskii made it possible for Eshell to run without requiring |
| 160 | asynchronous subprocess support. This is important for MS-DOS, which | 160 | asynchronous subprocess support. This is important for MS-DOS, which |
| 161 | does not have such support.@refill | 161 | does not have such support. |
| 162 | 162 | ||
| 163 | @item | 163 | @item |
| 164 | Miles Bader contributed many fixes during the port to Emacs 21.@refill | 164 | Miles Bader contributed many fixes during the port to Emacs 21. |
| 165 | 165 | ||
| 166 | @item | 166 | @item |
| 167 | Stefan Monnier fixed the things which bothered him, which of course made | 167 | Stefan Monnier fixed the things which bothered him, which of course made |
| 168 | things better for all.@refill | 168 | things better for all. |
| 169 | 169 | ||
| 170 | @item | 170 | @item |
| 171 | Gerd Moellmann also helped to contribute bug fixes during the initial | 171 | Gerd Moellmann also helped to contribute bug fixes during the initial |
| 172 | integration with Emacs 21.@refill | 172 | integration with Emacs 21. |
| 173 | 173 | ||
| 174 | @item | 174 | @item |
| 175 | Alex Schroeder contributed code for interactively querying the user | 175 | Alex Schroeder contributed code for interactively querying the user |
| 176 | before overwriting files.@refill | 176 | before overwriting files. |
| 177 | 177 | ||
| 178 | @item | 178 | @item |
| 179 | Sudish Joseph helped with some XEmacs compatibility issues.@refill | 179 | Sudish Joseph helped with some XEmacs compatibility issues. |
| 180 | @end itemize | 180 | @end itemize |
| 181 | 181 | ||
| 182 | Apart from these, a lot of people have sent suggestions, ideas, | 182 | Apart from these, a lot of people have sent suggestions, ideas, |
diff --git a/doc/misc/pcl-cvs.texi b/doc/misc/pcl-cvs.texi index 1276eb95aa8..11123f977a0 100644 --- a/doc/misc/pcl-cvs.texi +++ b/doc/misc/pcl-cvs.texi | |||
| @@ -176,18 +176,18 @@ PCL-CVS as well as all the documentation. | |||
| 176 | Inge Wallin wrote the skeleton of | 176 | Inge Wallin wrote the skeleton of |
| 177 | @file{pcl-cvs.texi}, and gave useful comments on it. He also wrote | 177 | @file{pcl-cvs.texi}, and gave useful comments on it. He also wrote |
| 178 | the files @file{elib-node.el} and @file{compile-all.el}. The file | 178 | the files @file{elib-node.el} and @file{compile-all.el}. The file |
| 179 | @file{cookie.el} was inspired by Inge.@refill | 179 | @file{cookie.el} was inspired by Inge. |
| 180 | 180 | ||
| 181 | @item | 181 | @item |
| 182 | @c linus@@lysator.liu.se | 182 | @c linus@@lysator.liu.se |
| 183 | Linus Tolke contributed useful comments | 183 | Linus Tolke contributed useful comments |
| 184 | on both the functionality and the documentation.@refill | 184 | on both the functionality and the documentation. |
| 185 | 185 | ||
| 186 | @item | 186 | @item |
| 187 | @c jwz@@jwz.com | 187 | @c jwz@@jwz.com |
| 188 | Jamie Zawinski contributed | 188 | Jamie Zawinski contributed |
| 189 | @file{pcl-cvs-lucid.el}, which was later renamed to | 189 | @file{pcl-cvs-lucid.el}, which was later renamed to |
| 190 | @file{pcl-cvs-xemacs.el}.@refill | 190 | @file{pcl-cvs-xemacs.el}. |
| 191 | 191 | ||
| 192 | @item | 192 | @item |
| 193 | Leif Lonnblad contributed RCVS support (since superseded by the new | 193 | Leif Lonnblad contributed RCVS support (since superseded by the new |
| @@ -297,7 +297,7 @@ You can move the cursor up and down in the buffer with @kbd{C-n} and | |||
| 297 | repository. @xref{Committing changes}. You can also press @kbd{O} to | 297 | repository. @xref{Committing changes}. You can also press @kbd{O} to |
| 298 | update any of the files that are marked @samp{Need-Update}. You can | 298 | update any of the files that are marked @samp{Need-Update}. You can |
| 299 | also run @kbd{M-x cvs-update @key{RET}} (bound to @kbd{M-u} in the | 299 | also run @kbd{M-x cvs-update @key{RET}} (bound to @kbd{M-u} in the |
| 300 | @samp{*cvs*} buffer) to update all the files.@refill | 300 | @samp{*cvs*} buffer) to update all the files. |
| 301 | 301 | ||
| 302 | You can then press @kbd{=} to easily get a @samp{diff} between your | 302 | You can then press @kbd{=} to easily get a @samp{diff} between your |
| 303 | modified file and the base version that you started from, or you can | 303 | modified file and the base version that you started from, or you can |
| @@ -324,7 +324,7 @@ how we got to the current state, for example @samp{patched}, | |||
| 324 | 324 | ||
| 325 | @item | 325 | @item |
| 326 | An asterisk when the file is @dfn{marked} (@pxref{Selected | 326 | An asterisk when the file is @dfn{marked} (@pxref{Selected |
| 327 | files}).@refill | 327 | files}). |
| 328 | 328 | ||
| 329 | @item | 329 | @item |
| 330 | The actual status of the file wrt the repository. See below. | 330 | The actual status of the file wrt the repository. See below. |
| @@ -350,7 +350,7 @@ the following substatus: | |||
| 350 | @item merged | 350 | @item merged |
| 351 | The file was modified in your working directory, and there were | 351 | The file was modified in your working directory, and there were |
| 352 | modifications in the repository as well, but they were merged | 352 | modifications in the repository as well, but they were merged |
| 353 | successfully, without conflict, in your working directory.@refill | 353 | successfully, without conflict, in your working directory. |
| 354 | @end table | 354 | @end table |
| 355 | 355 | ||
| 356 | @item Conflict | 356 | @item Conflict |
| @@ -360,7 +360,7 @@ working directory) is now the output of the @code{rcsmerge} command on | |||
| 360 | the two versions; an unmodified copy of your file is also in your | 360 | the two versions; an unmodified copy of your file is also in your |
| 361 | working directory, with the name @file{.#@var{file}.@var{version}}, | 361 | working directory, with the name @file{.#@var{file}.@var{version}}, |
| 362 | where @var{version} is the RCS revision that your modified file started | 362 | where @var{version} is the RCS revision that your modified file started |
| 363 | from. @xref{Viewing differences}, for more details.@refill | 363 | from. @xref{Viewing differences}, for more details. |
| 364 | 364 | ||
| 365 | A conflict can also come from a disagreement on the existence of the file | 365 | A conflict can also come from a disagreement on the existence of the file |
| 366 | rather than on its content. This case is indicated by the following | 366 | rather than on its content. This case is indicated by the following |
| @@ -382,17 +382,17 @@ repository. | |||
| 382 | 382 | ||
| 383 | @item Added | 383 | @item Added |
| 384 | The file has been added by you, but it still needs to be checked in to | 384 | The file has been added by you, but it still needs to be checked in to |
| 385 | the repository.@refill | 385 | the repository. |
| 386 | 386 | ||
| 387 | @item Removed | 387 | @item Removed |
| 388 | The file has been removed by you, but it still needs to be checked in to | 388 | The file has been removed by you, but it still needs to be checked in to |
| 389 | the repository. You can resurrect it by typing @kbd{a} (@pxref{Adding | 389 | the repository. You can resurrect it by typing @kbd{a} (@pxref{Adding |
| 390 | and removing files}).@refill | 390 | and removing files}). |
| 391 | 391 | ||
| 392 | @item Unknown | 392 | @item Unknown |
| 393 | A file that was detected in your directory, but that neither appears in | 393 | A file that was detected in your directory, but that neither appears in |
| 394 | the repository, nor is present on the list of files that CVS should | 394 | the repository, nor is present on the list of files that CVS should |
| 395 | ignore.@refill | 395 | ignore. |
| 396 | 396 | ||
| 397 | @item Up-to-date | 397 | @item Up-to-date |
| 398 | The file is up to date with respect to the version in the repository. | 398 | The file is up to date with respect to the version in the repository. |
| @@ -400,29 +400,29 @@ This status can have a substatus of: | |||
| 400 | 400 | ||
| 401 | @table @samp | 401 | @table @samp |
| 402 | @item added | 402 | @item added |
| 403 | You have just added the file to the repository.@refill | 403 | You have just added the file to the repository. |
| 404 | 404 | ||
| 405 | @item updated | 405 | @item updated |
| 406 | The file was brought up to date with respect to the repository. This is | 406 | The file was brought up to date with respect to the repository. This is |
| 407 | done for any file that exists in the repository but not in your source, | 407 | done for any file that exists in the repository but not in your source, |
| 408 | and for files that you haven't changed but are not the most recent | 408 | and for files that you haven't changed but are not the most recent |
| 409 | versions available in the repository.@refill | 409 | versions available in the repository. |
| 410 | 410 | ||
| 411 | @item patched | 411 | @item patched |
| 412 | The file was brought up to date with respect to the remote repository by | 412 | The file was brought up to date with respect to the remote repository by |
| 413 | way of fetching and applying a patch to the file in your source. This | 413 | way of fetching and applying a patch to the file in your source. This |
| 414 | is equivalent to @samp{updated} except that CVS decided to use a hopefully | 414 | is equivalent to @samp{updated} except that CVS decided to use a hopefully |
| 415 | more efficient method.@refill | 415 | more efficient method. |
| 416 | 416 | ||
| 417 | @item committed | 417 | @item committed |
| 418 | You just committed the file.@refill | 418 | You just committed the file. |
| 419 | @end table | 419 | @end table |
| 420 | 420 | ||
| 421 | @item Need-Update | 421 | @item Need-Update |
| 422 | Either a newer version than the one in your source is available in the | 422 | Either a newer version than the one in your source is available in the |
| 423 | repository and you have not modified your checked out version, or the | 423 | repository and you have not modified your checked out version, or the |
| 424 | file exists in the repository but not in your source. Use | 424 | file exists in the repository but not in your source. Use |
| 425 | @samp{cvs-mode-update} bound to @kbd{O} to update the file.@refill | 425 | @samp{cvs-mode-update} bound to @kbd{O} to update the file. |
| 426 | 426 | ||
| 427 | @item Need-Merge | 427 | @item Need-Merge |
| 428 | You have modified the checked out version of the file, and a newer | 428 | You have modified the checked out version of the file, and a newer |
| @@ -610,11 +610,11 @@ explicitly. The special prefixes are: | |||
| 610 | 610 | ||
| 611 | @table @kbd | 611 | @table @kbd |
| 612 | @item T | 612 | @item T |
| 613 | Toggles whether or not marks will be active in the next command.@refill | 613 | Toggles whether or not marks will be active in the next command. |
| 614 | 614 | ||
| 615 | @item b | 615 | @item b |
| 616 | Provide the next command with a branch (can be any version | 616 | Provide the next command with a branch (can be any version |
| 617 | specifier) to work on.@refill | 617 | specifier) to work on. |
| 618 | 618 | ||
| 619 | @item B | 619 | @item B |
| 620 | Secondary branch argument. Only meaningful if @kbd{b} is also used. | 620 | Secondary branch argument. Only meaningful if @kbd{b} is also used. |
| @@ -640,13 +640,13 @@ to update the display: | |||
| 640 | 640 | ||
| 641 | @table @kbd | 641 | @table @kbd |
| 642 | @item M-u | 642 | @item M-u |
| 643 | Runs the command @samp{cvs-update}.@refill | 643 | Runs the command @samp{cvs-update}. |
| 644 | 644 | ||
| 645 | @item M-e | 645 | @item M-e |
| 646 | Runs the command @samp{cvs-examine}.@refill | 646 | Runs the command @samp{cvs-examine}. |
| 647 | 647 | ||
| 648 | @item M-s | 648 | @item M-s |
| 649 | Runs the command @samp{cvs-status}.@refill | 649 | Runs the command @samp{cvs-status}. |
| 650 | @end table | 650 | @end table |
| 651 | 651 | ||
| 652 | In addition to the above commands which operate on the whole module, | 652 | In addition to the above commands which operate on the whole module, |
| @@ -656,18 +656,18 @@ files/directories with these keys: | |||
| 656 | @table @kbd | 656 | @table @kbd |
| 657 | @item O | 657 | @item O |
| 658 | Runs @code{cvs-mode-update} on the selected files. When run on the | 658 | Runs @code{cvs-mode-update} on the selected files. When run on the |
| 659 | top-level directory, this is equivalent to @kbd{M-u}.@refill | 659 | top-level directory, this is equivalent to @kbd{M-u}. |
| 660 | 660 | ||
| 661 | @item e | 661 | @item e |
| 662 | Runs @code{cvs-mode-examine} on the selected files. When run on the | 662 | Runs @code{cvs-mode-examine} on the selected files. When run on the |
| 663 | top-level directory, this is equivalent to @kbd{M-e}.@refill | 663 | top-level directory, this is equivalent to @kbd{M-e}. |
| 664 | 664 | ||
| 665 | @findex cvs-status-mode | 665 | @findex cvs-status-mode |
| 666 | @item s | 666 | @item s |
| 667 | Runs @code{cvs-mode-status} on the selected files. When run on the | 667 | Runs @code{cvs-mode-status} on the selected files. When run on the |
| 668 | top-level directory, this is equivalent to @kbd{M-s}, except that | 668 | top-level directory, this is equivalent to @kbd{M-s}, except that |
| 669 | CVS output will be shown in a @samp{*cvs-info*} buffer that will be | 669 | CVS output will be shown in a @samp{*cvs-info*} buffer that will be |
| 670 | put in @samp{cvs-status-mode}.@refill | 670 | put in @samp{cvs-status-mode}. |
| 671 | @end table | 671 | @end table |
| 672 | 672 | ||
| 673 | 673 | ||
| @@ -689,7 +689,7 @@ the fact that the buffer is a PCL-CVS buffer: | |||
| 689 | @item @key{SPC} | 689 | @item @key{SPC} |
| 690 | @itemx n | 690 | @itemx n |
| 691 | These keys move the cursor one file forward, towards the end of the | 691 | These keys move the cursor one file forward, towards the end of the |
| 692 | buffer (@code{cvs-mode-next-line}).@refill | 692 | buffer (@code{cvs-mode-next-line}). |
| 693 | 693 | ||
| 694 | @item p | 694 | @item p |
| 695 | This key moves one file backward, towards the beginning of the buffer | 695 | This key moves one file backward, towards the beginning of the buffer |
| @@ -725,12 +725,12 @@ You can mark and unmark files with these commands: | |||
| 725 | @item m | 725 | @item m |
| 726 | This marks the file that the cursor is positioned on. If the cursor is | 726 | This marks the file that the cursor is positioned on. If the cursor is |
| 727 | positioned on a directory all files in that directory are marked | 727 | positioned on a directory all files in that directory are marked |
| 728 | (@code{cvs-mode-mark}).@refill | 728 | (@code{cvs-mode-mark}). |
| 729 | 729 | ||
| 730 | @item u | 730 | @item u |
| 731 | Unmark the file that the cursor is positioned on. If the cursor is on a | 731 | Unmark the file that the cursor is positioned on. If the cursor is on a |
| 732 | directory, all files in that directory are unmarked | 732 | directory, all files in that directory are unmarked |
| 733 | (@code{cvs-mode-unmark}).@refill | 733 | (@code{cvs-mode-unmark}). |
| 734 | 734 | ||
| 735 | @item M | 735 | @item M |
| 736 | Mark @emph{all} files in the buffer (@code{cvs-mode-mark-all-files}). | 736 | Mark @emph{all} files in the buffer (@code{cvs-mode-mark-all-files}). |
| @@ -774,7 +774,7 @@ Committing changes basically works as follows: | |||
| 774 | @item | 774 | @item |
| 775 | After having selected the files you want to commit, you type either | 775 | After having selected the files you want to commit, you type either |
| 776 | @kbd{c} or @kbd{C} which brings up a special buffer | 776 | @kbd{c} or @kbd{C} which brings up a special buffer |
| 777 | @samp{*cvs-commit*}.@refill | 777 | @samp{*cvs-commit*}. |
| 778 | 778 | ||
| 779 | @item | 779 | @item |
| 780 | You type in the log message describing the changes you're about to | 780 | You type in the log message describing the changes you're about to |
| @@ -782,7 +782,7 @@ commit (@pxref{Log Edit Mode}). | |||
| 782 | 782 | ||
| 783 | @item | 783 | @item |
| 784 | When you're happy with it, you type @kbd{C-c C-c} to do the actual | 784 | When you're happy with it, you type @kbd{C-c C-c} to do the actual |
| 785 | commit.@refill | 785 | commit. |
| 786 | @end enumerate | 786 | @end enumerate |
| 787 | 787 | ||
| 788 | There's no hidden state, so you can abort the process or pick it up | 788 | There's no hidden state, so you can abort the process or pick it up |
| @@ -841,13 +841,13 @@ the cursor points to a directory, run @code{dired} on that directory; | |||
| 841 | 841 | ||
| 842 | @item o | 842 | @item o |
| 843 | Like @kbd{f}, but use another window | 843 | Like @kbd{f}, but use another window |
| 844 | (@code{cvs-mode-find-file-other-window}).@refill | 844 | (@code{cvs-mode-find-file-other-window}). |
| 845 | 845 | ||
| 846 | @item A | 846 | @item A |
| 847 | Invoke @samp{add-change-log-entry-other-window} to edit a | 847 | Invoke @samp{add-change-log-entry-other-window} to edit a |
| 848 | @file{ChangeLog} file. The @file{ChangeLog} file will be found in the | 848 | @file{ChangeLog} file. The @file{ChangeLog} file will be found in the |
| 849 | directory of the file the cursor points to, or in a parent of that | 849 | directory of the file the cursor points to, or in a parent of that |
| 850 | directory (@code{cvs-mode-add-change-log-entry-other-window}).@refill | 850 | directory (@code{cvs-mode-add-change-log-entry-other-window}). |
| 851 | @end table | 851 | @end table |
| 852 | 852 | ||
| 853 | 853 | ||
| @@ -897,7 +897,7 @@ Add all selected files. This command can be used on @samp{Unknown} | |||
| 897 | files (@pxref{Buffer contents}). The status of the file will change to | 897 | files (@pxref{Buffer contents}). The status of the file will change to |
| 898 | @samp{Added}, and you will have to use @kbd{c} (@samp{cvs-mode-commit} | 898 | @samp{Added}, and you will have to use @kbd{c} (@samp{cvs-mode-commit} |
| 899 | @pxref{Committing changes}), to really add the file to the | 899 | @pxref{Committing changes}), to really add the file to the |
| 900 | repository.@refill | 900 | repository. |
| 901 | 901 | ||
| 902 | This command can also be used on @samp{Removed} files (before you commit | 902 | This command can also be used on @samp{Removed} files (before you commit |
| 903 | them) to resurrect them. | 903 | them) to resurrect them. |
| @@ -911,7 +911,7 @@ confirmation). The files are deleted from your directory and | |||
| 911 | also be @samp{cvs remove}d. If the files' status was @samp{Unknown} | 911 | also be @samp{cvs remove}d. If the files' status was @samp{Unknown} |
| 912 | they will disappear from the buffer. Otherwise their status will change to | 912 | they will disappear from the buffer. Otherwise their status will change to |
| 913 | @samp{Removed}, and you must use @kbd{c} (@samp{cvs-mode-commit}, | 913 | @samp{Removed}, and you must use @kbd{c} (@samp{cvs-mode-commit}, |
| 914 | @pxref{Committing changes}) to commit the removal.@refill | 914 | @pxref{Committing changes}) to commit the removal. |
| 915 | 915 | ||
| 916 | The command that is run is @code{cvs-mode-remove-file}. | 916 | The command that is run is @code{cvs-mode-remove-file}. |
| 917 | @end table | 917 | @end table |
| @@ -957,7 +957,7 @@ get an overview of what needs to be done. | |||
| 957 | @vindex cvs-mode-remove-handled@r{ (variable)} | 957 | @vindex cvs-mode-remove-handled@r{ (variable)} |
| 958 | @kbd{x} invokes @code{cvs-mode-remove-handled}. If | 958 | @kbd{x} invokes @code{cvs-mode-remove-handled}. If |
| 959 | @samp{cvs-auto-remove-handled} is set to non-@code{nil}, this will | 959 | @samp{cvs-auto-remove-handled} is set to non-@code{nil}, this will |
| 960 | automatically be performed after every commit.@refill | 960 | automatically be performed after every commit. |
| 961 | 961 | ||
| 962 | @item C-k | 962 | @item C-k |
| 963 | This command can be used for lines that @samp{cvs-mode-remove-handled} would | 963 | This command can be used for lines that @samp{cvs-mode-remove-handled} would |
| @@ -1008,22 +1008,22 @@ This runs @code{cvs-mode-ignore}. | |||
| 1008 | @item = | 1008 | @item = |
| 1009 | @itemx d = | 1009 | @itemx d = |
| 1010 | Display a @samp{cvs diff} between the selected files and the version | 1010 | Display a @samp{cvs diff} between the selected files and the version |
| 1011 | that they are based on (@code{cvs-mode-diff}).@refill | 1011 | that they are based on (@code{cvs-mode-diff}). |
| 1012 | 1012 | ||
| 1013 | @item d b | 1013 | @item d b |
| 1014 | If CVS finds a conflict while merging two versions of a file (during a | 1014 | If CVS finds a conflict while merging two versions of a file (during a |
| 1015 | @samp{cvs update}, @pxref{Updating the buffer}) it will save the | 1015 | @samp{cvs update}, @pxref{Updating the buffer}) it will save the |
| 1016 | original file in a file called @file{.#@var{file}.@var{version}} where | 1016 | original file in a file called @file{.#@var{file}.@var{version}} where |
| 1017 | @var{file} is the name of the file, and @var{version} is the revision | 1017 | @var{file} is the name of the file, and @var{version} is the revision |
| 1018 | number that @var{file} was based on.@refill | 1018 | number that @var{file} was based on. |
| 1019 | 1019 | ||
| 1020 | With the @kbd{d b} command you can run a @samp{diff} on the files | 1020 | With the @kbd{d b} command you can run a @samp{diff} on the files |
| 1021 | @file{.#@var{file}.@var{version}} and @file{@var{file}}.@refill | 1021 | @file{.#@var{file}.@var{version}} and @file{@var{file}}. |
| 1022 | 1022 | ||
| 1023 | @item d h | 1023 | @item d h |
| 1024 | Display a @samp{cvs diff} between the selected files and the head | 1024 | Display a @samp{cvs diff} between the selected files and the head |
| 1025 | revision (the most recent version on the current | 1025 | revision (the most recent version on the current |
| 1026 | branch) in the repository (@code{cvs-mode-diff-head}).@refill | 1026 | branch) in the repository (@code{cvs-mode-diff-head}). |
| 1027 | 1027 | ||
| 1028 | @item d r | 1028 | @item d r |
| 1029 | Display a @samp{cvs diff} between the base revision of the selected | 1029 | Display a @samp{cvs diff} between the base revision of the selected |
| @@ -1035,12 +1035,12 @@ a checkout, update or commit operation | |||
| 1035 | @item d v | 1035 | @item d v |
| 1036 | Display a @samp{cvs diff} between the selected files and the head | 1036 | Display a @samp{cvs diff} between the selected files and the head |
| 1037 | revision of the vendor branch in the repository | 1037 | revision of the vendor branch in the repository |
| 1038 | (@code{cvs-mode-diff-vendor}).@refill | 1038 | (@code{cvs-mode-diff-vendor}). |
| 1039 | 1039 | ||
| 1040 | @item d y | 1040 | @item d y |
| 1041 | Display a @samp{cvs diff} between the selected files and yesterday's | 1041 | Display a @samp{cvs diff} between the selected files and yesterday's |
| 1042 | head revision in the repository | 1042 | head revision in the repository |
| 1043 | (@code{cvs-mode-diff-yesterday}).@refill | 1043 | (@code{cvs-mode-diff-yesterday}). |
| 1044 | @end table | 1044 | @end table |
| 1045 | 1045 | ||
| 1046 | By default, @samp{diff} commands ignore the marks. This can be changed | 1046 | By default, @samp{diff} commands ignore the marks. This can be changed |
| @@ -1075,7 +1075,7 @@ to do an interactive 3-way merge. | |||
| 1075 | CVS has already performed a merge. The resulting file is not used in | 1075 | CVS has already performed a merge. The resulting file is not used in |
| 1076 | any way if you use this command. If you use the @kbd{q} command inside | 1076 | any way if you use this command. If you use the @kbd{q} command inside |
| 1077 | @samp{ediff} (to successfully terminate a merge) the file that CVS | 1077 | @samp{ediff} (to successfully terminate a merge) the file that CVS |
| 1078 | created will be overwritten.@refill | 1078 | created will be overwritten. |
| 1079 | @end table | 1079 | @end table |
| 1080 | 1080 | ||
| 1081 | @node Updating files | 1081 | @node Updating files |
| @@ -1247,24 +1247,24 @@ argument, these commands move that many messages of files. | |||
| 1247 | 1247 | ||
| 1248 | If you have an idea about any customization that would be handy but | 1248 | If you have an idea about any customization that would be handy but |
| 1249 | isn't present in this list, please tell us! | 1249 | isn't present in this list, please tell us! |
| 1250 | For info on how to reach us, see @ref{Bugs}.@refill | 1250 | For info on how to reach us, see @ref{Bugs}. |
| 1251 | 1251 | ||
| 1252 | @table @samp | 1252 | @table @samp |
| 1253 | @item cvs-auto-remove-handled | 1253 | @item cvs-auto-remove-handled |
| 1254 | If this variable is set to any non-@code{nil} value, | 1254 | If this variable is set to any non-@code{nil} value, |
| 1255 | @samp{cvs-mode-remove-handled} will be called every time you check in | 1255 | @samp{cvs-mode-remove-handled} will be called every time you check in |
| 1256 | files, after the check-in is ready. @xref{Removing handled | 1256 | files, after the check-in is ready. @xref{Removing handled |
| 1257 | entries}.@refill | 1257 | entries}. |
| 1258 | 1258 | ||
| 1259 | @item cvs-auto-remove-directories | 1259 | @item cvs-auto-remove-directories |
| 1260 | If this variable is set to any non-@code{nil} value, directories that do | 1260 | If this variable is set to any non-@code{nil} value, directories that do |
| 1261 | not contain any files to be checked in will not be listed in the | 1261 | not contain any files to be checked in will not be listed in the |
| 1262 | @samp{*cvs*} buffer.@refill | 1262 | @samp{*cvs*} buffer. |
| 1263 | 1263 | ||
| 1264 | @item cvs-auto-revert | 1264 | @item cvs-auto-revert |
| 1265 | If this variable is set to any non-@samp{nil} value any buffers you have | 1265 | If this variable is set to any non-@samp{nil} value any buffers you have |
| 1266 | that visit a file that is committed will be automatically reverted. | 1266 | that visit a file that is committed will be automatically reverted. |
| 1267 | This variable defaults to @samp{t}. @xref{Committing changes}.@refill | 1267 | This variable defaults to @samp{t}. @xref{Committing changes}. |
| 1268 | 1268 | ||
| 1269 | @item cvs-update-prog-output-skip-regexp | 1269 | @item cvs-update-prog-output-skip-regexp |
| 1270 | The @samp{-u} flag in the @file{modules} file can be used to run a command | 1270 | The @samp{-u} flag in the @file{modules} file can be used to run a command |
diff --git a/doc/misc/sc.texi b/doc/misc/sc.texi index aa0752c80cd..11dbf2eda5e 100644 --- a/doc/misc/sc.texi +++ b/doc/misc/sc.texi | |||
| @@ -146,7 +146,7 @@ Supercite should provide them. For example, many people would like to | |||
| 146 | be able to yank (and cite) only a portion of the original message. | 146 | be able to yank (and cite) only a portion of the original message. |
| 147 | Since Supercite only modifies the text it finds in the reply buffer as | 147 | Since Supercite only modifies the text it finds in the reply buffer as |
| 148 | set up by the MUA, it is the MUA's responsibility to do partial yanking. | 148 | set up by the MUA, it is the MUA's responsibility to do partial yanking. |
| 149 | @xref{Reply Buffer Initialization}.@refill | 149 | @xref{Reply Buffer Initialization}. |
| 150 | 150 | ||
| 151 | @vindex mail-header-separator | 151 | @vindex mail-header-separator |
| 152 | Another potentially useful thing would be for Supercite to set up the | 152 | Another potentially useful thing would be for Supercite to set up the |
| @@ -156,7 +156,7 @@ But by previously agreed upon convention, any text above the | |||
| 156 | bodies cannot be modified by Supercite. Supercite, in fact, doesn't | 156 | bodies cannot be modified by Supercite. Supercite, in fact, doesn't |
| 157 | know anything about the meaning of these headers, and never ventures | 157 | know anything about the meaning of these headers, and never ventures |
| 158 | outside the designated region. @xref{Hints to MUA Authors}, for more | 158 | outside the designated region. @xref{Hints to MUA Authors}, for more |
| 159 | details.@refill | 159 | details. |
| 160 | 160 | ||
| 161 | @node What Supercite Does | 161 | @node What Supercite Does |
| 162 | @section What Supercite Does | 162 | @section What Supercite Does |
| @@ -168,14 +168,14 @@ by calling a hook variable to which Supercite's top-level function | |||
| 168 | @code{sc-cite-original} has been added. When @code{sc-cite-original} is | 168 | @code{sc-cite-original} has been added. When @code{sc-cite-original} is |
| 169 | executed, the original message must be set up in a very specific way, | 169 | executed, the original message must be set up in a very specific way, |
| 170 | but this is handled automatically by the MUA@. @xref{Hints to MUA | 170 | but this is handled automatically by the MUA@. @xref{Hints to MUA |
| 171 | Authors}.@refill | 171 | Authors}. |
| 172 | 172 | ||
| 173 | @cindex info alist | 173 | @cindex info alist |
| 174 | The first thing Supercite does, via @code{sc-cite-original}, is to parse | 174 | The first thing Supercite does, via @code{sc-cite-original}, is to parse |
| 175 | through the original message's mail headers. It saves this data in an | 175 | through the original message's mail headers. It saves this data in an |
| 176 | @dfn{information association list}, or @dfn{info alist}. The information | 176 | @dfn{information association list}, or @dfn{info alist}. The information |
| 177 | in this list is used in a number of places throughout Supercite. | 177 | in this list is used in a number of places throughout Supercite. |
| 178 | @xref{Information Keys and the Info Alist}.@refill | 178 | @xref{Information Keys and the Info Alist}. |
| 179 | 179 | ||
| 180 | @cindex nuking mail headers | 180 | @cindex nuking mail headers |
| 181 | @cindex reference header | 181 | @cindex reference header |
| @@ -207,7 +207,7 @@ Supercited text and will fill them appropriately. Emacs's built-in | |||
| 207 | filling routines, e.g., @code{fill-paragraph}, do not recognize cited | 207 | filling routines, e.g., @code{fill-paragraph}, do not recognize cited |
| 208 | text and will not re-fill them properly because it cannot guess the | 208 | text and will not re-fill them properly because it cannot guess the |
| 209 | @code{fill-prefix} being used. | 209 | @code{fill-prefix} being used. |
| 210 | @xref{Post-yank Formatting Commands}, for details.@refill | 210 | @xref{Post-yank Formatting Commands}, for details. |
| 211 | 211 | ||
| 212 | As mentioned above, Supercite provides commands to recite or uncite | 212 | As mentioned above, Supercite provides commands to recite or uncite |
| 213 | regions of text in the reply buffer, and commands to perform other | 213 | regions of text in the reply buffer, and commands to perform other |
| @@ -216,7 +216,7 @@ informative citations throughout. Supercite tries to be as configurable | |||
| 216 | as possible to allow for a wide range of personalized citation styles, | 216 | as possible to allow for a wide range of personalized citation styles, |
| 217 | but it is also immediately useful with the default configuration, once | 217 | but it is also immediately useful with the default configuration, once |
| 218 | it has been properly connected to your MUA@. @xref{Getting Connected}, | 218 | it has been properly connected to your MUA@. @xref{Getting Connected}, |
| 219 | for more details.@refill | 219 | for more details. |
| 220 | 220 | ||
| 221 | @node Citations | 221 | @node Citations |
| 222 | @chapter Citations | 222 | @chapter Citations |
| @@ -304,7 +304,7 @@ string containing four spaces. | |||
| 304 | The @dfn{attribution string}. This element is supplied automatically by | 304 | The @dfn{attribution string}. This element is supplied automatically by |
| 305 | Supercite, based on your preferences and the original message's mail | 305 | Supercite, based on your preferences and the original message's mail |
| 306 | headers, though you may be asked to confirm Supercite's choice. | 306 | headers, though you may be asked to confirm Supercite's choice. |
| 307 | @xref{Selecting an Attribution}, for more details.@refill | 307 | @xref{Selecting an Attribution}, for more details. |
| 308 | 308 | ||
| 309 | @cindex citation delimiter | 309 | @cindex citation delimiter |
| 310 | @vindex sc-citation-delimiter | 310 | @vindex sc-citation-delimiter |
| @@ -330,7 +330,7 @@ In this case, the composed, non-nested citation string used might be | |||
| 330 | something like | 330 | something like |
| 331 | @code{@asis{" Jane> "}}. | 331 | @code{@asis{" Jane> "}}. |
| 332 | This citation string will be inserted in front of | 332 | This citation string will be inserted in front of |
| 333 | every line in the original message that is not already cited.@refill | 333 | every line in the original message that is not already cited. |
| 334 | 334 | ||
| 335 | Nested citations, being simpler than non-nested citations, are composed | 335 | Nested citations, being simpler than non-nested citations, are composed |
| 336 | of the same elements, sans the attribution string. Supercite is smart | 336 | of the same elements, sans the attribution string. Supercite is smart |
| @@ -379,7 +379,7 @@ non-nested citation. Thus the variable | |||
| 379 | @code{sc-citation-nonnested-root-regexp} is used to describe only | 379 | @code{sc-citation-nonnested-root-regexp} is used to describe only |
| 380 | non-nested citation roots. It is important to remember that if you | 380 | non-nested citation roots. It is important to remember that if you |
| 381 | change @code{sc-citation-root-regexp} you should always also change | 381 | change @code{sc-citation-root-regexp} you should always also change |
| 382 | @code{sc-citation-nonnested-root-regexp}.@refill | 382 | @code{sc-citation-nonnested-root-regexp}. |
| 383 | 383 | ||
| 384 | @node Information Keys and the Info Alist | 384 | @node Information Keys and the Info Alist |
| 385 | @chapter Information Keys and the Info Alist | 385 | @chapter Information Keys and the Info Alist |
| @@ -400,7 +400,7 @@ In the case of mail fields, the key is the name of the field, omitting | |||
| 400 | the trailing colon. Info keys are always case insensitive (as are | 400 | the trailing colon. Info keys are always case insensitive (as are |
| 401 | mail headers), and the value for a corresponding key can be retrieved | 401 | mail headers), and the value for a corresponding key can be retrieved |
| 402 | from the alist with the @code{sc-mail-field} function. Thus, if the | 402 | from the alist with the @code{sc-mail-field} function. Thus, if the |
| 403 | following fields were present in the original article:@refill | 403 | following fields were present in the original article: |
| 404 | 404 | ||
| 405 | @example | 405 | @example |
| 406 | Date:@: 08 April 1991, 17:32:09 EST | 406 | Date:@: 08 April 1991, 17:32:09 EST |
| @@ -489,7 +489,7 @@ the author's first middle name. | |||
| 489 | 489 | ||
| 490 | If the author's name has more than one middle name, they will appear as | 490 | If the author's name has more than one middle name, they will appear as |
| 491 | info keys with the appropriate index (e.g., @code{"sc-middlename-2"}, | 491 | info keys with the appropriate index (e.g., @code{"sc-middlename-2"}, |
| 492 | @dots{}). @xref{Selecting an Attribution}.@refill | 492 | @dots{}). @xref{Selecting an Attribution}. |
| 493 | 493 | ||
| 494 | @node Reference Headers | 494 | @node Reference Headers |
| 495 | @chapter Reference Headers | 495 | @chapter Reference Headers |
| @@ -540,7 +540,7 @@ examples below as @var{infokey} indicates that the corresponding value | |||
| 540 | of the info key from the info alist will be inserted there. | 540 | of the info key from the info alist will be inserted there. |
| 541 | (@pxref{Information Keys and the Info Alist}). For example, in @code{sc-header-on-said} | 541 | (@pxref{Information Keys and the Info Alist}). For example, in @code{sc-header-on-said} |
| 542 | below, @var{date} and @var{from} correspond to the values of the | 542 | below, @var{date} and @var{from} correspond to the values of the |
| 543 | @samp{Date:@:} and @samp{From:@:} mail headers respectively.@refill | 543 | @samp{Date:@:} and @samp{From:@:} mail headers respectively. |
| 544 | 544 | ||
| 545 | @vindex sc-reference-tag-string | 545 | @vindex sc-reference-tag-string |
| 546 | @vindex reference-tag-string (sc-) | 546 | @vindex reference-tag-string (sc-) |
| @@ -650,7 +650,7 @@ The following commands are available while in electric reference mode | |||
| 650 | Displays the next reference header in the electric reference buffer. If | 650 | Displays the next reference header in the electric reference buffer. If |
| 651 | the variable @code{sc-electric-circular-p} is non-@code{nil}, invoking | 651 | the variable @code{sc-electric-circular-p} is non-@code{nil}, invoking |
| 652 | @code{sc-eref-next} while viewing the last reference header in the list | 652 | @code{sc-eref-next} while viewing the last reference header in the list |
| 653 | will wrap around to the first header.@refill | 653 | will wrap around to the first header. |
| 654 | 654 | ||
| 655 | @item @code{sc-eref-prev} (@kbd{p}) | 655 | @item @code{sc-eref-prev} (@kbd{p}) |
| 656 | @findex sc-eref-prev | 656 | @findex sc-eref-prev |
| @@ -658,7 +658,7 @@ will wrap around to the first header.@refill | |||
| 658 | @kindex p | 658 | @kindex p |
| 659 | Displays the previous reference header in the electric reference buffer. | 659 | Displays the previous reference header in the electric reference buffer. |
| 660 | If the variable @code{sc-electric-circular-p} is non-@code{nil}, | 660 | If the variable @code{sc-electric-circular-p} is non-@code{nil}, |
| 661 | invoking @code{sc-eref-prev} will wrap around to the last header.@refill | 661 | invoking @code{sc-eref-prev} will wrap around to the last header. |
| 662 | 662 | ||
| 663 | @item @code{sc-eref-goto} (@kbd{g}) | 663 | @item @code{sc-eref-goto} (@kbd{g}) |
| 664 | @findex sc-eref-goto | 664 | @findex sc-eref-goto |
| @@ -667,7 +667,7 @@ invoking @code{sc-eref-prev} will wrap around to the last header.@refill | |||
| 667 | Goes to a specified reference header. The index (into the | 667 | Goes to a specified reference header. The index (into the |
| 668 | @code{sc-rewrite-header-list}) can be specified as a numeric argument to | 668 | @code{sc-rewrite-header-list}) can be specified as a numeric argument to |
| 669 | the command. Otherwise, Supercite will query you for the index in the | 669 | the command. Otherwise, Supercite will query you for the index in the |
| 670 | minibuffer.@refill | 670 | minibuffer. |
| 671 | 671 | ||
| 672 | @item @code{sc-eref-jump} (@kbd{j}) | 672 | @item @code{sc-eref-jump} (@kbd{j}) |
| 673 | @findex sc-eref-jump | 673 | @findex sc-eref-jump |
| @@ -681,7 +681,7 @@ value of @code{sc-preferred-header-style}. | |||
| 681 | @findex eref-setn (sc-) | 681 | @findex eref-setn (sc-) |
| 682 | @kindex s | 682 | @kindex s |
| 683 | Set the preferred reference header (i.e., | 683 | Set the preferred reference header (i.e., |
| 684 | @code{sc-preferred-header-style}) to the currently displayed header.@refill | 684 | @code{sc-preferred-header-style}) to the currently displayed header. |
| 685 | 685 | ||
| 686 | @item @code{sc-eref-exit} (@kbd{C-j}, @key{RET}, and @key{ESC C-c}) | 686 | @item @code{sc-eref-exit} (@kbd{C-j}, @key{RET}, and @key{ESC C-c}) |
| 687 | @kindex RET | 687 | @kindex RET |
| @@ -690,7 +690,7 @@ Set the preferred reference header (i.e., | |||
| 690 | @findex sc-eref-exit | 690 | @findex sc-eref-exit |
| 691 | @findex eref-exit (sc-) | 691 | @findex eref-exit (sc-) |
| 692 | Exit from electric reference mode and insert the current header into the | 692 | Exit from electric reference mode and insert the current header into the |
| 693 | reply buffer.@refill | 693 | reply buffer. |
| 694 | 694 | ||
| 695 | @item @code{sc-eref-abort} (@kbd{q}, @kbd{x}) | 695 | @item @code{sc-eref-abort} (@kbd{q}, @kbd{x}) |
| 696 | @findex sc-eref-abort | 696 | @findex sc-eref-abort |
| @@ -729,7 +729,7 @@ hook variable has a @code{nil} value, which the MUA recognizes to mean, | |||
| 729 | ``use your default citation function.'' When you add Supercite's | 729 | ``use your default citation function.'' When you add Supercite's |
| 730 | citation function to the hook, thereby giving the variable a | 730 | citation function to the hook, thereby giving the variable a |
| 731 | non-@code{nil} value, it tells the MUA to run the hook via | 731 | non-@code{nil} value, it tells the MUA to run the hook via |
| 732 | @code{run-hooks} instead of using the default citation.@refill | 732 | @code{run-hooks} instead of using the default citation. |
| 733 | 733 | ||
| 734 | Early in Supercite's development, the Supercite author, a few MUA | 734 | Early in Supercite's development, the Supercite author, a few MUA |
| 735 | authors, and some early Supercite users got together and agreed upon a | 735 | authors, and some early Supercite users got together and agreed upon a |
| @@ -767,7 +767,7 @@ expects the original article's mail headers to be present within this | |||
| 767 | region. Note that Supercite @emph{never} touches any text outside this | 767 | region. Note that Supercite @emph{never} touches any text outside this |
| 768 | region. Note further that the region need not be active | 768 | region. Note further that the region need not be active |
| 769 | for @code{sc-cite-original} to do its job. | 769 | for @code{sc-cite-original} to do its job. |
| 770 | @xref{Hints to MUA Authors}.@refill | 770 | @xref{Hints to MUA Authors}. |
| 771 | 771 | ||
| 772 | The other step in the getting connected process is to make sure your | 772 | The other step in the getting connected process is to make sure your |
| 773 | MUA calls @code{sc-cite-original} at the right time. As mentioned | 773 | MUA calls @code{sc-cite-original} at the right time. As mentioned |
| @@ -784,7 +784,7 @@ this hook since it is only run once. This will not work, however, if | |||
| 784 | your Emacs maintainer has put Supercite into your dumped Emacs image. | 784 | your Emacs maintainer has put Supercite into your dumped Emacs image. |
| 785 | In that case, you can use the @code{sc-pre-hook} variable, but this will | 785 | In that case, you can use the @code{sc-pre-hook} variable, but this will |
| 786 | get executed every time @code{sc-cite-original} is called. @xref{Reply | 786 | get executed every time @code{sc-cite-original} is called. @xref{Reply |
| 787 | Buffer Initialization}.@refill | 787 | Buffer Initialization}. |
| 788 | 788 | ||
| 789 | @node Replying and Yanking | 789 | @node Replying and Yanking |
| 790 | @chapter Replying and Yanking | 790 | @chapter Replying and Yanking |
| @@ -814,7 +814,7 @@ This hook variable is run before @code{sc-cite-original} does any other | |||
| 814 | work. You could conceivably use this hook to set certain Supercite | 814 | work. You could conceivably use this hook to set certain Supercite |
| 815 | variables based on the reply buffer's mode or name (i.e., to do | 815 | variables based on the reply buffer's mode or name (i.e., to do |
| 816 | something different based on whether you are replying or following up to | 816 | something different based on whether you are replying or following up to |
| 817 | an article).@refill | 817 | an article). |
| 818 | 818 | ||
| 819 | @item | 819 | @item |
| 820 | @emph{Inserts Supercite's keymap.} | 820 | @emph{Inserts Supercite's keymap.} |
| @@ -942,7 +942,7 @@ there as people on the net, or just about! It would be impossible for | |||
| 942 | Supercite to anticipate every style in existence, and you probably | 942 | Supercite to anticipate every style in existence, and you probably |
| 943 | wouldn't encounter them all anyway. But you can configure Supercite to | 943 | wouldn't encounter them all anyway. But you can configure Supercite to |
| 944 | recognize those styles you see often. | 944 | recognize those styles you see often. |
| 945 | @xref{Configuring the Citation Engine}, for details.@refill | 945 | @xref{Configuring the Citation Engine}, for details. |
| 946 | 946 | ||
| 947 | @item | 947 | @item |
| 948 | @emph{Runs @code{sc-post-hook}.} | 948 | @emph{Runs @code{sc-post-hook}.} |
| @@ -951,7 +951,7 @@ recognize those styles you see often. | |||
| 951 | This variable is very similar to @code{sc-pre-hook}, except that it runs | 951 | This variable is very similar to @code{sc-pre-hook}, except that it runs |
| 952 | after @code{sc-cite-original} is finished. This hook is provided mostly | 952 | after @code{sc-cite-original} is finished. This hook is provided mostly |
| 953 | for completeness and backward compatibility. Perhaps it could be used to | 953 | for completeness and backward compatibility. Perhaps it could be used to |
| 954 | reset certain variables set in @code{sc-pre-hook}.@refill | 954 | reset certain variables set in @code{sc-pre-hook}. |
| 955 | @end enumerate | 955 | @end enumerate |
| 956 | 956 | ||
| 957 | @node Filling Cited Text | 957 | @node Filling Cited Text |
| @@ -987,7 +987,7 @@ setup. | |||
| 987 | Also, Supercite will collapse leading whitespace between the citation | 987 | Also, Supercite will collapse leading whitespace between the citation |
| 988 | string and the text on a line when the variable | 988 | string and the text on a line when the variable |
| 989 | @code{sc-fixup-whitespace-p} is non-@code{nil}. The default value for | 989 | @code{sc-fixup-whitespace-p} is non-@code{nil}. The default value for |
| 990 | this variable is @code{nil}.@refill | 990 | this variable is @code{nil}. |
| 991 | 991 | ||
| 992 | @vindex fill-prefix | 992 | @vindex fill-prefix |
| 993 | Its important to understand that Supercite's automatic filling (during | 993 | Its important to understand that Supercite's automatic filling (during |
| @@ -1005,7 +1005,7 @@ When Supercite's automatic filling breaks on a particular message, I | |||
| 1005 | will use Emacs's undo feature to undo back before the citation was | 1005 | will use Emacs's undo feature to undo back before the citation was |
| 1006 | applied to the original message. Then I'll toggle the variables and | 1006 | applied to the original message. Then I'll toggle the variables and |
| 1007 | manually cite those paragraphs that I don't want to fill or collapse | 1007 | manually cite those paragraphs that I don't want to fill or collapse |
| 1008 | whitespace on. @xref{Variable Toggling Shortcuts}.@refill | 1008 | whitespace on. @xref{Variable Toggling Shortcuts}. |
| 1009 | 1009 | ||
| 1010 | @kindex C-c C-p C-p | 1010 | @kindex C-c C-p C-p |
| 1011 | If you find that Supercite's automatic filling is just too fragile for | 1011 | If you find that Supercite's automatic filling is just too fragile for |
| @@ -1013,7 +1013,7 @@ your tastes, you might consider one of these alternate approaches. | |||
| 1013 | Also, to make life easier, a shortcut function to toggle the state of | 1013 | Also, to make life easier, a shortcut function to toggle the state of |
| 1014 | both of these variables is provided on the key binding | 1014 | both of these variables is provided on the key binding |
| 1015 | @kbd{C-c C-p C-p} (with the default value of @code{sc-mode-map-prefix}; | 1015 | @kbd{C-c C-p C-p} (with the default value of @code{sc-mode-map-prefix}; |
| 1016 | @pxref{Post-yank Formatting Commands}).@refill | 1016 | @pxref{Post-yank Formatting Commands}). |
| 1017 | 1017 | ||
| 1018 | You will noticed that the minor mode string will | 1018 | You will noticed that the minor mode string will |
| 1019 | show the state of these variables as qualifier characters. When both | 1019 | show the state of these variables as qualifier characters. When both |
| @@ -1025,7 +1025,7 @@ string will display @samp{SC:f}, and when just | |||
| 1025 | display @samp{SC:fw}. Note that the qualifiers chosen are mnemonics for | 1025 | display @samp{SC:fw}. Note that the qualifiers chosen are mnemonics for |
| 1026 | the default bindings of the toggling function for each respective | 1026 | the default bindings of the toggling function for each respective |
| 1027 | variable. | 1027 | variable. |
| 1028 | @xref{Variable Toggling Shortcuts}.@refill | 1028 | @xref{Variable Toggling Shortcuts}. |
| 1029 | 1029 | ||
| 1030 | Why are these variables not set to @code{nil} by default? It is because | 1030 | Why are these variables not set to @code{nil} by default? It is because |
| 1031 | many users won't manually fill paragraphs that are Supercited, and there | 1031 | many users won't manually fill paragraphs that are Supercited, and there |
| @@ -1088,7 +1088,7 @@ the author's first middle name. | |||
| 1088 | 1088 | ||
| 1089 | @item "sc-lastchoice" | 1089 | @item "sc-lastchoice" |
| 1090 | the last attribution string you have selected. This is useful when you | 1090 | the last attribution string you have selected. This is useful when you |
| 1091 | recite paragraphs in the reply.@refill | 1091 | recite paragraphs in the reply. |
| 1092 | 1092 | ||
| 1093 | @item "sc-consult" | 1093 | @item "sc-consult" |
| 1094 | @vindex sc-attrib-selection-list | 1094 | @vindex sc-attrib-selection-list |
| @@ -1099,7 +1099,7 @@ key. See below for details. | |||
| 1099 | 1099 | ||
| 1100 | @item "x-attribution" | 1100 | @item "x-attribution" |
| 1101 | the original author's suggestion for attribution string choice. See below | 1101 | the original author's suggestion for attribution string choice. See below |
| 1102 | for details.@refill | 1102 | for details. |
| 1103 | @end table | 1103 | @end table |
| 1104 | 1104 | ||
| 1105 | Middle name indexes can be any positive integer greater than zero, | 1105 | Middle name indexes can be any positive integer greater than zero, |
| @@ -1184,7 +1184,7 @@ case. If the variable's value is non-@code{nil}, then | |||
| 1184 | @code{sc-default-author-name} and @code{sc-default-attribution} are | 1184 | @code{sc-default-author-name} and @code{sc-default-attribution} are |
| 1185 | used, otherwise, the following steps are taken to find a valid | 1185 | used, otherwise, the following steps are taken to find a valid |
| 1186 | attribution string, and the first step to return a non-@code{nil}, | 1186 | attribution string, and the first step to return a non-@code{nil}, |
| 1187 | non-empty string becomes the attribution:@refill | 1187 | non-empty string becomes the attribution: |
| 1188 | 1188 | ||
| 1189 | @enumerate | 1189 | @enumerate |
| 1190 | @item | 1190 | @item |
| @@ -1244,7 +1244,7 @@ variables in your hook functions, you change the attribution and | |||
| 1244 | citation strings used by Supercite. One possible use of this would be | 1244 | citation strings used by Supercite. One possible use of this would be |
| 1245 | to override any automatically derived attribution string when it is only | 1245 | to override any automatically derived attribution string when it is only |
| 1246 | one character long; e.g., you prefer to use @code{"initials"} but the | 1246 | one character long; e.g., you prefer to use @code{"initials"} but the |
| 1247 | author only has one name.@refill | 1247 | author only has one name. |
| 1248 | 1248 | ||
| 1249 | @node Author Names | 1249 | @node Author Names |
| 1250 | @section Author Names | 1250 | @section Author Names |
| @@ -1376,7 +1376,7 @@ matched against the current line, from the beginning, using | |||
| 1376 | @code{looking-at}. This match folds case if the optional | 1376 | @code{looking-at}. This match folds case if the optional |
| 1377 | @var{case-fold-search} is non-@code{nil}. If @var{pred} is not a | 1377 | @var{case-fold-search} is non-@code{nil}. If @var{pred} is not a |
| 1378 | string, or does not @code{eval}uate to a string, it is interpreted as a | 1378 | string, or does not @code{eval}uate to a string, it is interpreted as a |
| 1379 | binary value (@code{nil} or non-@code{nil}).@refill | 1379 | binary value (@code{nil} or non-@code{nil}). |
| 1380 | 1380 | ||
| 1381 | The four special symbol values for @var{pred} are recognized: | 1381 | The four special symbol values for @var{pred} are recognized: |
| 1382 | 1382 | ||
| @@ -1405,7 +1405,7 @@ processing. By default, if your @var{func} returns @code{nil} (as it | |||
| 1405 | should be careful to do explicitly), Regi will reset the frame to the | 1405 | should be careful to do explicitly), Regi will reset the frame to the |
| 1406 | first entry, and advance @samp{point} to the beginning of the next line. | 1406 | first entry, and advance @samp{point} to the beginning of the next line. |
| 1407 | If a list is returned from your function, it can contain any combination | 1407 | If a list is returned from your function, it can contain any combination |
| 1408 | of the following elements:@refill | 1408 | of the following elements: |
| 1409 | 1409 | ||
| 1410 | @table @asis | 1410 | @table @asis |
| 1411 | @item the symbol @code{continue} | 1411 | @item the symbol @code{continue} |
| @@ -1422,16 +1422,16 @@ entry is still processed. | |||
| 1422 | This tells Regi to substitute @var{newframe} as the frame it is | 1422 | This tells Regi to substitute @var{newframe} as the frame it is |
| 1423 | interpreting. In other words, your @var{func} can modify the Regi frame | 1423 | interpreting. In other words, your @var{func} can modify the Regi frame |
| 1424 | on the fly. @var{newframe} can be a variable containing a frame, or it | 1424 | on the fly. @var{newframe} can be a variable containing a frame, or it |
| 1425 | can be the frame in-lined.@refill | 1425 | can be the frame in-lined. |
| 1426 | 1426 | ||
| 1427 | @item the list @code{(step . @var{step})} | 1427 | @item the list @code{(step . @var{step})} |
| 1428 | Tells Regi to move @var{step} number of lines forward as it continues | 1428 | Tells Regi to move @var{step} number of lines forward as it continues |
| 1429 | processing. By default, Regi moves forward one line. @var{step} can be | 1429 | processing. By default, Regi moves forward one line. @var{step} can be |
| 1430 | zero or negative of course, but watch out for infinite loops.@refill | 1430 | zero or negative of course, but watch out for infinite loops. |
| 1431 | @end table | 1431 | @end table |
| 1432 | 1432 | ||
| 1433 | During execution of your @var{func}, the following variables will be | 1433 | During execution of your @var{func}, the following variables will be |
| 1434 | temporarily bound to some useful information:@refill | 1434 | temporarily bound to some useful information: |
| 1435 | 1435 | ||
| 1436 | @table @code | 1436 | @table @code |
| 1437 | @item curline | 1437 | @item curline |
| @@ -1471,7 +1471,7 @@ preferred style. | |||
| 1471 | In a similar vein, there are default frames for @dfn{unciting} and | 1471 | In a similar vein, there are default frames for @dfn{unciting} and |
| 1472 | @dfn{reciting}, contained in the variables | 1472 | @dfn{reciting}, contained in the variables |
| 1473 | @code{sc-default-uncite-frame} and @code{sc-default-recite-frame} | 1473 | @code{sc-default-uncite-frame} and @code{sc-default-recite-frame} |
| 1474 | respectively.@refill | 1474 | respectively. |
| 1475 | 1475 | ||
| 1476 | As mentioned earlier (@pxref{Recognizing Citations}), citations are | 1476 | As mentioned earlier (@pxref{Recognizing Citations}), citations are |
| 1477 | recognized through the values of the regular expressions | 1477 | recognized through the values of the regular expressions |
| @@ -1500,7 +1500,7 @@ Where @var{infokey} is a key suitable for @code{sc-mail-field}, | |||
| 1500 | @var{regexp} is a regular expression which is @code{string-match}'d | 1500 | @var{regexp} is a regular expression which is @code{string-match}'d |
| 1501 | against the value of the @code{sc-mail-field} key, and @var{frame} is | 1501 | against the value of the @code{sc-mail-field} key, and @var{frame} is |
| 1502 | the frame to use if a match occurred. @var{frame} can be a variable | 1502 | the frame to use if a match occurred. @var{frame} can be a variable |
| 1503 | containing a frame or a frame in-lined.@refill | 1503 | containing a frame or a frame in-lined. |
| 1504 | 1504 | ||
| 1505 | When Supercite is about to cite, uncite, or recite a region, it consults | 1505 | When Supercite is about to cite, uncite, or recite a region, it consults |
| 1506 | the appropriate alist and attempts to find a frame to use. If one | 1506 | the appropriate alist and attempts to find a frame to use. If one |
| @@ -1524,7 +1524,7 @@ variable @code{sc-mode-map-prefix}. By default, the | |||
| 1524 | @code{sc-mode-map-prefix} is @kbd{C-c C-p}; granted, not a great choice, | 1524 | @code{sc-mode-map-prefix} is @kbd{C-c C-p}; granted, not a great choice, |
| 1525 | but unfortunately the best general solution so far. In the rest of this | 1525 | but unfortunately the best general solution so far. In the rest of this |
| 1526 | chapter, we'll assume you've installed Supercite's keymap on the default | 1526 | chapter, we'll assume you've installed Supercite's keymap on the default |
| 1527 | prefix.@refill | 1527 | prefix. |
| 1528 | 1528 | ||
| 1529 | @menu | 1529 | @menu |
| 1530 | * Citing Commands:: | 1530 | * Citing Commands:: |
| @@ -1546,7 +1546,7 @@ paragraph to use a nickname, or manually cite a message when setting | |||
| 1546 | perform these functions on the region of text between @samp{point} and | 1546 | perform these functions on the region of text between @samp{point} and |
| 1547 | @samp{mark}. Each of them sets the @dfn{undo boundary} before modifying | 1547 | @samp{mark}. Each of them sets the @dfn{undo boundary} before modifying |
| 1548 | the region so that the command can be undone in the standard Emacs | 1548 | the region so that the command can be undone in the standard Emacs |
| 1549 | way.@refill | 1549 | way. |
| 1550 | 1550 | ||
| 1551 | Here is the list of Supercite citing commands: | 1551 | Here is the list of Supercite citing commands: |
| 1552 | 1552 | ||
| @@ -1567,7 +1567,7 @@ frame @code{sc-default-cite-frame}. It runs the hook | |||
| 1567 | universal argument (@kbd{C-u}), it temporarily sets | 1567 | universal argument (@kbd{C-u}), it temporarily sets |
| 1568 | @code{sc-confirm-always-p} to @code{t} so you can confirm the | 1568 | @code{sc-confirm-always-p} to @code{t} so you can confirm the |
| 1569 | attribution string for a single manual citing. | 1569 | attribution string for a single manual citing. |
| 1570 | @xref{Configuring the Citation Engine}.@refill | 1570 | @xref{Configuring the Citation Engine}. |
| 1571 | 1571 | ||
| 1572 | @findex sc-uncite-region | 1572 | @findex sc-uncite-region |
| 1573 | @findex uncite-region (sc-) | 1573 | @findex uncite-region (sc-) |
| @@ -1578,7 +1578,7 @@ cited line in the region by interpreting the selected frame from | |||
| 1578 | @code{sc-uncite-frame-alist}, or the default unciting frame | 1578 | @code{sc-uncite-frame-alist}, or the default unciting frame |
| 1579 | @code{sc-default-uncite-frame}. It runs the hook | 1579 | @code{sc-default-uncite-frame}. It runs the hook |
| 1580 | @code{sc-pre-uncite-hook} before interpreting the frame. | 1580 | @code{sc-pre-uncite-hook} before interpreting the frame. |
| 1581 | @xref{Configuring the Citation Engine}.@refill | 1581 | @xref{Configuring the Citation Engine}. |
| 1582 | 1582 | ||
| 1583 | @findex sc-recite-region | 1583 | @findex sc-recite-region |
| 1584 | @findex recite-region (sc-) | 1584 | @findex recite-region (sc-) |
| @@ -1588,7 +1588,7 @@ This command recites each line the region by interpreting the selected | |||
| 1588 | frame from @code{sc-recite-frame-alist}, or the default reciting frame | 1588 | frame from @code{sc-recite-frame-alist}, or the default reciting frame |
| 1589 | @code{sc-default-recite-frame}. It runs the hook | 1589 | @code{sc-default-recite-frame}. It runs the hook |
| 1590 | @code{sc-pre-recite-hook} before interpreting the frame. | 1590 | @code{sc-pre-recite-hook} before interpreting the frame. |
| 1591 | @xref{Configuring the Citation Engine}.@refill | 1591 | @xref{Configuring the Citation Engine}. |
| 1592 | 1592 | ||
| 1593 | @vindex sc-confirm-always-p | 1593 | @vindex sc-confirm-always-p |
| 1594 | @vindex confirm-always-p (sc-) | 1594 | @vindex confirm-always-p (sc-) |
| @@ -1612,7 +1612,7 @@ Inserts a reference header into the reply buffer at @samp{point}. With | |||
| 1612 | no arguments, the header indexed by @code{sc-preferred-header-style} is | 1612 | no arguments, the header indexed by @code{sc-preferred-header-style} is |
| 1613 | inserted. An optional numeric argument is the index into | 1613 | inserted. An optional numeric argument is the index into |
| 1614 | @code{sc-rewrite-header-list} indicating which reference header to | 1614 | @code{sc-rewrite-header-list} indicating which reference header to |
| 1615 | write.@refill | 1615 | write. |
| 1616 | 1616 | ||
| 1617 | With just the universal argument (@kbd{C-u}), electric reference mode is | 1617 | With just the universal argument (@kbd{C-u}), electric reference mode is |
| 1618 | entered, regardless of the value of @code{sc-electric-references-p}. | 1618 | entered, regardless of the value of @code{sc-electric-references-p}. |
| @@ -1640,7 +1640,7 @@ this easy to do. | |||
| 1640 | Like Supercite commands in general, the toggling commands are placed on | 1640 | Like Supercite commands in general, the toggling commands are placed on |
| 1641 | a keymap prefix within the greater Supercite keymap. For the default | 1641 | a keymap prefix within the greater Supercite keymap. For the default |
| 1642 | value of @code{sc-mode-map-prefix}, this will be | 1642 | value of @code{sc-mode-map-prefix}, this will be |
| 1643 | @kbd{C-c C-p C-t}.@refill | 1643 | @kbd{C-c C-p C-t}. |
| 1644 | 1644 | ||
| 1645 | The following commands toggle the value of certain Supercite variables | 1645 | The following commands toggle the value of certain Supercite variables |
| 1646 | which take only a binary value: | 1646 | which take only a binary value: |
| @@ -1700,7 +1700,7 @@ One special command is provided to toggle both | |||
| 1700 | @code{sc-auto-fill-region-p} and @code{sc-fixup-whitespace-p} together. | 1700 | @code{sc-auto-fill-region-p} and @code{sc-fixup-whitespace-p} together. |
| 1701 | This is because you typically want to run Supercite with either variable | 1701 | This is because you typically want to run Supercite with either variable |
| 1702 | as @code{nil} or non-@code{nil}. The command to toggle these variables | 1702 | as @code{nil} or non-@code{nil}. The command to toggle these variables |
| 1703 | together is bound on @kbd{C-c C-p C-p}.@refill | 1703 | together is bound on @kbd{C-c C-p C-p}. |
| 1704 | 1704 | ||
| 1705 | Finally, the command @kbd{C-c C-p C-t h} (also @kbd{C-c C-p C-t ?}) | 1705 | Finally, the command @kbd{C-c C-p C-t h} (also @kbd{C-c C-p C-t ?}) |
| 1706 | brings up a Help message on the toggling keymap. | 1706 | brings up a Help message on the toggling keymap. |
| @@ -1711,7 +1711,7 @@ brings up a Help message on the toggling keymap. | |||
| 1711 | 1711 | ||
| 1712 | These commands allow you to view, modify, add, and delete various bits | 1712 | These commands allow you to view, modify, add, and delete various bits |
| 1713 | of information from the info alist. | 1713 | of information from the info alist. |
| 1714 | @xref{Information Keys and the Info Alist}.@refill | 1714 | @xref{Information Keys and the Info Alist}. |
| 1715 | 1715 | ||
| 1716 | @table @asis | 1716 | @table @asis |
| 1717 | @kindex C-c C-p f | 1717 | @kindex C-c C-p f |
| @@ -1753,7 +1753,7 @@ This function is especially useful for replying to digest messages where | |||
| 1753 | Supercite will initially set up its information for the digest | 1753 | Supercite will initially set up its information for the digest |
| 1754 | originator, but you want to cite each component article with the real | 1754 | originator, but you want to cite each component article with the real |
| 1755 | message author. Note that unless an error during processing occurs, any | 1755 | message author. Note that unless an error during processing occurs, any |
| 1756 | old information is lost.@refill | 1756 | old information is lost. |
| 1757 | @end table | 1757 | @end table |
| 1758 | 1758 | ||
| 1759 | @node Miscellaneous Commands | 1759 | @node Miscellaneous Commands |
| @@ -1767,7 +1767,7 @@ old information is lost.@refill | |||
| 1767 | @item @code{sc-open-line} (@kbd{C-c C-p o}) | 1767 | @item @code{sc-open-line} (@kbd{C-c C-p o}) |
| 1768 | Similar to Emacs's standard @code{open-line} commands, but inserts the | 1768 | Similar to Emacs's standard @code{open-line} commands, but inserts the |
| 1769 | citation string in front of the new line. As with @code{open-line}, | 1769 | citation string in front of the new line. As with @code{open-line}, |
| 1770 | an optional numeric argument inserts that many new lines.@refill | 1770 | an optional numeric argument inserts that many new lines. |
| 1771 | @end table | 1771 | @end table |
| 1772 | 1772 | ||
| 1773 | @node Hints to MUA Authors | 1773 | @node Hints to MUA Authors |
| @@ -1810,7 +1810,7 @@ the release of Emacs 19. Instead of the variable | |||
| 1810 | @code{mail-yank-hooks}, the hook variable that the MUA should provide is | 1810 | @code{mail-yank-hooks}, the hook variable that the MUA should provide is |
| 1811 | @code{mail-citation-hook}. Richard Stallman suggests that the MUAs | 1811 | @code{mail-citation-hook}. Richard Stallman suggests that the MUAs |
| 1812 | should @code{defvar} @code{mail-citation-hook} to @code{nil} and perform | 1812 | should @code{defvar} @code{mail-citation-hook} to @code{nil} and perform |
| 1813 | some default citing when that is the case.@refill | 1813 | some default citing when that is the case. |
| 1814 | 1814 | ||
| 1815 | If you are writing a new MUA package, or maintaining an existing MUA | 1815 | If you are writing a new MUA package, or maintaining an existing MUA |
| 1816 | package, you should make it conform to this interface so that your users | 1816 | package, you should make it conform to this interface so that your users |
| @@ -1826,7 +1826,7 @@ buffer. At this point you should not modify the raw text in any way | |||
| 1826 | you should place all the original headers into the body of the reply. | 1826 | you should place all the original headers into the body of the reply. |
| 1827 | This means that many of the mail headers will be duplicated, one copy | 1827 | This means that many of the mail headers will be duplicated, one copy |
| 1828 | above the @code{mail-header-separator} line and one copy below, however | 1828 | above the @code{mail-header-separator} line and one copy below, however |
| 1829 | there will probably be more headers below this line.@refill | 1829 | there will probably be more headers below this line. |
| 1830 | 1830 | ||
| 1831 | @item | 1831 | @item |
| 1832 | Set @samp{point} to the beginning of the line containing the first mail | 1832 | Set @samp{point} to the beginning of the line containing the first mail |
| @@ -1835,7 +1835,7 @@ message text. It is very important that the region be set around the | |||
| 1835 | text Supercite is to modify and that the mail headers are within this | 1835 | text Supercite is to modify and that the mail headers are within this |
| 1836 | region. Supercite will not venture outside the region for any reason, | 1836 | region. Supercite will not venture outside the region for any reason, |
| 1837 | and anything within the region is fair game, so don't put anything that | 1837 | and anything within the region is fair game, so don't put anything that |
| 1838 | @strong{must} remain unchanged inside the region.@refill | 1838 | @strong{must} remain unchanged inside the region. |
| 1839 | 1839 | ||
| 1840 | @item | 1840 | @item |
| 1841 | Run the hook @code{mail-citation-hook}. You will probably want to | 1841 | Run the hook @code{mail-citation-hook}. You will probably want to |
| @@ -1846,7 +1846,7 @@ yanking function, check its value. If it finds | |||
| 1846 | @code{mail-citation-hook} to be @code{nil}, it should perform some | 1846 | @code{mail-citation-hook} to be @code{nil}, it should perform some |
| 1847 | default citing behavior. User who want to connect to Supercite then | 1847 | default citing behavior. User who want to connect to Supercite then |
| 1848 | need only add @code{sc-cite-original} to this list of hooks using | 1848 | need only add @code{sc-cite-original} to this list of hooks using |
| 1849 | @code{add-hook}.@refill | 1849 | @code{add-hook}. |
| 1850 | @end enumerate | 1850 | @end enumerate |
| 1851 | 1851 | ||
| 1852 | If you do all this your MUA will join the ranks of those that conform to | 1852 | If you do all this your MUA will join the ranks of those that conform to |
diff --git a/doc/misc/srecode.texi b/doc/misc/srecode.texi index d76f9e09184..2a3cfdf0993 100644 --- a/doc/misc/srecode.texi +++ b/doc/misc/srecode.texi | |||
| @@ -247,7 +247,6 @@ features of the current file name, user name, time, etc. | |||
| 247 | 247 | ||
| 248 | Some arguments are major-mode specific, such as the @code{:el} or | 248 | Some arguments are major-mode specific, such as the @code{:el} or |
| 249 | @code{:cpp} arguments. | 249 | @code{:cpp} arguments. |
| 250 | @refill | ||
| 251 | 250 | ||
| 252 | @section Template Insertion Context | 251 | @section Template Insertion Context |
| 253 | A context can be provided for templates in a file. This helps | 252 | A context can be provided for templates in a file. This helps |
| @@ -257,7 +256,6 @@ contexts to have the same name. Some standard contexts are | |||
| 257 | 256 | ||
| 258 | A context can be automatically derived as well based on the parsing | 257 | A context can be automatically derived as well based on the parsing |
| 259 | state from @i{Semantic}. @inforef{Top, Semantic Manual, semantic}. | 258 | state from @i{Semantic}. @inforef{Top, Semantic Manual, semantic}. |
| 260 | @refill | ||
| 261 | 259 | ||
| 262 | @section Applications | 260 | @section Applications |
| 263 | Commands that do a particular user task which involves also writing | 261 | Commands that do a particular user task which involves also writing |
| @@ -781,7 +779,6 @@ All the text and macros within a section are either not shown at all | |||
| 781 | (if that section is not 'visible') or the section is shown one time | 779 | (if that section is not 'visible') or the section is shown one time |
| 782 | for each dictionary added to that symbol. | 780 | for each dictionary added to that symbol. |
| 783 | @xref{Developing Template Functions}. | 781 | @xref{Developing Template Functions}. |
| 784 | @refill | ||
| 785 | 782 | ||
| 786 | Macros prefixed with ``>'' will include another template. Include | 783 | Macros prefixed with ``>'' will include another template. Include |
| 787 | macros would look like this: | 784 | macros would look like this: |
diff --git a/doc/misc/vip.texi b/doc/misc/vip.texi index 7c998b37010..28e78f5d381 100644 --- a/doc/misc/vip.texi +++ b/doc/misc/vip.texi | |||
| @@ -56,7 +56,7 @@ you start using VIP@. Other nodes may be visited as needed. | |||
| 56 | 56 | ||
| 57 | Comments and bug reports are welcome. Please send messages to | 57 | Comments and bug reports are welcome. Please send messages to |
| 58 | @code{ms@@Sail.Stanford.Edu} if you are outside of Japan and to | 58 | @code{ms@@Sail.Stanford.Edu} if you are outside of Japan and to |
| 59 | @code{masahiko@@sato.riec.tohoku.junet} if you are in Japan.@refill | 59 | @code{masahiko@@sato.riec.tohoku.junet} if you are in Japan. |
| 60 | 60 | ||
| 61 | @insertcopying | 61 | @insertcopying |
| 62 | 62 | ||
| @@ -128,14 +128,13 @@ the character; otherwise we say that point is @dfn{at the end of buffer}. | |||
| 128 | @key{PNT} and @key{MRK} are used | 128 | @key{PNT} and @key{MRK} are used |
| 129 | to indicate positions in a buffer and they are not part of the text of the | 129 | to indicate positions in a buffer and they are not part of the text of the |
| 130 | buffer. If a buffer contains a @key{MRK} then the text between @key{MRK} | 130 | buffer. If a buffer contains a @key{MRK} then the text between @key{MRK} |
| 131 | and @key{PNT} is called the @dfn{region} of the buffer.@refill | 131 | and @key{PNT} is called the @dfn{region} of the buffer. |
| 132 | 132 | ||
| 133 | @cindex window | 133 | @cindex window |
| 134 | 134 | ||
| 135 | Emacs provides (multiple) @dfn{windows} on the screen, and you can see the | 135 | Emacs provides (multiple) @dfn{windows} on the screen, and you can see the |
| 136 | content of a buffer through the window associated with the buffer. The | 136 | content of a buffer through the window associated with the buffer. The |
| 137 | cursor of the screen is always positioned on the character after @key{PNT}. | 137 | cursor of the screen is always positioned on the character after @key{PNT}. |
| 138 | @refill | ||
| 139 | 138 | ||
| 140 | @cindex mode | 139 | @cindex mode |
| 141 | @cindex keymap | 140 | @cindex keymap |
| @@ -149,7 +148,7 @@ buffers. Each buffer has its @dfn{local keymap} that determines the | |||
| 149 | a function is bound to some key in the local keymap then that function will | 148 | a function is bound to some key in the local keymap then that function will |
| 150 | be executed when you type the key. If no function is bound to a key in the | 149 | be executed when you type the key. If no function is bound to a key in the |
| 151 | local map, however, the function bound to the key in the global map becomes | 150 | local map, however, the function bound to the key in the global map becomes |
| 152 | in effect.@refill | 151 | in effect. |
| 153 | 152 | ||
| 154 | @node Loading VIP | 153 | @node Loading VIP |
| 155 | @section Loading VIP | 154 | @section Loading VIP |
| @@ -187,7 +186,7 @@ Loading VIP has the effect of globally binding @kbd{C-z} (@kbd{Control-z}) | |||
| 187 | to the function @code{vip-change-mode-to-vi}. The default binding of @kbd{C-z} | 186 | to the function @code{vip-change-mode-to-vi}. The default binding of @kbd{C-z} |
| 188 | in GNU Emacs is @code{suspend-emacs}, but, you can also call | 187 | in GNU Emacs is @code{suspend-emacs}, but, you can also call |
| 189 | @code{suspend-emacs} by typing @kbd{C-x C-z}. Other than this, all the | 188 | @code{suspend-emacs} by typing @kbd{C-x C-z}. Other than this, all the |
| 190 | key bindings of Emacs remain the same after loading VIP.@refill | 189 | key bindings of Emacs remain the same after loading VIP. |
| 191 | 190 | ||
| 192 | @cindex vi mode | 191 | @cindex vi mode |
| 193 | 192 | ||
| @@ -198,12 +197,12 @@ called and you will be in @dfn{vi mode}. (Some major modes may locally bind | |||
| 198 | invoked by @kbd{M-x}. Here @kbd{M-x} means @kbd{Meta-x}, and if your | 197 | invoked by @kbd{M-x}. Here @kbd{M-x} means @kbd{Meta-x}, and if your |
| 199 | terminal does not have a @key{META} key you can enter it by typing | 198 | terminal does not have a @key{META} key you can enter it by typing |
| 200 | @kbd{@key{ESC} x}. The same effect can also be achieve by typing | 199 | @kbd{@key{ESC} x}. The same effect can also be achieve by typing |
| 201 | @kbd{M-x vip-mode}.)@refill | 200 | @kbd{M-x vip-mode}.) |
| 202 | 201 | ||
| 203 | @cindex mode line | 202 | @cindex mode line |
| 204 | 203 | ||
| 205 | You can observe the change of mode by looking at the @dfn{mode line}. For | 204 | You can observe the change of mode by looking at the @dfn{mode line}. For |
| 206 | instance, if the mode line is:@refill | 205 | instance, if the mode line is: |
| 207 | @example | 206 | @example |
| 208 | -----Emacs: *scratch* (Lisp Interaction)----All------------ | 207 | -----Emacs: *scratch* (Lisp Interaction)----All------------ |
| 209 | @end example | 208 | @end example |
| @@ -219,7 +218,7 @@ Thus the word @samp{Emacs} in the mode line will change to @samp{Vi}. | |||
| 219 | @cindex emacs mode | 218 | @cindex emacs mode |
| 220 | 219 | ||
| 221 | You can go back to the original @dfn{emacs mode} by typing @kbd{C-z} in | 220 | You can go back to the original @dfn{emacs mode} by typing @kbd{C-z} in |
| 222 | vi mode. Thus @kbd{C-z} toggles between these two modes.@refill | 221 | vi mode. Thus @kbd{C-z} toggles between these two modes. |
| 223 | 222 | ||
| 224 | Note that modes in VIP exist orthogonally to modes in Emacs. This means | 223 | Note that modes in VIP exist orthogonally to modes in Emacs. This means |
| 225 | that you can be in vi mode and at the same time, say, shell mode. | 224 | that you can be in vi mode and at the same time, say, shell mode. |
| @@ -265,7 +264,7 @@ emacs mode vi mode insert mode | |||
| 265 | You will be in this mode just after you loaded VIP@. You can do all | 264 | You will be in this mode just after you loaded VIP@. You can do all |
| 266 | normal Emacs editing in this mode. Note that the key @kbd{C-z} is globally | 265 | normal Emacs editing in this mode. Note that the key @kbd{C-z} is globally |
| 267 | bound to @code{vip-change-mode-to-vi}. So, if you type @kbd{C-z} in this mode | 266 | bound to @code{vip-change-mode-to-vi}. So, if you type @kbd{C-z} in this mode |
| 268 | then you will be in vi mode.@refill | 267 | then you will be in vi mode. |
| 269 | 268 | ||
| 270 | @node Vi Mode | 269 | @node Vi Mode |
| 271 | @subsection Vi Mode | 270 | @subsection Vi Mode |
| @@ -332,7 +331,7 @@ The major differences from Vi are explained below. | |||
| 332 | You can repeat undoing by the @kbd{.} key. So, @kbd{u} will undo | 331 | You can repeat undoing by the @kbd{.} key. So, @kbd{u} will undo |
| 333 | a single change, while @kbd{u .@: .@: .@:}, for instance, will undo 4 previous | 332 | a single change, while @kbd{u .@: .@: .@:}, for instance, will undo 4 previous |
| 334 | changes. Undo is undoable as in Vi. So the content of the buffer will | 333 | changes. Undo is undoable as in Vi. So the content of the buffer will |
| 335 | be the same before and after @kbd{u u}.@refill | 334 | be the same before and after @kbd{u u}. |
| 336 | 335 | ||
| 337 | @node Changing | 336 | @node Changing |
| 338 | @subsection Changing | 337 | @subsection Changing |
| @@ -345,7 +344,7 @@ then VIP will prompt you for a new word in the minibuffer by the prompt | |||
| 345 | @key{ESC} to complete the command. Before you enter @key{RET} or | 344 | @key{ESC} to complete the command. Before you enter @key{RET} or |
| 346 | @key{ESC} you can abort the command by typing @kbd{C-g}. In general, | 345 | @key{ESC} you can abort the command by typing @kbd{C-g}. In general, |
| 347 | @kindex 007 @kbd{C-g} (@code{vip-keyboard-quit}) | 346 | @kindex 007 @kbd{C-g} (@code{vip-keyboard-quit}) |
| 348 | you can abort a partially formed command by typing @kbd{C-g}.@refill | 347 | you can abort a partially formed command by typing @kbd{C-g}. |
| 349 | 348 | ||
| 350 | @node Searching | 349 | @node Searching |
| 351 | @subsection Searching | 350 | @subsection Searching |
| @@ -361,7 +360,7 @@ A search for empty string will toggle the search mode between vanilla | |||
| 361 | search and regular expression search. You cannot give an offset to the | 360 | search and regular expression search. You cannot give an offset to the |
| 362 | search string. (It is a limitation.) By default, search will wrap around | 361 | search string. (It is a limitation.) By default, search will wrap around |
| 363 | the buffer as in Vi. You can change this by rebinding the variable | 362 | the buffer as in Vi. You can change this by rebinding the variable |
| 364 | @code{vip-search-wrap-around}. @xref{Customization}, for how to do this.@refill | 363 | @code{vip-search-wrap-around}. @xref{Customization}, for how to do this. |
| 365 | 364 | ||
| 366 | @node z Command | 365 | @node z Command |
| 367 | @subsection z Command | 366 | @subsection z Command |
| @@ -376,7 +375,7 @@ the buffer as in Vi. You can change this by rebinding the variable | |||
| 376 | For those of you who cannot remember which of @kbd{z} followed by @key{RET}, | 375 | For those of you who cannot remember which of @kbd{z} followed by @key{RET}, |
| 377 | @kbd{.}@: and @kbd{-} do what. You can also use @kbd{z} followed by @kbd{H}, | 376 | @kbd{.}@: and @kbd{-} do what. You can also use @kbd{z} followed by @kbd{H}, |
| 378 | @kbd{M} and @kbd{L} to place the current line in the Home (Middle, and | 377 | @kbd{M} and @kbd{L} to place the current line in the Home (Middle, and |
| 379 | Last) line of the window.@refill | 378 | Last) line of the window. |
| 380 | 379 | ||
| 381 | @node Counts | 380 | @node Counts |
| 382 | @subsection Counts | 381 | @subsection Counts |
| @@ -436,7 +435,7 @@ delimited by point and mark.) The key @kbd{r} is used for this purpose. | |||
| 436 | Thus @kbd{d r} will delete the current region. If @kbd{R} is used instead | 435 | Thus @kbd{d r} will delete the current region. If @kbd{R} is used instead |
| 437 | of @kbd{r} the region will first be enlarged so that it will become the | 436 | of @kbd{r} the region will first be enlarged so that it will become the |
| 438 | smallest region containing the original region and consisting of whole | 437 | smallest region containing the original region and consisting of whole |
| 439 | lines. Thus @kbd{m .@: d R} will have the same effect as @kbd{d d}.@refill | 438 | lines. Thus @kbd{m .@: d R} will have the same effect as @kbd{d d}. |
| 440 | 439 | ||
| 441 | @node New Commands | 440 | @node New Commands |
| 442 | @subsection Some New Commands | 441 | @subsection Some New Commands |
| @@ -478,7 +477,7 @@ can execute a single Emacs command. After executing the Emacs command you | |||
| 478 | will be in vi mode again. You can give a count before typing @kbd{\}. | 477 | will be in vi mode again. You can give a count before typing @kbd{\}. |
| 479 | Thus @kbd{5 \ *}, as well as @kbd{\ C-u 5 *}, will insert @samp{*****} | 478 | Thus @kbd{5 \ *}, as well as @kbd{\ C-u 5 *}, will insert @samp{*****} |
| 480 | before point. Similarly @kbd{1 0 \ C-p} will move the point 10 lines above | 479 | before point. Similarly @kbd{1 0 \ C-p} will move the point 10 lines above |
| 481 | the current line.@refill | 480 | the current line. |
| 482 | @item K | 481 | @item K |
| 483 | @kindex 113 @kbd{K} (@code{vip-kill-buffer}) | 482 | @kindex 113 @kbd{K} (@code{vip-kill-buffer}) |
| 484 | Kill current buffer if it is not modified. Useful when you selected a | 483 | Kill current buffer if it is not modified. Useful when you selected a |
| @@ -504,7 +503,7 @@ similar, but will use window different from the current window. | |||
| 504 | If followed by a certain character @var{ch}, it becomes an operator whose | 503 | If followed by a certain character @var{ch}, it becomes an operator whose |
| 505 | argument is the region determined by the motion command that follows. | 504 | argument is the region determined by the motion command that follows. |
| 506 | Currently, @var{ch} can be one of @kbd{c}, @kbd{C}, @kbd{g}, @kbd{q} and | 505 | Currently, @var{ch} can be one of @kbd{c}, @kbd{C}, @kbd{g}, @kbd{q} and |
| 507 | @kbd{s}.@refill | 506 | @kbd{s}. |
| 508 | @item # c | 507 | @item # c |
| 509 | @kindex 0432 @kbd{# c} (@code{downcase-region}) | 508 | @kindex 0432 @kbd{# c} (@code{downcase-region}) |
| 510 | Change upper-case characters in the region to lower case | 509 | Change upper-case characters in the region to lower case |
| @@ -517,7 +516,7 @@ Change lower-case characters in the region to upper case. For instance, | |||
| 517 | @item # g | 516 | @item # g |
| 518 | @kindex 0432 @kbd{# g} (@code{vip-global-execute}) | 517 | @kindex 0432 @kbd{# g} (@code{vip-global-execute}) |
| 519 | Execute last keyboard macro for each line in the region | 518 | Execute last keyboard macro for each line in the region |
| 520 | (@code{vip-global-execute}).@refill | 519 | (@code{vip-global-execute}). |
| 521 | @item # q | 520 | @item # q |
| 522 | @kindex 0432 @kbd{# q} (@code{vip-quote-region}) | 521 | @kindex 0432 @kbd{# q} (@code{vip-quote-region}) |
| 523 | Insert specified string at the beginning of each line in the region | 522 | Insert specified string at the beginning of each line in the region |
| @@ -577,7 +576,7 @@ mode. You get the same effect by typing @kbd{C-x C-s} in vi mode, but | |||
| 577 | the idea here is that you can execute useful Emacs commands without typing | 576 | the idea here is that you can execute useful Emacs commands without typing |
| 578 | control characters. For example, if you hit @kbd{X} (or @kbd{C-x}) followed | 577 | control characters. For example, if you hit @kbd{X} (or @kbd{C-x}) followed |
| 579 | by @kbd{2}, then the current window will be split into 2 and you will be in | 578 | by @kbd{2}, then the current window will be split into 2 and you will be in |
| 580 | vi mode again.@refill | 579 | vi mode again. |
| 581 | @end table | 580 | @end table |
| 582 | 581 | ||
| 583 | In addition to these, @code{ctl-x-map} is slightly modified: | 582 | In addition to these, @code{ctl-x-map} is slightly modified: |
| @@ -723,7 +722,7 @@ Most Vi commands accept a @dfn{numeric argument} which can be supplied as | |||
| 723 | a prefix to the commands. A numeric argument is also called a @dfn{count}. | 722 | a prefix to the commands. A numeric argument is also called a @dfn{count}. |
| 724 | In many cases, if a count is given, the command is executed that many times. | 723 | In many cases, if a count is given, the command is executed that many times. |
| 725 | For instance, @kbd{5 d d} deletes 5 lines while simple @kbd{d d} deletes a | 724 | For instance, @kbd{5 d d} deletes 5 lines while simple @kbd{d d} deletes a |
| 726 | line. In this manual the metavariable @var{n} will denote a count.@refill | 725 | line. In this manual the metavariable @var{n} will denote a count. |
| 727 | 726 | ||
| 728 | @node Important Keys | 727 | @node Important Keys |
| 729 | @section Important Keys | 728 | @section Important Keys |
| @@ -742,7 +741,7 @@ Clear the screen and reprint everything (@code{recenter}). | |||
| 742 | 741 | ||
| 743 | In Emacs many commands are bound to the key strokes that start with | 742 | In Emacs many commands are bound to the key strokes that start with |
| 744 | @kbd{C-x}, @kbd{C-c} and @key{ESC}. These commands can be | 743 | @kbd{C-x}, @kbd{C-c} and @key{ESC}. These commands can be |
| 745 | accessed from vi mode as easily as from emacs mode.@refill | 744 | accessed from vi mode as easily as from emacs mode. |
| 746 | 745 | ||
| 747 | @table @kbd | 746 | @table @kbd |
| 748 | @item C-x | 747 | @item C-x |
| @@ -772,7 +771,7 @@ Escape to emacs mode. Hitting the @kbd{\} key will take you to emacs mode, | |||
| 772 | and you can execute a single Emacs command. After executing the | 771 | and you can execute a single Emacs command. After executing the |
| 773 | Emacs command you will be in vi mode again. You can give a count before | 772 | Emacs command you will be in vi mode again. You can give a count before |
| 774 | typing @kbd{\}. Thus @kbd{5 \ +}, as well as @kbd{\ C-u 5 +}, will insert | 773 | typing @kbd{\}. Thus @kbd{5 \ +}, as well as @kbd{\ C-u 5 +}, will insert |
| 775 | @samp{+++++} before point.@refill | 774 | @samp{+++++} before point. |
| 776 | @end table | 775 | @end table |
| 777 | 776 | ||
| 778 | @node Buffers and Windows | 777 | @node Buffers and Windows |
| @@ -784,7 +783,7 @@ typing @kbd{\}. Thus @kbd{5 \ +}, as well as @kbd{\ C-u 5 +}, will insert | |||
| 784 | 783 | ||
| 785 | In Emacs the text you edit is stored in a @dfn{buffer}. | 784 | In Emacs the text you edit is stored in a @dfn{buffer}. |
| 786 | See GNU Emacs Manual, for details. There is always one @dfn{current} | 785 | See GNU Emacs Manual, for details. There is always one @dfn{current} |
| 787 | buffer, also called the @dfn{selected buffer}.@refill | 786 | buffer, also called the @dfn{selected buffer}. |
| 788 | 787 | ||
| 789 | @cindex window | 788 | @cindex window |
| 790 | @cindex modified (buffer) | 789 | @cindex modified (buffer) |
| @@ -883,7 +882,7 @@ file in the current window, you can just type @kbd{v}. Emacs maintains the | |||
| 883 | @dfn{default directory} which is specific to each buffer. Suppose, for | 882 | @dfn{default directory} which is specific to each buffer. Suppose, for |
| 884 | instance, that the default directory of the current buffer is | 883 | instance, that the default directory of the current buffer is |
| 885 | @file{/usr/masahiko/lisp/}. Then you will get the following prompt in the | 884 | @file{/usr/masahiko/lisp/}. Then you will get the following prompt in the |
| 886 | minibuffer.@refill | 885 | minibuffer. |
| 887 | @example | 886 | @example |
| 888 | visit file: /usr/masahiko/lisp/ | 887 | visit file: /usr/masahiko/lisp/ |
| 889 | @end example | 888 | @end example |
| @@ -911,7 +910,7 @@ window. | |||
| 911 | 910 | ||
| 912 | You can verify which file you are editing by typing @kbd{g}. (You can also | 911 | You can verify which file you are editing by typing @kbd{g}. (You can also |
| 913 | type @kbd{X B} to get information on other buffers too.) If you type | 912 | type @kbd{X B} to get information on other buffers too.) If you type |
| 914 | @kbd{g} you will get an information like below in the echo area:@refill | 913 | @kbd{g} you will get an information like below in the echo area: |
| 915 | @example | 914 | @example |
| 916 | "/usr/masahiko/man/vip.texinfo" line 921 of 1949 | 915 | "/usr/masahiko/man/vip.texinfo" line 921 of 1949 |
| 917 | @end example | 916 | @end example |
| @@ -921,7 +920,7 @@ you may wish to save it in a file. If you wish to save it in the file | |||
| 921 | associated with the buffer (@file{/usr/masahiko/man/vip.texinfo}, in this | 920 | associated with the buffer (@file{/usr/masahiko/man/vip.texinfo}, in this |
| 922 | case), you can just say @kbd{X S}. If you wish to save it in another file, | 921 | case), you can just say @kbd{X S}. If you wish to save it in another file, |
| 923 | you can type @kbd{X W}. You will then get a similar prompt as you get for | 922 | you can type @kbd{X W}. You will then get a similar prompt as you get for |
| 924 | @kbd{v}, to which you can enter the file name.@refill | 923 | @kbd{v}, to which you can enter the file name. |
| 925 | 924 | ||
| 926 | @node Viewing the Buffer | 925 | @node Viewing the Buffer |
| 927 | @section Viewing the Buffer | 926 | @section Viewing the Buffer |
| @@ -1453,7 +1452,7 @@ For example, if point is at the beginning of a word @samp{foo} and you | |||
| 1453 | wish to change it to @samp{bar}, you can type @kbd{c w}. Then, as @kbd{w} | 1452 | wish to change it to @samp{bar}, you can type @kbd{c w}. Then, as @kbd{w} |
| 1454 | is a point command, you will get the prompt @samp{foo =>} in the | 1453 | is a point command, you will get the prompt @samp{foo =>} in the |
| 1455 | minibuffer, for which you can type @kbd{b a r @key{RET}} to complete the change | 1454 | minibuffer, for which you can type @kbd{b a r @key{RET}} to complete the change |
| 1456 | command.@refill | 1455 | command. |
| 1457 | 1456 | ||
| 1458 | @table @kbd | 1457 | @table @kbd |
| 1459 | @item c c | 1458 | @item c c |
diff --git a/doc/misc/viper.texi b/doc/misc/viper.texi index 8b4c9e93f7c..db5a5736888 100644 --- a/doc/misc/viper.texi +++ b/doc/misc/viper.texi | |||
| @@ -88,7 +88,7 @@ be visited as needed. | |||
| 88 | 88 | ||
| 89 | Comments and bug reports are welcome. | 89 | Comments and bug reports are welcome. |
| 90 | @code{kifer@@cs.stonybrook.edu} is the current address for Viper bug reports. | 90 | @code{kifer@@cs.stonybrook.edu} is the current address for Viper bug reports. |
| 91 | Please use the Ex command @kbd{:submitReport} for this purpose.@refill | 91 | Please use the Ex command @kbd{:submitReport} for this purpose. |
| 92 | 92 | ||
| 93 | @insertcopying | 93 | @insertcopying |
| 94 | @end ifnottex | 94 | @end ifnottex |
| @@ -147,7 +147,7 @@ comes with Emacs. This manual can be read as an Info file. Try the command | |||
| 147 | 147 | ||
| 148 | Comments and bug reports are welcome. | 148 | Comments and bug reports are welcome. |
| 149 | @code{kifer@@cs.stonybrook.edu} is the current address for Viper bug reports. | 149 | @code{kifer@@cs.stonybrook.edu} is the current address for Viper bug reports. |
| 150 | Please use the Ex command @kbd{:submitReport} for this purpose.@refill | 150 | Please use the Ex command @kbd{:submitReport} for this purpose. |
| 151 | 151 | ||
| 152 | @end iftex | 152 | @end iftex |
| 153 | 153 | ||
| @@ -197,21 +197,21 @@ Emacs can edit several files at once. A file in Emacs is placed in a | |||
| 197 | @dfn{buffer} that usually has the same name as the file. Buffers are also used | 197 | @dfn{buffer} that usually has the same name as the file. Buffers are also used |
| 198 | for other purposes, such as shell interfaces, directory editing, etc. | 198 | for other purposes, such as shell interfaces, directory editing, etc. |
| 199 | @xref{Dired,,Directory Editor,emacs,The | 199 | @xref{Dired,,Directory Editor,emacs,The |
| 200 | GNU Emacs Manual}, for an example.@refill | 200 | GNU Emacs Manual}, for an example. |
| 201 | 201 | ||
| 202 | A buffer has a distinguished position called the @dfn{point}. | 202 | A buffer has a distinguished position called the @dfn{point}. |
| 203 | A @dfn{point} is always between 2 characters, and is @dfn{looking at} | 203 | A @dfn{point} is always between 2 characters, and is @dfn{looking at} |
| 204 | the right hand character. The cursor is positioned on the right hand | 204 | the right hand character. The cursor is positioned on the right hand |
| 205 | character. Thus, when the @dfn{point} is looking at the end-of-line, | 205 | character. Thus, when the @dfn{point} is looking at the end-of-line, |
| 206 | the cursor is on the end-of-line character, i.e., beyond the last | 206 | the cursor is on the end-of-line character, i.e., beyond the last |
| 207 | character on the line. This is the default Emacs behavior.@refill | 207 | character on the line. This is the default Emacs behavior. |
| 208 | 208 | ||
| 209 | The default settings of Viper try to mimic the behavior of Vi, preventing | 209 | The default settings of Viper try to mimic the behavior of Vi, preventing |
| 210 | the cursor from going beyond the last character on the line. By using | 210 | the cursor from going beyond the last character on the line. By using |
| 211 | Emacs commands directly (such as those bound to arrow keys), it is possible | 211 | Emacs commands directly (such as those bound to arrow keys), it is possible |
| 212 | to get the cursor beyond the end-of-line. However, this won't (or | 212 | to get the cursor beyond the end-of-line. However, this won't (or |
| 213 | shouldn't) happen if you restrict yourself to standard Vi keys, unless you | 213 | shouldn't) happen if you restrict yourself to standard Vi keys, unless you |
| 214 | modify the default editing style. @xref{Customization}.@refill | 214 | modify the default editing style. @xref{Customization}. |
| 215 | 215 | ||
| 216 | In addition to the @dfn{point}, there is another distinguished buffer | 216 | In addition to the @dfn{point}, there is another distinguished buffer |
| 217 | position called the @dfn{mark}. @xref{Mark,,Mark,emacs,The GNU Emacs | 217 | position called the @dfn{mark}. @xref{Mark,,Mark,emacs,The GNU Emacs |
| @@ -232,7 +232,7 @@ assuming that the current region starts at line 123 and ends at line | |||
| 232 | 135. There is no need to type the line numbers, since Viper inserts them | 232 | 135. There is no need to type the line numbers, since Viper inserts them |
| 233 | automatically in front of the Ex command. | 233 | automatically in front of the Ex command. |
| 234 | 234 | ||
| 235 | @xref{Basics}, for more info.@refill | 235 | @xref{Basics}, for more info. |
| 236 | 236 | ||
| 237 | @cindex window | 237 | @cindex window |
| 238 | @cindex mode line | 238 | @cindex mode line |
| @@ -255,7 +255,7 @@ show the buffer name and current major and minor modes (see below). | |||
| 255 | A special buffer called @dfn{Minibuffer} is displayed as the last line | 255 | A special buffer called @dfn{Minibuffer} is displayed as the last line |
| 256 | in a minibuffer window. The minibuffer window is used for command input | 256 | in a minibuffer window. The minibuffer window is used for command input |
| 257 | output. Viper uses minibuffer window for @kbd{/} and @kbd{:} | 257 | output. Viper uses minibuffer window for @kbd{/} and @kbd{:} |
| 258 | commands.@refill | 258 | commands. |
| 259 | 259 | ||
| 260 | @cindex mode | 260 | @cindex mode |
| 261 | @cindex keymap | 261 | @cindex keymap |
| @@ -275,7 +275,7 @@ keymap then that function will be executed when you type the key. | |||
| 275 | If no function is bound to a key in the | 275 | If no function is bound to a key in the |
| 276 | local map, however, the function bound to the key in the global map | 276 | local map, however, the function bound to the key in the global map |
| 277 | will be executed. @xref{Major Modes,Major Modes,Major Modes,emacs,The | 277 | will be executed. @xref{Major Modes,Major Modes,Major Modes,emacs,The |
| 278 | GNU Emacs Manual}, for more information.@refill | 278 | GNU Emacs Manual}, for more information. |
| 279 | 279 | ||
| 280 | A buffer can also have a @dfn{minor mode}. Minor modes are options that | 280 | A buffer can also have a @dfn{minor mode}. Minor modes are options that |
| 281 | you can use or not. A buffer in @code{text-mode} can have | 281 | you can use or not. A buffer in @code{text-mode} can have |
| @@ -283,7 +283,7 @@ you can use or not. A buffer in @code{text-mode} can have | |||
| 283 | any time. In Emacs, a minor mode may have it own keymap, | 283 | any time. In Emacs, a minor mode may have it own keymap, |
| 284 | which overrides the local keymap when the minor mode is turned on. For | 284 | which overrides the local keymap when the minor mode is turned on. For |
| 285 | more information, @pxref{Minor Modes,Minor Modes,Minor Modes,emacs,The | 285 | more information, @pxref{Minor Modes,Minor Modes,Minor Modes,emacs,The |
| 286 | GNU Emacs Manual} @refill | 286 | GNU Emacs Manual}. |
| 287 | 287 | ||
| 288 | @cindex Viper as minor mode | 288 | @cindex Viper as minor mode |
| 289 | @cindex Control keys | 289 | @cindex Control keys |
| @@ -293,7 +293,7 @@ Viper is implemented as a collection of minor modes. Different minor modes | |||
| 293 | are involved when Viper emulates Vi command mode, Vi insert mode, etc. | 293 | are involved when Viper emulates Vi command mode, Vi insert mode, etc. |
| 294 | You can also turn Viper on and off at any time while in Vi command mode. | 294 | You can also turn Viper on and off at any time while in Vi command mode. |
| 295 | @xref{States in Viper}, for | 295 | @xref{States in Viper}, for |
| 296 | more information.@refill | 296 | more information. |
| 297 | 297 | ||
| 298 | Emacs uses Control and Meta modifiers. These are denoted as C and M, | 298 | Emacs uses Control and Meta modifiers. These are denoted as C and M, |
| 299 | e.g., @kbd{^Z} as @kbd{C-z} and @kbd{Meta-x} as @kbd{M-x}. The Meta key is | 299 | e.g., @kbd{^Z} as @kbd{C-z} and @kbd{Meta-x} as @kbd{M-x}. The Meta key is |
| @@ -303,7 +303,7 @@ holding the Meta key down. For keyboards that do not have a Meta key, | |||
| 303 | @key{ESC} is used as Meta. Thus @kbd{M-x} is typed as @kbd{@key{ESC} | 303 | @key{ESC} is used as Meta. Thus @kbd{M-x} is typed as @kbd{@key{ESC} |
| 304 | x}. Viper uses @key{ESC} to switch from Insert state to Vi state. Therefore | 304 | x}. Viper uses @key{ESC} to switch from Insert state to Vi state. Therefore |
| 305 | Viper defines @kbd{C-\} as its Meta key in Vi state. @xref{Vi State}, for | 305 | Viper defines @kbd{C-\} as its Meta key in Vi state. @xref{Vi State}, for |
| 306 | more info.@refill | 306 | more info. |
| 307 | 307 | ||
| 308 | Emacs is structured as a Lisp interpreter around a C core. Emacs keys | 308 | Emacs is structured as a Lisp interpreter around a C core. Emacs keys |
| 309 | cause Lisp functions to be called. It is possible to call these | 309 | cause Lisp functions to be called. It is possible to call these |
| @@ -357,7 +357,7 @@ command line, it will show the @samp{*scratch*} buffer, in the | |||
| 357 | editing files by using @kbd{:e}, @kbd{:vi}, or @kbd{v} commands. | 357 | editing files by using @kbd{:e}, @kbd{:vi}, or @kbd{v} commands. |
| 358 | (@xref{File and Buffer Handling}, for more information on @kbd{v} and other | 358 | (@xref{File and Buffer Handling}, for more information on @kbd{v} and other |
| 359 | new commands that, in many cases, are more convenient than @kbd{:e}, | 359 | new commands that, in many cases, are more convenient than @kbd{:e}, |
| 360 | @kbd{:vi}, and similar old-style Vi commands.)@refill | 360 | @kbd{:vi}, and similar old-style Vi commands.) |
| 361 | 361 | ||
| 362 | Finally, if at some point you would want to de-Viperize your running | 362 | Finally, if at some point you would want to de-Viperize your running |
| 363 | copy of Emacs after Viper has been loaded, the command @kbd{M-x | 363 | copy of Emacs after Viper has been loaded, the command @kbd{M-x |
| @@ -386,7 +386,7 @@ This is the state plain vanilla Emacs is normally in. After you have loaded | |||
| 386 | Viper, @kbd{C-z} will normally take you to Vi command state. Another | 386 | Viper, @kbd{C-z} will normally take you to Vi command state. Another |
| 387 | @kbd{C-z} will take you back to Emacs state. This toggle key can be | 387 | @kbd{C-z} will take you back to Emacs state. This toggle key can be |
| 388 | changed, @pxref{Customization} You can also type @kbd{M-x viper-mode} to | 388 | changed, @pxref{Customization} You can also type @kbd{M-x viper-mode} to |
| 389 | change to Vi state.@refill | 389 | change to Vi state. |
| 390 | 390 | ||
| 391 | 391 | ||
| 392 | For users who chose to set their user level to 1 at Viper setup time, | 392 | For users who chose to set their user level to 1 at Viper setup time, |
| @@ -424,7 +424,7 @@ boundary of a replacement region (usually designated via a @samp{$} sign), | |||
| 424 | it will automatically change to Insert state. You do not have to worry | 424 | it will automatically change to Insert state. You do not have to worry |
| 425 | about it. The key bindings remain practically the same as in Insert | 425 | about it. The key bindings remain practically the same as in Insert |
| 426 | state. If you type @key{ESC}, Viper will switch to Vi command mode, terminating the | 426 | state. If you type @key{ESC}, Viper will switch to Vi command mode, terminating the |
| 427 | replacement state.@refill | 427 | replacement state. |
| 428 | @end table | 428 | @end table |
| 429 | 429 | ||
| 430 | @cindex mode line | 430 | @cindex mode line |
| @@ -488,7 +488,7 @@ for editing LaTeX documents, Dired for directory editing, etc. These are | |||
| 488 | major modes, each with a different set of key-bindings. Viper states are | 488 | major modes, each with a different set of key-bindings. Viper states are |
| 489 | orthogonal to these Emacs major modes. The presence of these language | 489 | orthogonal to these Emacs major modes. The presence of these language |
| 490 | sensitive and other modes is a major win over Vi. @xref{Improvements over | 490 | sensitive and other modes is a major win over Vi. @xref{Improvements over |
| 491 | Vi}, for more.@refill | 491 | Vi}, for more. |
| 492 | 492 | ||
| 493 | The bindings for these modes can be made available in the Viper Insert state | 493 | The bindings for these modes can be made available in the Viper Insert state |
| 494 | as well as in Emacs state. Unless you specify your user level as 1 (a | 494 | as well as in Emacs state. Unless you specify your user level as 1 (a |
| @@ -541,7 +541,6 @@ functionality and no key-binding. Recursive edits are indicated by | |||
| 541 | Edit,Recursive Edit,emacs,The GNU Emacs Manual}. | 541 | Edit,Recursive Edit,emacs,The GNU Emacs Manual}. |
| 542 | At user level 1, @kbd{C-g} is bound to @code{viper-info-on-file} | 542 | At user level 1, @kbd{C-g} is bound to @code{viper-info-on-file} |
| 543 | function instead. | 543 | function instead. |
| 544 | @refill | ||
| 545 | @item C-\ | 544 | @item C-\ |
| 546 | @kindex @kbd{C-\} | 545 | @kindex @kbd{C-\} |
| 547 | @cindex Meta key | 546 | @cindex Meta key |
| @@ -652,7 +651,6 @@ In contrast to @kbd{:w!@: foo}, if the command were @kbd{:r foo}, the entire | |||
| 652 | command will appear in the history list. This is because having @kbd{:r} | 651 | command will appear in the history list. This is because having @kbd{:r} |
| 653 | alone as a default is meaningless, since this command requires a file | 652 | alone as a default is meaningless, since this command requires a file |
| 654 | argument. | 653 | argument. |
| 655 | @refill | ||
| 656 | @end table | 654 | @end table |
| 657 | @noindent | 655 | @noindent |
| 658 | As in Vi, Viper's destructive commands can be re-executed by typing `@kbd{.}'. | 656 | As in Vi, Viper's destructive commands can be re-executed by typing `@kbd{.}'. |
| @@ -673,7 +671,7 @@ Emacs major modes cannot be used in Insert state. | |||
| 673 | It is strongly recommended that as soon as you are comfortable, make the | 671 | It is strongly recommended that as soon as you are comfortable, make the |
| 674 | Emacs state bindings visible (by changing your user level to 3 or higher). | 672 | Emacs state bindings visible (by changing your user level to 3 or higher). |
| 675 | @xref{Customization}, | 673 | @xref{Customization}, |
| 676 | to see how to do this.@refill | 674 | to see how to do this. |
| 677 | 675 | ||
| 678 | Once this is done, it is possible to do quite a bit of editing in | 676 | Once this is done, it is possible to do quite a bit of editing in |
| 679 | Insert state. For instance, Emacs has a @dfn{yank} command, @kbd{C-y}, | 677 | Insert state. For instance, Emacs has a @dfn{yank} command, @kbd{C-y}, |
| @@ -823,13 +821,13 @@ If you set marker @samp{a} in | |||
| 823 | file @file{foo}, start editing file @file{bar} and type @kbd{'a}, then | 821 | file @file{foo}, start editing file @file{bar} and type @kbd{'a}, then |
| 824 | @emph{YOU WILL SWITCH TO FILE @file{foo}}. You can see the contents of a | 822 | @emph{YOU WILL SWITCH TO FILE @file{foo}}. You can see the contents of a |
| 825 | textmarker using the Viper command @kbd{[<a-z>} where <a-z> are the | 823 | textmarker using the Viper command @kbd{[<a-z>} where <a-z> are the |
| 826 | textmarkers, e.g., @kbd{[a} to view marker @samp{a} .@refill | 824 | textmarkers, e.g., @kbd{[a} to view marker @samp{a} . |
| 827 | @item Repeated Commands | 825 | @item Repeated Commands |
| 828 | Command repetitions are common over files. Typing @kbd{!!} will repeat the | 826 | Command repetitions are common over files. Typing @kbd{!!} will repeat the |
| 829 | last @kbd{!} command whichever file it was issued from. | 827 | last @kbd{!} command whichever file it was issued from. |
| 830 | Typing @kbd{.} will repeat the last command from any file, and | 828 | Typing @kbd{.} will repeat the last command from any file, and |
| 831 | searches will repeat the last search. Ex commands can be repeated by typing | 829 | searches will repeat the last search. Ex commands can be repeated by typing |
| 832 | @kbd{: @key{RET}}.@refill | 830 | @kbd{: @key{RET}}. |
| 833 | Note: in some rare cases, that @kbd{: @key{RET}} may do something dangerous. | 831 | Note: in some rare cases, that @kbd{: @key{RET}} may do something dangerous. |
| 834 | However, usually its effect can be undone by typing @kbd{u}. | 832 | However, usually its effect can be undone by typing @kbd{u}. |
| 835 | @item Registers | 833 | @item Registers |
| @@ -897,7 +895,7 @@ more powerful facilities for defining abbreviations. | |||
| 897 | it is not implemented. | 895 | it is not implemented. |
| 898 | A useful alternative is @code{cat -t -e file}. Unfortunately, it cannot | 896 | A useful alternative is @code{cat -t -e file}. Unfortunately, it cannot |
| 899 | be used directly inside Emacs, since Emacs will obdurately change @samp{^I} | 897 | be used directly inside Emacs, since Emacs will obdurately change @samp{^I} |
| 900 | back to normal tabs.@refill | 898 | back to normal tabs. |
| 901 | @end itemize | 899 | @end itemize |
| 902 | 900 | ||
| 903 | @node Improvements over Vi | 901 | @node Improvements over Vi |
| @@ -928,7 +926,7 @@ The Vi command set is based on the idea of combining motion commands | |||
| 928 | with other commands. The motion command is used as a text region | 926 | with other commands. The motion command is used as a text region |
| 929 | specifier for other commands. | 927 | specifier for other commands. |
| 930 | We classify motion commands into @dfn{point commands} and | 928 | We classify motion commands into @dfn{point commands} and |
| 931 | @dfn{line commands}.@refill | 929 | @dfn{line commands}. |
| 932 | 930 | ||
| 933 | @cindex point commands | 931 | @cindex point commands |
| 934 | 932 | ||
| @@ -1010,7 +1008,7 @@ direction. | |||
| 1010 | Since the undo size is limited, Viper can create backup files and | 1008 | Since the undo size is limited, Viper can create backup files and |
| 1011 | auto-save files. It will normally do this automatically. It is possible | 1009 | auto-save files. It will normally do this automatically. It is possible |
| 1012 | to have numbered backups, etc. For details, @pxref{Backup,,Backup and | 1010 | to have numbered backups, etc. For details, @pxref{Backup,,Backup and |
| 1013 | Auto-Save,emacs,The GNU Emacs Manual} @refill | 1011 | Auto-Save,emacs,The GNU Emacs Manual}. |
| 1014 | 1012 | ||
| 1015 | @comment [ balance parens | 1013 | @comment [ balance parens |
| 1016 | @cindex viewing registers and markers | 1014 | @cindex viewing registers and markers |
| @@ -1083,7 +1081,7 @@ where @samp{register} is any character from @samp{a} through @samp{z}. Then | |||
| 1083 | you can execute this macro using @kbd{@@register}. It is, of course, | 1081 | you can execute this macro using @kbd{@@register}. It is, of course, |
| 1084 | possible to yank some text into a register and execute it using | 1082 | possible to yank some text into a register and execute it using |
| 1085 | @kbd{@@register}. Typing @kbd{@@@@}, @kbd{@@RET}, or @kbd{@@C-j} will | 1083 | @kbd{@@register}. Typing @kbd{@@@@}, @kbd{@@RET}, or @kbd{@@C-j} will |
| 1086 | execute the last macro that was executed using @kbd{@@register}.@refill | 1084 | execute the last macro that was executed using @kbd{@@register}. |
| 1087 | 1085 | ||
| 1088 | Viper will automatically lowercase the register, so that pressing the | 1086 | Viper will automatically lowercase the register, so that pressing the |
| 1089 | @kbd{SHIFT} key for @kbd{@@} will not create problems. This is for | 1087 | @kbd{SHIFT} key for @kbd{@@} will not create problems. This is for |
| @@ -1105,7 +1103,7 @@ The last keyboard macro can also be executed using | |||
| 1105 | This is useful for Emacs style keyboard macros defined using @kbd{C-x(} | 1103 | This is useful for Emacs style keyboard macros defined using @kbd{C-x(} |
| 1106 | and @kbd{C-x)}. Emacs keyboard macros have more capabilities. | 1104 | and @kbd{C-x)}. Emacs keyboard macros have more capabilities. |
| 1107 | @xref{Keyboard Macros,,Keyboard Macros,emacs, The GNU Emacs Manual}, for | 1105 | @xref{Keyboard Macros,,Keyboard Macros,emacs, The GNU Emacs Manual}, for |
| 1108 | details.@refill | 1106 | details. |
| 1109 | 1107 | ||
| 1110 | Keyboard Macros allow an interesting form of Query-Replace: | 1108 | Keyboard Macros allow an interesting form of Query-Replace: |
| 1111 | @kbd{/pattern} or @kbd{n} to go to the next pattern (the query), followed by a | 1109 | @kbd{/pattern} or @kbd{n} to go to the next pattern (the query), followed by a |
| @@ -1161,7 +1159,7 @@ as you go along. Incremental Search is normally bound to @kbd{C-s} and | |||
| 1161 | @kbd{C-r}. @xref{Customization}, to find out how to change the bindings | 1159 | @kbd{C-r}. @xref{Customization}, to find out how to change the bindings |
| 1162 | of @kbd{C-r or C-s}. | 1160 | of @kbd{C-r or C-s}. |
| 1163 | For details, @pxref{Incremental Search,,Incremental | 1161 | For details, @pxref{Incremental Search,,Incremental |
| 1164 | Search,emacs,The GNU Emacs Manual} @refill | 1162 | Search,emacs,The GNU Emacs Manual}. |
| 1165 | 1163 | ||
| 1166 | @cindex query replace | 1164 | @cindex query replace |
| 1167 | 1165 | ||
| @@ -1308,7 +1306,7 @@ into 2. Except for novice users, @kbd{C-c} is also set to execute an Emacs | |||
| 1308 | command from the current major mode. @key{ESC} will do the same, if you | 1306 | command from the current major mode. @key{ESC} will do the same, if you |
| 1309 | configure @key{ESC} as Meta by setting @code{viper-no-multiple-ESC} to @code{nil} | 1307 | configure @key{ESC} as Meta by setting @code{viper-no-multiple-ESC} to @code{nil} |
| 1310 | in @file{.viper}. @xref{Customization}. @kbd{C-\} in Insert, Replace, or Vi | 1308 | in @file{.viper}. @xref{Customization}. @kbd{C-\} in Insert, Replace, or Vi |
| 1311 | states will make Emacs think @kbd{Meta} has been hit.@refill | 1309 | states will make Emacs think @kbd{Meta} has been hit. |
| 1312 | @item \ | 1310 | @item \ |
| 1313 | @kindex @kbd{\} | 1311 | @kindex @kbd{\} |
| 1314 | Escape to Emacs to execute a single Emacs command. For instance, | 1312 | Escape to Emacs to execute a single Emacs command. For instance, |
| @@ -1339,7 +1337,7 @@ argument is the region determined by the motion command that follows | |||
| 1339 | (indicated as <move>). | 1337 | (indicated as <move>). |
| 1340 | Currently, @var{ch} can be one of @kbd{c}, @kbd{C}, @kbd{g}, @kbd{q}, and | 1338 | Currently, @var{ch} can be one of @kbd{c}, @kbd{C}, @kbd{g}, @kbd{q}, and |
| 1341 | @kbd{s}. For instance, @kbd{#qr} will prompt you for a string and then | 1339 | @kbd{s}. For instance, @kbd{#qr} will prompt you for a string and then |
| 1342 | prepend this string to each line in the buffer.@refill | 1340 | prepend this string to each line in the buffer. |
| 1343 | @item # c | 1341 | @item # c |
| 1344 | @kindex @kbd{#c<move>} | 1342 | @kindex @kbd{#c<move>} |
| 1345 | @cindex changing case | 1343 | @cindex changing case |
| @@ -1355,7 +1353,7 @@ Emacs command @kbd{M-u} does the same for words. | |||
| 1355 | @item # g | 1353 | @item # g |
| 1356 | @kindex @kbd{#g<move>} | 1354 | @kindex @kbd{#g<move>} |
| 1357 | Execute last keyboard macro for each line in the region | 1355 | Execute last keyboard macro for each line in the region |
| 1358 | (@code{viper-global-execute}).@refill | 1356 | (@code{viper-global-execute}). |
| 1359 | @item # q | 1357 | @item # q |
| 1360 | @kindex @kbd{#q<move>} | 1358 | @kindex @kbd{#q<move>} |
| 1361 | Insert specified string at the beginning of each line in the region | 1359 | Insert specified string at the beginning of each line in the region |
| @@ -1401,7 +1399,7 @@ Go to end of heading. | |||
| 1401 | @item g <@emph{movement command}> | 1399 | @item g <@emph{movement command}> |
| 1402 | Search buffer for text delimited by movement command. The canonical | 1400 | Search buffer for text delimited by movement command. The canonical |
| 1403 | example is @kbd{gw} to search for the word under the cursor. | 1401 | example is @kbd{gw} to search for the word under the cursor. |
| 1404 | @xref{Improved Search}, for details.@refill | 1402 | @xref{Improved Search}, for details. |
| 1405 | @item C-g and C-] | 1403 | @item C-g and C-] |
| 1406 | @kindex @kbd{C-g} | 1404 | @kindex @kbd{C-g} |
| 1407 | @kindex @kbd{C-]} | 1405 | @kindex @kbd{C-]} |
| @@ -1560,7 +1558,7 @@ patches. | |||
| 1560 | @noindent | 1558 | @noindent |
| 1561 | Emacs Lisp archives exist on | 1559 | Emacs Lisp archives exist on |
| 1562 | @samp{archive.cis.ohio-state.edu} | 1560 | @samp{archive.cis.ohio-state.edu} |
| 1563 | and @samp{wuarchive.wustl.edu}@refill | 1561 | and @samp{wuarchive.wustl.edu} |
| 1564 | 1562 | ||
| 1565 | 1563 | ||
| 1566 | @node Customization | 1564 | @node Customization |
| @@ -1583,7 +1581,7 @@ Elisp code in your @file{.emacs} file before and after the @code{(require | |||
| 1583 | 'viper)} line. This method is @emph{not} recommended, unless you know what | 1581 | 'viper)} line. This method is @emph{not} recommended, unless you know what |
| 1584 | you are doing. Only two variables, @code{viper-mode} and | 1582 | you are doing. Only two variables, @code{viper-mode} and |
| 1585 | @code{viper-custom-file-name}, are supposed to be customized in @file{.emacs}, | 1583 | @code{viper-custom-file-name}, are supposed to be customized in @file{.emacs}, |
| 1586 | prior to loading Viper (i.e., prior to @code{(require 'viper)} command.@refill | 1584 | prior to loading Viper (i.e., prior to @code{(require 'viper)} command. |
| 1587 | @item | 1585 | @item |
| 1588 | @cindex :customize | 1586 | @cindex :customize |
| 1589 | By executing the @kbd{:customize} Ex command. This takes you to the Emacs | 1587 | By executing the @kbd{:customize} Ex command. This takes you to the Emacs |
| @@ -2780,7 +2778,7 @@ macros) lets the user define keyboard macros that ask for confirmation or | |||
| 2780 | even prompt the user for input and then continue. To do this, one should | 2778 | even prompt the user for input and then continue. To do this, one should |
| 2781 | type @kbd{C-x q} (for confirmation) or @kbd{C-u C-x q} (for prompt). | 2779 | type @kbd{C-x q} (for confirmation) or @kbd{C-u C-x q} (for prompt). |
| 2782 | For details, @pxref{Keyboard Macro Query,,Customization,emacs,The GNU Emacs | 2780 | For details, @pxref{Keyboard Macro Query,,Customization,emacs,The GNU Emacs |
| 2783 | Manual} @refill | 2781 | Manual}. |
| 2784 | 2782 | ||
| 2785 | When the user finishes defining a macro (which is done by typing @kbd{C-x)}, | 2783 | When the user finishes defining a macro (which is done by typing @kbd{C-x)}, |
| 2786 | a departure from Vi), you will be asked whether you want this | 2784 | a departure from Vi), you will be asked whether you want this |
| @@ -2994,7 +2992,7 @@ currently defined. To see all macros along with their definitions, type | |||
| 2994 | 2992 | ||
| 2995 | This section is a semi-automatically bowdlerized version of the Vi | 2993 | This section is a semi-automatically bowdlerized version of the Vi |
| 2996 | reference created by @* @samp{maart@@cs.vu.nl} and others. It can be | 2994 | reference created by @* @samp{maart@@cs.vu.nl} and others. It can be |
| 2997 | found on the Vi archives. This reference has been adapted for Viper.@refill | 2995 | found on the Vi archives. This reference has been adapted for Viper. |
| 2998 | 2996 | ||
| 2999 | @menu | 2997 | @menu |
| 3000 | * Groundwork:: Textual Conventions and Viper basics | 2998 | * Groundwork:: Textual Conventions and Viper basics |
| @@ -3015,7 +3013,7 @@ The VI command set is based on the idea of combining motion commands | |||
| 3015 | with other commands. The motion command is used as a text region | 3013 | with other commands. The motion command is used as a text region |
| 3016 | specifier for other commands. | 3014 | specifier for other commands. |
| 3017 | We classify motion commands into @dfn{point commands} and | 3015 | We classify motion commands into @dfn{point commands} and |
| 3018 | @dfn{line commands}.@refill | 3016 | @dfn{line commands}. |
| 3019 | 3017 | ||
| 3020 | @cindex point commands | 3018 | @cindex point commands |
| 3021 | 3019 | ||
| @@ -4187,7 +4185,7 @@ the whole file. | |||
| 4187 | @cindex @samp{#} (Previous file) | 4185 | @cindex @samp{#} (Previous file) |
| 4188 | Similarly, @samp{#} expands to the previous file. The previous file is the | 4186 | Similarly, @samp{#} expands to the previous file. The previous file is the |
| 4189 | first file in @kbd{:args} listing. This defaults to the previous file in | 4187 | first file in @kbd{:args} listing. This defaults to the previous file in |
| 4190 | the VI sense if you have one window.@refill | 4188 | the VI sense if you have one window. |
| 4191 | 4189 | ||
| 4192 | Symbols @samp{%} and @samp{#} are also used in the Ex commands @kbd{:e} and | 4190 | Symbols @samp{%} and @samp{#} are also used in the Ex commands @kbd{:e} and |
| 4193 | @kbd{:r <shell-cmd>}. The commands @kbd{:w} and the regular @kbd{:r | 4191 | @kbd{:r <shell-cmd>}. The commands @kbd{:w} and the regular @kbd{:r |
| @@ -4425,7 +4423,7 @@ a region under the mouse pointer. | |||
| 4425 | This command can take a prefix argument. Note: Viper sets this | 4423 | This command can take a prefix argument. Note: Viper sets this |
| 4426 | binding only if this mouse action is not | 4424 | binding only if this mouse action is not |
| 4427 | already bound to something else. | 4425 | already bound to something else. |
| 4428 | @xref{Viper Specials}, for more information.@refill | 4426 | @xref{Viper Specials}, for more information. |
| 4429 | 4427 | ||
| 4430 | @item S-Mouse-2 | 4428 | @item S-Mouse-2 |
| 4431 | Holding Shift and clicking button 2 of the mouse will | 4429 | Holding Shift and clicking button 2 of the mouse will |
| @@ -4433,7 +4431,7 @@ insert a region surrounding the mouse pointer. | |||
| 4433 | This command can also take a prefix argument. | 4431 | This command can also take a prefix argument. |
| 4434 | Note: Viper sets this binding only if this mouse action is not | 4432 | Note: Viper sets this binding only if this mouse action is not |
| 4435 | already bound to something else. | 4433 | already bound to something else. |
| 4436 | @xref{Viper Specials}, for more details.@refill | 4434 | @xref{Viper Specials}, for more details. |
| 4437 | @end table | 4435 | @end table |
| 4438 | @kindex @kbd{S-Mouse-1} | 4436 | @kindex @kbd{S-Mouse-1} |
| 4439 | @kindex @kbd{S-Mouse-2} | 4437 | @kindex @kbd{S-Mouse-2} |
diff --git a/doc/misc/widget.texi b/doc/misc/widget.texi index f2c403a2c14..2fe247dd750 100644 --- a/doc/misc/widget.texi +++ b/doc/misc/widget.texi | |||
| @@ -431,7 +431,6 @@ Set up a buffer to support widgets. | |||
| 431 | 431 | ||
| 432 | This should be called after creating all the widgets and before allowing | 432 | This should be called after creating all the widgets and before allowing |
| 433 | the user to edit them. | 433 | the user to edit them. |
| 434 | @refill | ||
| 435 | @end defun | 434 | @end defun |
| 436 | 435 | ||
| 437 | If you want to insert text outside the widgets in the form, the | 436 | If you want to insert text outside the widgets in the form, the |
| @@ -450,7 +449,7 @@ There is a standard widget keymap which you might find useful. | |||
| 450 | @key{TAB} and @kbd{C-@key{TAB}} are bound to @code{widget-forward} and | 449 | @key{TAB} and @kbd{C-@key{TAB}} are bound to @code{widget-forward} and |
| 451 | @code{widget-backward}, respectively. @key{RET} and @kbd{Mouse-2} | 450 | @code{widget-backward}, respectively. @key{RET} and @kbd{Mouse-2} |
| 452 | are bound to @code{widget-button-press} and | 451 | are bound to @code{widget-button-press} and |
| 453 | @code{widget-button-click}.@refill | 452 | @code{widget-button-click}. |
| 454 | @end defvr | 453 | @end defvr |
| 455 | 454 | ||
| 456 | @defvar widget-global-map | 455 | @defvar widget-global-map |
| @@ -1718,7 +1717,7 @@ Keymap used in @code{widget-minor-mode}. | |||
| 1718 | @defun widget-prompt-value widget prompt [ value unbound ] | 1717 | @defun widget-prompt-value widget prompt [ value unbound ] |
| 1719 | Prompt for a value matching @var{widget}, using @var{prompt}. | 1718 | Prompt for a value matching @var{widget}, using @var{prompt}. |
| 1720 | The current value is assumed to be @var{value}, unless @var{unbound} is | 1719 | The current value is assumed to be @var{value}, unless @var{unbound} is |
| 1721 | non-@code{nil}.@refill | 1720 | non-@code{nil}. |
| 1722 | @end defun | 1721 | @end defun |
| 1723 | 1722 | ||
| 1724 | @defun widget-get-sibling widget | 1723 | @defun widget-get-sibling widget |