diff options
| author | Juanma Barranquero | 2014-03-03 18:15:42 +0100 |
|---|---|---|
| committer | Juanma Barranquero | 2014-03-03 18:15:42 +0100 |
| commit | c19ad068c591a269900e8d9509021efc0ebc93d6 (patch) | |
| tree | d251c6aeb3749c6b3b9b46425743ebb85d86c362 /doc/misc | |
| parent | f2d2402ec6c20743783da788a6f93c7965744893 (diff) | |
| download | emacs-c19ad068c591a269900e8d9509021efc0ebc93d6.tar.gz emacs-c19ad068c591a269900e8d9509021efc0ebc93d6.zip | |
doc/misc/*.texi: Fix typos and whitespace.
* doc/misc/ede.texi (Android projects):
* doc/misc/eieio.texi (Class Options, Making New Objects)
(Method Invocation, CLOS compatibility):
* doc/misc/sem-user.texi (Tag Decoration Mode): Fix typos.
* doc/misc/gnus.texi:
* doc/misc/semantic.texi: Fix whitespace.
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/ChangeLog | 10 | ||||
| -rw-r--r-- | doc/misc/ede.texi | 2 | ||||
| -rw-r--r-- | doc/misc/eieio.texi | 10 | ||||
| -rw-r--r-- | doc/misc/gnus.texi | 240 | ||||
| -rw-r--r-- | doc/misc/sem-user.texi | 2 | ||||
| -rw-r--r-- | doc/misc/semantic.texi | 12 |
6 files changed, 143 insertions, 133 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 1145fc5fa4f..6e6146091f0 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,13 @@ | |||
| 1 | 2014-03-03 Juanma Barranquero <lekktu@gmail.com> | ||
| 2 | |||
| 3 | * gnus.texi: | ||
| 4 | * semantic.texi: Fix whitespace. | ||
| 5 | |||
| 6 | * ede.texi (Android projects): | ||
| 7 | * eieio.texi (Class Options, Making New Objects) | ||
| 8 | (Method Invocation, CLOS compatibility): | ||
| 9 | * sem-user.texi (Tag Decoration Mode): Fix typos. | ||
| 10 | |||
| 1 | 2014-03-02 Xue Fuqiao <xfq@gnu.org> | 11 | 2014-03-02 Xue Fuqiao <xfq@gnu.org> |
| 2 | 12 | ||
| 3 | * sem-user.texi (Create System Databases): Markup fix. | 13 | * sem-user.texi (Create System Databases): Markup fix. |
diff --git a/doc/misc/ede.texi b/doc/misc/ede.texi index 3ae040debea..16c70a5647e 100644 --- a/doc/misc/ede.texi +++ b/doc/misc/ede.texi | |||
| @@ -764,7 +764,7 @@ correctly configured Android SDK via @cedet{} support. | |||
| 764 | 764 | ||
| 765 | @defun cedet-android-sdk-root | 765 | @defun cedet-android-sdk-root |
| 766 | @anchor{cedet-android-sdk-root} | 766 | @anchor{cedet-android-sdk-root} |
| 767 | The root to the android @var{SDK}. | 767 | The root to the Android @var{SDK}. |
| 768 | @end defun | 768 | @end defun |
| 769 | 769 | ||
| 770 | Android projects support different configurations including compile, | 770 | Android projects support different configurations including compile, |
diff --git a/doc/misc/eieio.texi b/doc/misc/eieio.texi index a06b45f665f..bc1f2988738 100644 --- a/doc/misc/eieio.texi +++ b/doc/misc/eieio.texi | |||
| @@ -610,7 +610,7 @@ This is the default. | |||
| 610 | @item :depth-first | 610 | @item :depth-first |
| 611 | Search for methods in the class hierarchy in a depth first order. | 611 | Search for methods in the class hierarchy in a depth first order. |
| 612 | @item :c3 | 612 | @item :c3 |
| 613 | Searches for methods in in a linearized way that most closely matches | 613 | Searches for methods in a linearized way that most closely matches |
| 614 | what CLOS does when a monotonic class structure is defined. | 614 | what CLOS does when a monotonic class structure is defined. |
| 615 | @end table | 615 | @end table |
| 616 | 616 | ||
| @@ -644,7 +644,7 @@ It is now possible to create objects of that class type. | |||
| 644 | 644 | ||
| 645 | Calling @code{defclass} has defined two new functions. One is the | 645 | Calling @code{defclass} has defined two new functions. One is the |
| 646 | constructor @var{record}, and the other is the predicate, | 646 | constructor @var{record}, and the other is the predicate, |
| 647 | @var{record-p}. | 647 | @var{record}-p. |
| 648 | 648 | ||
| 649 | @defun record object-name &rest slots | 649 | @defun record object-name &rest slots |
| 650 | 650 | ||
| @@ -1022,8 +1022,8 @@ This is the default. | |||
| 1022 | @item :depth-first | 1022 | @item :depth-first |
| 1023 | Search for methods in the class hierarchy in a depth first order. | 1023 | Search for methods in the class hierarchy in a depth first order. |
| 1024 | @item :c3 | 1024 | @item :c3 |
| 1025 | Searches for methods in in a linearized way that most closely matches | 1025 | Searches for methods in a linearized way that most closely matches |
| 1026 | what CLOS does when CLOS when a monotonic class structure is defined. | 1026 | what CLOS does when a monotonic class structure is defined. |
| 1027 | 1027 | ||
| 1028 | This is derived from the Dylan language documents by | 1028 | This is derived from the Dylan language documents by |
| 1029 | Kim Barrett et al.: A Monotonic Superclass Linearization for Dylan | 1029 | Kim Barrett et al.: A Monotonic Superclass Linearization for Dylan |
| @@ -1826,7 +1826,7 @@ It therefore has the same issues as that package. Extensions include | |||
| 1826 | the ability to provide object names. | 1826 | the ability to provide object names. |
| 1827 | @end table | 1827 | @end table |
| 1828 | 1828 | ||
| 1829 | Defclass also supports class options, but does not currently use values | 1829 | defclass also supports class options, but does not currently use values |
| 1830 | of @code{:metaclass}, and @code{:default-initargs}. | 1830 | of @code{:metaclass}, and @code{:default-initargs}. |
| 1831 | 1831 | ||
| 1832 | @item make-instance | 1832 | @item make-instance |
diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index 6ad0c26f9ac..44d1f0352f3 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi | |||
| @@ -461,7 +461,7 @@ Group Buffer | |||
| 461 | * Selecting a Group:: Actually reading news. | 461 | * Selecting a Group:: Actually reading news. |
| 462 | * Subscription Commands:: Unsubscribing, killing, subscribing. | 462 | * Subscription Commands:: Unsubscribing, killing, subscribing. |
| 463 | * Group Data:: Changing the info for a group. | 463 | * Group Data:: Changing the info for a group. |
| 464 | * Group Levels:: Levels? What are those, then? | 464 | * Group Levels:: Levels? What are those, then? |
| 465 | * Group Score:: A mechanism for finding out what groups you like. | 465 | * Group Score:: A mechanism for finding out what groups you like. |
| 466 | * Marking Groups:: You can mark groups for later processing. | 466 | * Marking Groups:: You can mark groups for later processing. |
| 467 | * Foreign Groups:: Creating and editing groups. | 467 | * Foreign Groups:: Creating and editing groups. |
| @@ -521,7 +521,7 @@ Summary Buffer | |||
| 521 | * Charsets:: Character set issues. | 521 | * Charsets:: Character set issues. |
| 522 | * Article Commands:: Doing various things with the article buffer. | 522 | * Article Commands:: Doing various things with the article buffer. |
| 523 | * Summary Sorting:: Sorting the summary buffer in various ways. | 523 | * Summary Sorting:: Sorting the summary buffer in various ways. |
| 524 | * Finding the Parent:: No child support? Get the parent. | 524 | * Finding the Parent:: No child support? Get the parent. |
| 525 | * Alternative Approaches:: Reading using non-default summaries. | 525 | * Alternative Approaches:: Reading using non-default summaries. |
| 526 | * Tree Display:: A more visual display of threads. | 526 | * Tree Display:: A more visual display of threads. |
| 527 | * Mail Group Commands:: Some commands can only be used in mail groups. | 527 | * Mail Group Commands:: Some commands can only be used in mail groups. |
| @@ -1095,7 +1095,7 @@ your mail without bothering with the server at all, you can use the | |||
| 1095 | if you're in a hurry as well. This command will not attempt to contact | 1095 | if you're in a hurry as well. This command will not attempt to contact |
| 1096 | your primary server---instead, it will just activate all groups on level | 1096 | your primary server---instead, it will just activate all groups on level |
| 1097 | 1 and 2. (You should preferably keep no native groups on those two | 1097 | 1 and 2. (You should preferably keep no native groups on those two |
| 1098 | levels.) Also @pxref{Group Levels}. | 1098 | levels.) Also @pxref{Group Levels}. |
| 1099 | 1099 | ||
| 1100 | 1100 | ||
| 1101 | @node Slave Gnusae | 1101 | @node Slave Gnusae |
| @@ -1678,7 +1678,7 @@ long as Gnus is active. | |||
| 1678 | * Selecting a Group:: Actually reading news. | 1678 | * Selecting a Group:: Actually reading news. |
| 1679 | * Subscription Commands:: Unsubscribing, killing, subscribing. | 1679 | * Subscription Commands:: Unsubscribing, killing, subscribing. |
| 1680 | * Group Data:: Changing the info for a group. | 1680 | * Group Data:: Changing the info for a group. |
| 1681 | * Group Levels:: Levels? What are those, then? | 1681 | * Group Levels:: Levels? What are those, then? |
| 1682 | * Group Score:: A mechanism for finding out what groups you like. | 1682 | * Group Score:: A mechanism for finding out what groups you like. |
| 1683 | * Marking Groups:: You can mark groups for later processing. | 1683 | * Marking Groups:: You can mark groups for later processing. |
| 1684 | * Foreign Groups:: Creating and editing groups. | 1684 | * Foreign Groups:: Creating and editing groups. |
| @@ -2854,7 +2854,7 @@ If the group parameter list has the element @code{(visible . t)}, | |||
| 2854 | that group will always be visible in the Group buffer, regardless | 2854 | that group will always be visible in the Group buffer, regardless |
| 2855 | of whether it has any unread articles. | 2855 | of whether it has any unread articles. |
| 2856 | 2856 | ||
| 2857 | This parameter cannot be set via @code{gnus-parameters}. See | 2857 | This parameter cannot be set via @code{gnus-parameters}. See |
| 2858 | @code{gnus-permanently-visible-groups} as an alternative. | 2858 | @code{gnus-permanently-visible-groups} as an alternative. |
| 2859 | 2859 | ||
| 2860 | @item broken-reply-to | 2860 | @item broken-reply-to |
| @@ -3036,8 +3036,8 @@ like this in the group parameters: | |||
| 3036 | 3036 | ||
| 3037 | If you're using topics to organize your group buffer | 3037 | If you're using topics to organize your group buffer |
| 3038 | (@pxref{Group Topics}), note that posting styles can also be set in | 3038 | (@pxref{Group Topics}), note that posting styles can also be set in |
| 3039 | the topics parameters. Posting styles in topic parameters apply to all | 3039 | the topics parameters. Posting styles in topic parameters apply to all |
| 3040 | groups in this topic. More precisely, the posting-style settings for a | 3040 | groups in this topic. More precisely, the posting-style settings for a |
| 3041 | group result from the hierarchical merging of all posting-style | 3041 | group result from the hierarchical merging of all posting-style |
| 3042 | entries in the parameters of this group and all the topics it belongs | 3042 | entries in the parameters of this group and all the topics it belongs |
| 3043 | to. | 3043 | to. |
| @@ -4750,7 +4750,7 @@ command or better use it as a prefix key. For example: | |||
| 4750 | * Charsets:: Character set issues. | 4750 | * Charsets:: Character set issues. |
| 4751 | * Article Commands:: Doing various things with the article buffer. | 4751 | * Article Commands:: Doing various things with the article buffer. |
| 4752 | * Summary Sorting:: Sorting the summary buffer in various ways. | 4752 | * Summary Sorting:: Sorting the summary buffer in various ways. |
| 4753 | * Finding the Parent:: No child support? Get the parent. | 4753 | * Finding the Parent:: No child support? Get the parent. |
| 4754 | * Alternative Approaches:: Reading using non-default summaries. | 4754 | * Alternative Approaches:: Reading using non-default summaries. |
| 4755 | * Tree Display:: A more visual display of threads. | 4755 | * Tree Display:: A more visual display of threads. |
| 4756 | * Mail Group Commands:: Some commands can only be used in mail groups. | 4756 | * Mail Group Commands:: Some commands can only be used in mail groups. |
| @@ -8508,7 +8508,7 @@ pseudo-articles when decoding. It is @code{t} by default. | |||
| 8508 | 8508 | ||
| 8509 | So; there you are, reading your @emph{pseudo-articles} in your | 8509 | So; there you are, reading your @emph{pseudo-articles} in your |
| 8510 | @emph{virtual newsgroup} from the @emph{virtual server}; and you think: | 8510 | @emph{virtual newsgroup} from the @emph{virtual server}; and you think: |
| 8511 | Why isn't anything real anymore? How did we get here? | 8511 | Why isn't anything real anymore? How did we get here? |
| 8512 | 8512 | ||
| 8513 | 8513 | ||
| 8514 | @node Article Treatment | 8514 | @node Article Treatment |
| @@ -9546,7 +9546,7 @@ Display the original date (@code{gnus-article-date-original}). This can | |||
| 9546 | be useful if you normally use some other conversion function and are | 9546 | be useful if you normally use some other conversion function and are |
| 9547 | worried that it might be doing something totally wrong. Say, claiming | 9547 | worried that it might be doing something totally wrong. Say, claiming |
| 9548 | that the article was posted in 1854. Although something like that is | 9548 | that the article was posted in 1854. Although something like that is |
| 9549 | @emph{totally} impossible. Don't you trust me? *titter* | 9549 | @emph{totally} impossible. Don't you trust me? *titter* |
| 9550 | 9550 | ||
| 9551 | @end table | 9551 | @end table |
| 9552 | 9552 | ||
| @@ -14302,7 +14302,7 @@ Here's a complete example @code{nnimap} backend with a client-side | |||
| 14302 | @cindex reading mail | 14302 | @cindex reading mail |
| 14303 | @cindex mail | 14303 | @cindex mail |
| 14304 | 14304 | ||
| 14305 | Reading mail with a newsreader---isn't that just plain WeIrD@? But of | 14305 | Reading mail with a newsreader---isn't that just plain WeIrD@? But of |
| 14306 | course. | 14306 | course. |
| 14307 | 14307 | ||
| 14308 | @menu | 14308 | @menu |
| @@ -16001,7 +16001,7 @@ this, it keeps a cache of old @code{Message-ID}s: | |||
| 16001 | default. The approximate maximum number of @code{Message-ID}s stored | 16001 | default. The approximate maximum number of @code{Message-ID}s stored |
| 16002 | there is controlled by the @code{nnmail-message-id-cache-length} | 16002 | there is controlled by the @code{nnmail-message-id-cache-length} |
| 16003 | variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be | 16003 | variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be |
| 16004 | stored.) If all this sounds scary to you, you can set | 16004 | stored.) If all this sounds scary to you, you can set |
| 16005 | @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by | 16005 | @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by |
| 16006 | default), and @code{nnmail} won't delete duplicate mails. Instead it | 16006 | default), and @code{nnmail} won't delete duplicate mails. Instead it |
| 16007 | will insert a warning into the head of the mail saying that it thinks | 16007 | will insert a warning into the head of the mail saying that it thinks |
| @@ -16767,11 +16767,11 @@ incompatible group parameters, slightly different from those of other | |||
| 16767 | mail back ends. | 16767 | mail back ends. |
| 16768 | 16768 | ||
| 16769 | @code{nnmaildir} is largely similar to @code{nnml}, with some notable | 16769 | @code{nnmaildir} is largely similar to @code{nnml}, with some notable |
| 16770 | differences. Each message is stored in a separate file, but the | 16770 | differences. Each message is stored in a separate file, but the |
| 16771 | filename is unrelated to the article number in Gnus. @code{nnmaildir} | 16771 | filename is unrelated to the article number in Gnus. @code{nnmaildir} |
| 16772 | also stores the equivalent of @code{nnml}'s overview files in one file | 16772 | also stores the equivalent of @code{nnml}'s overview files in one file |
| 16773 | per article, so it uses about twice as many inodes as @code{nnml}. | 16773 | per article, so it uses about twice as many inodes as @code{nnml}. |
| 16774 | (Use @code{df -i} to see how plentiful your inode supply is.) If this | 16774 | (Use @code{df -i} to see how plentiful your inode supply is.) If this |
| 16775 | slows you down or takes up very much space, a non-block-structured | 16775 | slows you down or takes up very much space, a non-block-structured |
| 16776 | file system. | 16776 | file system. |
| 16777 | 16777 | ||
| @@ -18100,7 +18100,7 @@ sending the diary message to them as well. | |||
| 18100 | @item | 18100 | @item |
| 18101 | However, since @code{nndiary} also has a @code{request-post} method, you | 18101 | However, since @code{nndiary} also has a @code{request-post} method, you |
| 18102 | can also use @kbd{C-u a} instead of @kbd{C-u m} on a diary group and the | 18102 | can also use @kbd{C-u a} instead of @kbd{C-u m} on a diary group and the |
| 18103 | message won't actually be sent; just stored locally in the group. This | 18103 | message won't actually be sent; just stored locally in the group. This |
| 18104 | comes in very handy for private appointments. | 18104 | comes in very handy for private appointments. |
| 18105 | @end itemize | 18105 | @end itemize |
| 18106 | 18106 | ||
| @@ -20934,7 +20934,7 @@ very interesting: | |||
| 20934 | @end example | 20934 | @end example |
| 20935 | 20935 | ||
| 20936 | Suppose you're reading a high volume group and you're only interested | 20936 | Suppose you're reading a high volume group and you're only interested |
| 20937 | in replies. The plan is to score down all articles that don't have | 20937 | in replies. The plan is to score down all articles that don't have |
| 20938 | subject that begin with "Re:", "Fw:" or "Fwd:" and then score up all | 20938 | subject that begin with "Re:", "Fw:" or "Fwd:" and then score up all |
| 20939 | parents of articles that have subjects that begin with reply marks. | 20939 | parents of articles that have subjects that begin with reply marks. |
| 20940 | 20940 | ||
| @@ -21065,7 +21065,7 @@ comparison of nnir, nnmairix, contrib/gnus-namazu would be nice | |||
| 21065 | as well. | 21065 | as well. |
| 21066 | 21066 | ||
| 21067 | This chapter describes tools for searching groups and servers for | 21067 | This chapter describes tools for searching groups and servers for |
| 21068 | articles matching a query and then retrieving those articles. Gnus | 21068 | articles matching a query and then retrieving those articles. Gnus |
| 21069 | provides a simpler mechanism for searching through articles in a summary buffer | 21069 | provides a simpler mechanism for searching through articles in a summary buffer |
| 21070 | to find those matching a pattern. @xref{Searching for Articles}. | 21070 | to find those matching a pattern. @xref{Searching for Articles}. |
| 21071 | 21071 | ||
| @@ -21091,13 +21091,13 @@ within gnus. | |||
| 21091 | @subsection What is nnir? | 21091 | @subsection What is nnir? |
| 21092 | 21092 | ||
| 21093 | @code{nnir} is a Gnus interface to a number of tools for searching | 21093 | @code{nnir} is a Gnus interface to a number of tools for searching |
| 21094 | through mail and news repositories. Different backends (like | 21094 | through mail and news repositories. Different backends (like |
| 21095 | @code{nnimap} and @code{nntp}) work with different tools (called | 21095 | @code{nnimap} and @code{nntp}) work with different tools (called |
| 21096 | @dfn{engines} in @code{nnir} lingo), but all use the same basic search | 21096 | @dfn{engines} in @code{nnir} lingo), but all use the same basic search |
| 21097 | interface. | 21097 | interface. |
| 21098 | 21098 | ||
| 21099 | The @code{nnimap} and @code{gmane} search engines should work with no | 21099 | The @code{nnimap} and @code{gmane} search engines should work with no |
| 21100 | configuration. Other engines require a local index that needs to be | 21100 | configuration. Other engines require a local index that needs to be |
| 21101 | created and maintained outside of Gnus. | 21101 | created and maintained outside of Gnus. |
| 21102 | 21102 | ||
| 21103 | 21103 | ||
| @@ -21108,35 +21108,35 @@ In the group buffer typing @kbd{G G} will search the group on the | |||
| 21108 | current line by calling @code{gnus-group-make-nnir-group}. This prompts | 21108 | current line by calling @code{gnus-group-make-nnir-group}. This prompts |
| 21109 | for a query string, creates an ephemeral @code{nnir} group containing | 21109 | for a query string, creates an ephemeral @code{nnir} group containing |
| 21110 | the articles that match this query, and takes you to a summary buffer | 21110 | the articles that match this query, and takes you to a summary buffer |
| 21111 | showing these articles. Articles may then be read, moved and deleted | 21111 | showing these articles. Articles may then be read, moved and deleted |
| 21112 | using the usual commands. | 21112 | using the usual commands. |
| 21113 | 21113 | ||
| 21114 | The @code{nnir} group made in this way is an @code{ephemeral} group, | 21114 | The @code{nnir} group made in this way is an @code{ephemeral} group, |
| 21115 | and some changes are not permanent: aside from reading, moving, and | 21115 | and some changes are not permanent: aside from reading, moving, and |
| 21116 | deleting, you can't act on the original article. But there is an | 21116 | deleting, you can't act on the original article. But there is an |
| 21117 | alternative: you can @emph{warp} (i.e., jump) to the original group | 21117 | alternative: you can @emph{warp} (i.e., jump) to the original group |
| 21118 | for the article on the current line with @kbd{A W}, aka | 21118 | for the article on the current line with @kbd{A W}, aka |
| 21119 | @code{gnus-warp-to-article}. Even better, the function | 21119 | @code{gnus-warp-to-article}. Even better, the function |
| 21120 | @code{gnus-summary-refer-thread}, bound by default in summary buffers | 21120 | @code{gnus-summary-refer-thread}, bound by default in summary buffers |
| 21121 | to @kbd{A T}, will first warp to the original group before it works | 21121 | to @kbd{A T}, will first warp to the original group before it works |
| 21122 | its magic and includes all the articles in the thread. From here you | 21122 | its magic and includes all the articles in the thread. From here you |
| 21123 | can read, move and delete articles, but also copy them, alter article | 21123 | can read, move and delete articles, but also copy them, alter article |
| 21124 | marks, whatever. Go nuts. | 21124 | marks, whatever. Go nuts. |
| 21125 | 21125 | ||
| 21126 | You say you want to search more than just the group on the current line? | 21126 | You say you want to search more than just the group on the current line? |
| 21127 | No problem: just process-mark the groups you want to search. You want | 21127 | No problem: just process-mark the groups you want to search. You want |
| 21128 | even more? Calling for an nnir search with the cursor on a topic heading | 21128 | even more? Calling for an nnir search with the cursor on a topic heading |
| 21129 | will search all the groups under that heading. | 21129 | will search all the groups under that heading. |
| 21130 | 21130 | ||
| 21131 | Still not enough? OK, in the server buffer | 21131 | Still not enough? OK, in the server buffer |
| 21132 | @code{gnus-group-make-nnir-group} (now bound to @kbd{G}) will search all | 21132 | @code{gnus-group-make-nnir-group} (now bound to @kbd{G}) will search all |
| 21133 | groups from the server on the current line. Too much? Want to ignore | 21133 | groups from the server on the current line. Too much? Want to ignore |
| 21134 | certain groups when searching, like spam groups? Just customize | 21134 | certain groups when searching, like spam groups? Just customize |
| 21135 | @code{nnir-ignored-newsgroups}. | 21135 | @code{nnir-ignored-newsgroups}. |
| 21136 | 21136 | ||
| 21137 | One more thing: individual search engines may have special search | 21137 | One more thing: individual search engines may have special search |
| 21138 | features. You can access these special features by giving a prefix-arg | 21138 | features. You can access these special features by giving a prefix-arg |
| 21139 | to @code{gnus-group-make-nnir-group}. If you are searching multiple | 21139 | to @code{gnus-group-make-nnir-group}. If you are searching multiple |
| 21140 | groups with different search engines you will be prompted for the | 21140 | groups with different search engines you will be prompted for the |
| 21141 | special search features for each engine separately. | 21141 | special search features for each engine separately. |
| 21142 | 21142 | ||
| @@ -21144,16 +21144,16 @@ special search features for each engine separately. | |||
| 21144 | @node Setting up nnir | 21144 | @node Setting up nnir |
| 21145 | @subsection Setting up nnir | 21145 | @subsection Setting up nnir |
| 21146 | 21146 | ||
| 21147 | To set up nnir you may need to do some prep work. Firstly, you may need | 21147 | To set up nnir you may need to do some prep work. Firstly, you may need |
| 21148 | to configure the search engines you plan to use. Some of them, like | 21148 | to configure the search engines you plan to use. Some of them, like |
| 21149 | @code{imap} and @code{gmane}, need no special configuration. Others, | 21149 | @code{imap} and @code{gmane}, need no special configuration. Others, |
| 21150 | like @code{namazu} and @code{swish}, require configuration as described | 21150 | like @code{namazu} and @code{swish}, require configuration as described |
| 21151 | below. Secondly, you need to associate a search engine with a server or | 21151 | below. Secondly, you need to associate a search engine with a server or |
| 21152 | a backend. | 21152 | a backend. |
| 21153 | 21153 | ||
| 21154 | If you just want to use the @code{imap} engine to search @code{nnimap} | 21154 | If you just want to use the @code{imap} engine to search @code{nnimap} |
| 21155 | servers, and the @code{gmane} engine to search @code{gmane} then you | 21155 | servers, and the @code{gmane} engine to search @code{gmane} then you |
| 21156 | don't have to do anything. But you might want to read the details of the | 21156 | don't have to do anything. But you might want to read the details of the |
| 21157 | query language anyway. | 21157 | query language anyway. |
| 21158 | 21158 | ||
| 21159 | @menu | 21159 | @menu |
| @@ -21173,9 +21173,9 @@ query language anyway. | |||
| 21173 | 21173 | ||
| 21174 | 21174 | ||
| 21175 | When searching a group, @code{nnir} needs to know which search engine to | 21175 | When searching a group, @code{nnir} needs to know which search engine to |
| 21176 | use. You can configure a given server to use a particular engine by | 21176 | use. You can configure a given server to use a particular engine by |
| 21177 | setting the server variable @code{nnir-search-engine} to the engine | 21177 | setting the server variable @code{nnir-search-engine} to the engine |
| 21178 | name. For example to use the @code{namazu} engine to search the server | 21178 | name. For example to use the @code{namazu} engine to search the server |
| 21179 | named @code{home} you can use | 21179 | named @code{home} you can use |
| 21180 | 21180 | ||
| 21181 | @lisp | 21181 | @lisp |
| @@ -21186,14 +21186,14 @@ named @code{home} you can use | |||
| 21186 | @end lisp | 21186 | @end lisp |
| 21187 | 21187 | ||
| 21188 | Alternatively you might want to use a particular engine for all servers | 21188 | Alternatively you might want to use a particular engine for all servers |
| 21189 | with a given backend. For example, you might want to use the @code{imap} | 21189 | with a given backend. For example, you might want to use the @code{imap} |
| 21190 | engine for all servers using the @code{nnimap} backend. In this case you | 21190 | engine for all servers using the @code{nnimap} backend. In this case you |
| 21191 | can customize the variable @code{nnir-method-default-engines}. This is | 21191 | can customize the variable @code{nnir-method-default-engines}. This is |
| 21192 | an alist of pairs of the form @code{(backend . engine)}. By default this | 21192 | an alist of pairs of the form @code{(backend . engine)}. By default this |
| 21193 | variable is set to use the @code{imap} engine for all servers using the | 21193 | variable is set to use the @code{imap} engine for all servers using the |
| 21194 | @code{nnimap} backend, and the @code{gmane} backend for @code{nntp} | 21194 | @code{nnimap} backend, and the @code{gmane} backend for @code{nntp} |
| 21195 | servers. (Don't worry, the @code{gmane} search engine won't actually try | 21195 | servers. (Don't worry, the @code{gmane} search engine won't actually try |
| 21196 | to search non-gmane @code{nntp} servers.) But if you wanted to use | 21196 | to search non-gmane @code{nntp} servers.) But if you wanted to use |
| 21197 | @code{namazu} for all your servers with an @code{nnimap} backend you | 21197 | @code{namazu} for all your servers with an @code{nnimap} backend you |
| 21198 | could change this to | 21198 | could change this to |
| 21199 | 21199 | ||
| @@ -21215,10 +21215,10 @@ features (inspired by the Google search input language): | |||
| 21215 | 21215 | ||
| 21216 | @item Boolean query operators | 21216 | @item Boolean query operators |
| 21217 | AND, OR, and NOT are supported, and parentheses can be used to control | 21217 | AND, OR, and NOT are supported, and parentheses can be used to control |
| 21218 | operator precedence, e.g., (emacs OR xemacs) AND linux. Note that | 21218 | operator precedence, e.g., (emacs OR xemacs) AND linux. Note that |
| 21219 | operators must be written with all capital letters to be | 21219 | operators must be written with all capital letters to be |
| 21220 | recognized. Also preceding a term with a @minus{} sign is equivalent to NOT | 21220 | recognized. Also preceding a term with a @minus{} sign is equivalent |
| 21221 | term. | 21221 | to NOT term. |
| 21222 | 21222 | ||
| 21223 | @item Automatic AND queries | 21223 | @item Automatic AND queries |
| 21224 | If you specify multiple words then they will be treated as an AND | 21224 | If you specify multiple words then they will be treated as an AND |
| @@ -21230,20 +21230,20 @@ literal string. | |||
| 21230 | 21230 | ||
| 21231 | @end table | 21231 | @end table |
| 21232 | 21232 | ||
| 21233 | By default the whole message will be searched. The query can be limited | 21233 | By default the whole message will be searched. The query can be limited |
| 21234 | to a specific part of a message by using a prefix-arg. After inputting | 21234 | to a specific part of a message by using a prefix-arg. After inputting |
| 21235 | the query this will prompt (with completion) for a message part. | 21235 | the query this will prompt (with completion) for a message part. |
| 21236 | Choices include ``Whole message'', ``Subject'', ``From'', and | 21236 | Choices include ``Whole message'', ``Subject'', ``From'', and |
| 21237 | ``To''. Any unrecognized input is interpreted as a header name. For | 21237 | ``To''. Any unrecognized input is interpreted as a header name. For |
| 21238 | example, typing @kbd{Message-ID} in response to this prompt will limit | 21238 | example, typing @kbd{Message-ID} in response to this prompt will limit |
| 21239 | the query to the Message-ID header. | 21239 | the query to the Message-ID header. |
| 21240 | 21240 | ||
| 21241 | Finally selecting ``Imap'' will interpret the query as a raw | 21241 | Finally selecting ``Imap'' will interpret the query as a raw |
| 21242 | @acronym{IMAP} search query. The format of such queries can be found in | 21242 | @acronym{IMAP} search query. The format of such queries can be found in |
| 21243 | RFC3501. | 21243 | RFC3501. |
| 21244 | 21244 | ||
| 21245 | If you don't like the default of searching whole messages you can | 21245 | If you don't like the default of searching whole messages you can |
| 21246 | customize @code{nnir-imap-default-search-key}. For example to use | 21246 | customize @code{nnir-imap-default-search-key}. For example to use |
| 21247 | @acronym{IMAP} queries by default | 21247 | @acronym{IMAP} queries by default |
| 21248 | 21248 | ||
| 21249 | @lisp | 21249 | @lisp |
| @@ -21273,14 +21273,14 @@ The search engine converts all text to utf-8, so searching should work | |||
| 21273 | in any language. | 21273 | in any language. |
| 21274 | 21274 | ||
| 21275 | @item Stopwords | 21275 | @item Stopwords |
| 21276 | Common English words (like 'the' and 'a') are ignored by default. You | 21276 | Common English words (like 'the' and 'a') are ignored by default. You |
| 21277 | can override this by prefixing such words with a + (e.g., +the) or | 21277 | can override this by prefixing such words with a + (e.g., +the) or |
| 21278 | enclosing the word in quotes (e.g., "the"). | 21278 | enclosing the word in quotes (e.g., "the"). |
| 21279 | 21279 | ||
| 21280 | @end table | 21280 | @end table |
| 21281 | 21281 | ||
| 21282 | The query can be limited to articles by a specific author using a | 21282 | The query can be limited to articles by a specific author using a |
| 21283 | prefix-arg. After inputting the query this will prompt for an author | 21283 | prefix-arg. After inputting the query this will prompt for an author |
| 21284 | name (or part of a name) to match. | 21284 | name (or part of a name) to match. |
| 21285 | 21285 | ||
| 21286 | @node The swish++ Engine | 21286 | @node The swish++ Engine |
| @@ -21294,15 +21294,15 @@ Documentation for swish++ may be found at the swish++ sourceforge page: | |||
| 21294 | @table @code | 21294 | @table @code |
| 21295 | 21295 | ||
| 21296 | @item nnir-swish++-program | 21296 | @item nnir-swish++-program |
| 21297 | The name of the swish++ executable. Defaults to @code{search} | 21297 | The name of the swish++ executable. Defaults to @code{search} |
| 21298 | 21298 | ||
| 21299 | @item nnir-swish++-additional-switches | 21299 | @item nnir-swish++-additional-switches |
| 21300 | A list of strings to be given as additional arguments to | 21300 | A list of strings to be given as additional arguments to |
| 21301 | swish++. @code{nil} by default. | 21301 | swish++. @code{nil} by default. |
| 21302 | 21302 | ||
| 21303 | @item nnir-swish++-remove-prefix | 21303 | @item nnir-swish++-remove-prefix |
| 21304 | The prefix to remove from each file name returned by swish++ in order | 21304 | The prefix to remove from each file name returned by swish++ in order |
| 21305 | to get a group name. By default this is @code{$HOME/Mail}. | 21305 | to get a group name. By default this is @code{$HOME/Mail}. |
| 21306 | 21306 | ||
| 21307 | @end table | 21307 | @end table |
| 21308 | 21308 | ||
| @@ -21317,15 +21317,15 @@ Documentation for swish-e may be found at the swish-e homepage | |||
| 21317 | @table @code | 21317 | @table @code |
| 21318 | 21318 | ||
| 21319 | @item nnir-swish-e-program | 21319 | @item nnir-swish-e-program |
| 21320 | The name of the swish-e search program. Defaults to @code{swish-e}. | 21320 | The name of the swish-e search program. Defaults to @code{swish-e}. |
| 21321 | 21321 | ||
| 21322 | @item nnir-swish-e-additional-switches | 21322 | @item nnir-swish-e-additional-switches |
| 21323 | A list of strings to be given as additional arguments to | 21323 | A list of strings to be given as additional arguments to |
| 21324 | swish-e. @code{nil} by default. | 21324 | swish-e. @code{nil} by default. |
| 21325 | 21325 | ||
| 21326 | @item nnir-swish-e-remove-prefix | 21326 | @item nnir-swish-e-remove-prefix |
| 21327 | The prefix to remove from each file name returned by swish-e in order | 21327 | The prefix to remove from each file name returned by swish-e in order |
| 21328 | to get a group name. By default this is @code{$HOME/Mail}. | 21328 | to get a group name. By default this is @code{$HOME/Mail}. |
| 21329 | 21329 | ||
| 21330 | @end table | 21330 | @end table |
| 21331 | 21331 | ||
| @@ -21338,7 +21338,7 @@ where to find them by setting the @code{nnir-namazu-index-directory} | |||
| 21338 | variable. | 21338 | variable. |
| 21339 | 21339 | ||
| 21340 | To work correctly the @code{nnir-namazu-remove-prefix} variable must | 21340 | To work correctly the @code{nnir-namazu-remove-prefix} variable must |
| 21341 | also be correct. This is the prefix to remove from each file name | 21341 | also be correct. This is the prefix to remove from each file name |
| 21342 | returned by Namazu in order to get a proper group name (albeit with `/' | 21342 | returned by Namazu in order to get a proper group name (albeit with `/' |
| 21343 | instead of `.'). | 21343 | instead of `.'). |
| 21344 | 21344 | ||
| @@ -21358,7 +21358,7 @@ output format. Good switches to use include `--sort', `--ascending', | |||
| 21358 | information on valid switches. | 21358 | information on valid switches. |
| 21359 | 21359 | ||
| 21360 | Mail must first be indexed with the `mknmz' program. Read the documentation | 21360 | Mail must first be indexed with the `mknmz' program. Read the documentation |
| 21361 | for namazu to create a configuration file. Here is an example: | 21361 | for namazu to create a configuration file. Here is an example: |
| 21362 | 21362 | ||
| 21363 | @cartouche | 21363 | @cartouche |
| 21364 | @example | 21364 | @example |
| @@ -21423,8 +21423,8 @@ This engine is obsolete. | |||
| 21423 | @table @code | 21423 | @table @code |
| 21424 | 21424 | ||
| 21425 | @item nnir-method-default-engines | 21425 | @item nnir-method-default-engines |
| 21426 | Alist of pairs of server backends and search engines. The default associations | 21426 | Alist of pairs of server backends and search engines. The default |
| 21427 | are | 21427 | associations are |
| 21428 | @example | 21428 | @example |
| 21429 | (nnimap . imap) | 21429 | (nnimap . imap) |
| 21430 | (nntp . gmane) | 21430 | (nntp . gmane) |
| @@ -21451,9 +21451,9 @@ If nil (the default) this will use @code{gnus-summary-line-format}. | |||
| 21451 | If non-nil, a function that retrieves article headers rather than using | 21451 | If non-nil, a function that retrieves article headers rather than using |
| 21452 | the gnus built-in function. This function takes an article list and | 21452 | the gnus built-in function. This function takes an article list and |
| 21453 | group as arguments and populates the `nntp-server-buffer' with the | 21453 | group as arguments and populates the `nntp-server-buffer' with the |
| 21454 | retrieved headers. It should then return either 'nov or 'headers | 21454 | retrieved headers. It should then return either 'nov or 'headers |
| 21455 | indicating the retrieved header format. Failure to retrieve headers | 21455 | indicating the retrieved header format. Failure to retrieve headers |
| 21456 | should return @code{nil} | 21456 | should return @code{nil}. |
| 21457 | 21457 | ||
| 21458 | If this variable is nil, or if the provided function returns nil for a | 21458 | If this variable is nil, or if the provided function returns nil for a |
| 21459 | search result, @code{gnus-retrieve-headers} will be called instead." | 21459 | search result, @code{gnus-retrieve-headers} will be called instead." |
| @@ -21881,104 +21881,104 @@ tips and tricks}). | |||
| 21881 | @subsection Propagating marks | 21881 | @subsection Propagating marks |
| 21882 | 21882 | ||
| 21883 | First of: you really need a patched mairix binary for using the marks | 21883 | First of: you really need a patched mairix binary for using the marks |
| 21884 | propagation feature efficiently. Otherwise, you would have to update | 21884 | propagation feature efficiently. Otherwise, you would have to update |
| 21885 | the mairix database all the time. You can get the patch at | 21885 | the mairix database all the time. You can get the patch at |
| 21886 | 21886 | ||
| 21887 | @uref{http://www.randomsample.de/mairix-maildir-patch.tar} | 21887 | @uref{http://www.randomsample.de/mairix-maildir-patch.tar} |
| 21888 | 21888 | ||
| 21889 | You need the mairix v0.21 source code for this patch; everything else | 21889 | You need the mairix v0.21 source code for this patch; everything else |
| 21890 | is explained in the accompanied readme file. If you don't want to use | 21890 | is explained in the accompanied readme file. If you don't want to use |
| 21891 | marks propagation, you don't have to apply these patches, but they also | 21891 | marks propagation, you don't have to apply these patches, but they also |
| 21892 | fix some annoyances regarding changing maildir flags, so it might still | 21892 | fix some annoyances regarding changing maildir flags, so it might still |
| 21893 | be useful to you. | 21893 | be useful to you. |
| 21894 | 21894 | ||
| 21895 | With the patched mairix binary, you can use @code{nnmairix} as an | 21895 | With the patched mairix binary, you can use @code{nnmairix} as an |
| 21896 | alternative to mail splitting (@pxref{Fancy Mail Splitting}). For | 21896 | alternative to mail splitting (@pxref{Fancy Mail Splitting}). For |
| 21897 | example, instead of splitting all mails from @samp{david@@foobar.com} | 21897 | example, instead of splitting all mails from @samp{david@@foobar.com} |
| 21898 | into a group, you can simply create a search group with the query | 21898 | into a group, you can simply create a search group with the query |
| 21899 | @samp{f:david@@foobar.com}. This is actually what ``smart folders'' are | 21899 | @samp{f:david@@foobar.com}. This is actually what ``smart folders'' are |
| 21900 | all about: simply put everything in one mail folder and dynamically | 21900 | all about: simply put everything in one mail folder and dynamically |
| 21901 | create searches instead of splitting. This is more flexible, since you | 21901 | create searches instead of splitting. This is more flexible, since you |
| 21902 | can dynamically change your folders any time you want to. This also | 21902 | can dynamically change your folders any time you want to. This also |
| 21903 | implies that you will usually read your mails in the @code{nnmairix} | 21903 | implies that you will usually read your mails in the @code{nnmairix} |
| 21904 | groups instead of your ``real'' mail groups. | 21904 | groups instead of your ``real'' mail groups. |
| 21905 | 21905 | ||
| 21906 | There is one problem, though: say you got a new mail from | 21906 | There is one problem, though: say you got a new mail from |
| 21907 | @samp{david@@foobar.com}; it will now show up in two groups, the | 21907 | @samp{david@@foobar.com}; it will now show up in two groups, the |
| 21908 | ``real'' group (your INBOX, for example) and in the @code{nnmairix} | 21908 | ``real'' group (your INBOX, for example) and in the @code{nnmairix} |
| 21909 | search group (provided you have updated the mairix database). Now you | 21909 | search group (provided you have updated the mairix database). Now you |
| 21910 | enter the @code{nnmairix} group and read the mail. The mail will be | 21910 | enter the @code{nnmairix} group and read the mail. The mail will be |
| 21911 | marked as read, but only in the @code{nnmairix} group---in the ``real'' | 21911 | marked as read, but only in the @code{nnmairix} group---in the ``real'' |
| 21912 | mail group it will be still shown as unread. | 21912 | mail group it will be still shown as unread. |
| 21913 | 21913 | ||
| 21914 | You could now catch up the mail group (@pxref{Group Data}), but this is | 21914 | You could now catch up the mail group (@pxref{Group Data}), but this is |
| 21915 | tedious and error prone, since you may overlook mails you don't have | 21915 | tedious and error prone, since you may overlook mails you don't have |
| 21916 | created @code{nnmairix} groups for. Of course, you could first use | 21916 | created @code{nnmairix} groups for. Of course, you could first use |
| 21917 | @code{nnmairix-goto-original-article} (@pxref{nnmairix keyboard | 21917 | @code{nnmairix-goto-original-article} (@pxref{nnmairix keyboard |
| 21918 | shortcuts}) and then read the mail in the original group, but that's | 21918 | shortcuts}) and then read the mail in the original group, but that's |
| 21919 | even more cumbersome. | 21919 | even more cumbersome. |
| 21920 | 21920 | ||
| 21921 | Clearly, the easiest way would be if marks could somehow be | 21921 | Clearly, the easiest way would be if marks could somehow be |
| 21922 | automatically set for the original article. This is exactly what | 21922 | automatically set for the original article. This is exactly what |
| 21923 | @emph{marks propagation} is about. | 21923 | @emph{marks propagation} is about. |
| 21924 | 21924 | ||
| 21925 | Marks propagation is inactive by default. You can activate it for a | 21925 | Marks propagation is inactive by default. You can activate it for a |
| 21926 | certain @code{nnmairix} group with | 21926 | certain @code{nnmairix} group with |
| 21927 | @code{nnmairix-group-toggle-propmarks-this-group} (bound to @kbd{G b | 21927 | @code{nnmairix-group-toggle-propmarks-this-group} (bound to @kbd{G b |
| 21928 | p}). This function will warn you if you try to use it with your default | 21928 | p}). This function will warn you if you try to use it with your default |
| 21929 | search group; the reason is that the default search group is used for | 21929 | search group; the reason is that the default search group is used for |
| 21930 | temporary searches, and it's easy to accidentally propagate marks from | 21930 | temporary searches, and it's easy to accidentally propagate marks from |
| 21931 | this group. However, you can ignore this warning if you really want to. | 21931 | this group. However, you can ignore this warning if you really want to. |
| 21932 | 21932 | ||
| 21933 | With marks propagation enabled, all the marks you set in a @code{nnmairix} | 21933 | With marks propagation enabled, all the marks you set in a @code{nnmairix} |
| 21934 | group should now be propagated to the original article. For example, | 21934 | group should now be propagated to the original article. For example, |
| 21935 | you can now tick an article (by default with @kbd{!}) and this mark should | 21935 | you can now tick an article (by default with @kbd{!}) and this mark should |
| 21936 | magically be set for the original article, too. | 21936 | magically be set for the original article, too. |
| 21937 | 21937 | ||
| 21938 | A few more remarks which you may or may not want to know: | 21938 | A few more remarks which you may or may not want to know: |
| 21939 | 21939 | ||
| 21940 | @vindex nnmairix-propagate-marks-upon-close | 21940 | @vindex nnmairix-propagate-marks-upon-close |
| 21941 | Marks will not be set immediately, but only upon closing a group. This | 21941 | Marks will not be set immediately, but only upon closing a group. This |
| 21942 | not only makes marks propagation faster, it also avoids problems with | 21942 | not only makes marks propagation faster, it also avoids problems with |
| 21943 | dangling symlinks when dealing with maildir files (since changing flags | 21943 | dangling symlinks when dealing with maildir files (since changing flags |
| 21944 | will change the file name). You can also control when to propagate marks | 21944 | will change the file name). You can also control when to propagate marks |
| 21945 | via @code{nnmairix-propagate-marks-upon-close} (see the doc-string for | 21945 | via @code{nnmairix-propagate-marks-upon-close} (see the doc-string for |
| 21946 | details). | 21946 | details). |
| 21947 | 21947 | ||
| 21948 | Obviously, @code{nnmairix} will have to look up the original group for every | 21948 | Obviously, @code{nnmairix} will have to look up the original group for every |
| 21949 | article you want to set marks for. If available, @code{nnmairix} will first use | 21949 | article you want to set marks for. If available, @code{nnmairix} will first |
| 21950 | the registry for determining the original group. The registry is very | 21950 | use the registry for determining the original group. The registry is very |
| 21951 | fast, hence you should really, really enable the registry when using | 21951 | fast, hence you should really, really enable the registry when using |
| 21952 | marks propagation. If you don't have to worry about RAM and disc space, | 21952 | marks propagation. If you don't have to worry about RAM and disc space, |
| 21953 | set @code{gnus-registry-max-entries} to a large enough value; to be on | 21953 | set @code{gnus-registry-max-entries} to a large enough value; to be on |
| 21954 | the safe side, choose roughly the amount of mails you index with mairix. | 21954 | the safe side, choose roughly the amount of mails you index with mairix. |
| 21955 | 21955 | ||
| 21956 | @vindex nnmairix-only-use-registry | 21956 | @vindex nnmairix-only-use-registry |
| 21957 | If you don't want to use the registry or the registry hasn't seen the | 21957 | If you don't want to use the registry or the registry hasn't seen the |
| 21958 | original article yet, @code{nnmairix} will use an additional mairix | 21958 | original article yet, @code{nnmairix} will use an additional mairix |
| 21959 | search for determining the file name of the article. This, of course, is | 21959 | search for determining the file name of the article. This, of course, is |
| 21960 | way slower than the registry---if you set hundreds or even thousands of | 21960 | way slower than the registry---if you set hundreds or even thousands of |
| 21961 | marks this way, it might take some time. You can avoid this situation by | 21961 | marks this way, it might take some time. You can avoid this situation by |
| 21962 | setting @code{nnmairix-only-use-registry} to t. | 21962 | setting @code{nnmairix-only-use-registry} to t. |
| 21963 | 21963 | ||
| 21964 | Maybe you also want to propagate marks the other way round, i.e., if you | 21964 | Maybe you also want to propagate marks the other way round, i.e., if you |
| 21965 | tick an article in a "real" mail group, you'd like to have the same | 21965 | tick an article in a "real" mail group, you'd like to have the same |
| 21966 | article in a @code{nnmairix} group ticked, too. For several good | 21966 | article in a @code{nnmairix} group ticked, too. For several good |
| 21967 | reasons, this can only be done efficiently if you use maildir. To | 21967 | reasons, this can only be done efficiently if you use maildir. To |
| 21968 | immediately contradict myself, let me mention that it WON'T work with | 21968 | immediately contradict myself, let me mention that it WON'T work with |
| 21969 | @code{nnmaildir}, since @code{nnmaildir} stores the marks externally and | 21969 | @code{nnmaildir}, since @code{nnmaildir} stores the marks externally and |
| 21970 | not in the file name. Therefore, propagating marks to @code{nnmairix} | 21970 | not in the file name. Therefore, propagating marks to @code{nnmairix} |
| 21971 | groups will usually only work if you use an IMAP server which uses | 21971 | groups will usually only work if you use an IMAP server which uses |
| 21972 | maildir as its file format. | 21972 | maildir as its file format. |
| 21973 | 21973 | ||
| 21974 | @vindex nnmairix-propagate-marks-to-nnmairix-groups | 21974 | @vindex nnmairix-propagate-marks-to-nnmairix-groups |
| 21975 | If you work with this setup, just set | 21975 | If you work with this setup, just set |
| 21976 | @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t} and see what | 21976 | @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t} and see what |
| 21977 | happens. If you don't like what you see, just set it to @code{nil} again. One | 21977 | happens. If you don't like what you see, just set it to @code{nil} again. |
| 21978 | problem might be that you get a wrong number of unread articles; this | 21978 | One problem might be that you get a wrong number of unread articles; this |
| 21979 | usually happens when you delete or expire articles in the original | 21979 | usually happens when you delete or expire articles in the original |
| 21980 | groups. When this happens, you can recreate the @code{nnmairix} group on the | 21980 | groups. When this happens, you can recreate the @code{nnmairix} group on |
| 21981 | back end using @kbd{G b d}. | 21981 | the back end using @kbd{G b d}. |
| 21982 | 21982 | ||
| 21983 | @node nnmairix tips and tricks | 21983 | @node nnmairix tips and tricks |
| 21984 | @subsection nnmairix tips and tricks | 21984 | @subsection nnmairix tips and tricks |
| @@ -21988,7 +21988,7 @@ back end using @kbd{G b d}. | |||
| 21988 | Checking Mail | 21988 | Checking Mail |
| 21989 | 21989 | ||
| 21990 | @findex nnmairix-update-groups | 21990 | @findex nnmairix-update-groups |
| 21991 | I put all my important mail groups at group level 1. The mairix groups | 21991 | I put all my important mail groups at group level 1. The mairix groups |
| 21992 | have group level 5, so they do not get checked at start up (@pxref{Group | 21992 | have group level 5, so they do not get checked at start up (@pxref{Group |
| 21993 | Levels}). | 21993 | Levels}). |
| 21994 | 21994 | ||
| @@ -22006,7 +22006,7 @@ I use the following to check for mails: | |||
| 22006 | @end lisp | 22006 | @end lisp |
| 22007 | 22007 | ||
| 22008 | Instead of @samp{"mairixsearch"} use the name of your @code{nnmairix} | 22008 | Instead of @samp{"mairixsearch"} use the name of your @code{nnmairix} |
| 22009 | server. See the doc string for @code{nnmairix-update-groups} for | 22009 | server. See the doc string for @code{nnmairix-update-groups} for |
| 22010 | details. | 22010 | details. |
| 22011 | 22011 | ||
| 22012 | @item | 22012 | @item |
| @@ -22018,13 +22018,13 @@ articles always stay unread: | |||
| 22018 | Hit @kbd{G b g}, enter group name (e.g., @samp{important}), use | 22018 | Hit @kbd{G b g}, enter group name (e.g., @samp{important}), use |
| 22019 | @samp{F:f} as query and do not include threads. | 22019 | @samp{F:f} as query and do not include threads. |
| 22020 | 22020 | ||
| 22021 | Now activate marks propagation for this group by using @kbd{G b p}. Then | 22021 | Now activate marks propagation for this group by using @kbd{G b p}. Then |
| 22022 | activate the always-unread feature by using @kbd{G b r} twice. | 22022 | activate the always-unread feature by using @kbd{G b r} twice. |
| 22023 | 22023 | ||
| 22024 | So far so good---but how do you remove the tick marks in the @code{nnmairix} | 22024 | So far so good---but how do you remove the tick marks in the @code{nnmairix} |
| 22025 | group? There are two options: You may simply use | 22025 | group? There are two options: You may simply use |
| 22026 | @code{nnmairix-remove-tick-mark-original-article} (bound to @kbd{$ u}) to remove | 22026 | @code{nnmairix-remove-tick-mark-original-article} (bound to @kbd{$ u}) to remove |
| 22027 | tick marks from the original article. The other possibility is to set | 22027 | tick marks from the original article. The other possibility is to set |
| 22028 | @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t}, but see the above | 22028 | @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t}, but see the above |
| 22029 | comments about this option. If it works for you, the tick marks should | 22029 | comments about this option. If it works for you, the tick marks should |
| 22030 | also exist in the @code{nnmairix} group and you can remove them as usual, | 22030 | also exist in the @code{nnmairix} group and you can remove them as usual, |
| @@ -22033,19 +22033,19 @@ e.g., by marking an article as read. | |||
| 22033 | When you have removed a tick mark from the original article, this | 22033 | When you have removed a tick mark from the original article, this |
| 22034 | article should vanish from the @code{nnmairix} group after you have updated the | 22034 | article should vanish from the @code{nnmairix} group after you have updated the |
| 22035 | mairix database and updated the group. Fortunately, there is a function | 22035 | mairix database and updated the group. Fortunately, there is a function |
| 22036 | for doing exactly that: @code{nnmairix-update-groups}. See the previous code | 22036 | for doing exactly that: @code{nnmairix-update-groups}. See the previous code |
| 22037 | snippet and the doc string for details. | 22037 | snippet and the doc string for details. |
| 22038 | 22038 | ||
| 22039 | @item | 22039 | @item |
| 22040 | Dealing with auto-subscription of mail groups | 22040 | Dealing with auto-subscription of mail groups |
| 22041 | 22041 | ||
| 22042 | As described before, all @code{nnmairix} groups are in fact stored on | 22042 | As described before, all @code{nnmairix} groups are in fact stored on |
| 22043 | the mail back end in the form @samp{zz_mairix-<NAME>-<NUMBER>}. You can | 22043 | the mail back end in the form @samp{zz_mairix-<NAME>-<NUMBER>}. You can |
| 22044 | see them when you enter the back end server in the server buffer. You | 22044 | see them when you enter the back end server in the server buffer. You |
| 22045 | should not subscribe these groups! Unfortunately, these groups will | 22045 | should not subscribe these groups! Unfortunately, these groups will |
| 22046 | usually get @emph{auto-subscribed} when you use @code{nnmaildir} or | 22046 | usually get @emph{auto-subscribed} when you use @code{nnmaildir} or |
| 22047 | @code{nnml}, i.e., you will suddenly see groups of the form | 22047 | @code{nnml}, i.e., you will suddenly see groups of the form |
| 22048 | @samp{zz_mairix*} pop up in your group buffer. If this happens to you, | 22048 | @samp{zz_mairix*} pop up in your group buffer. If this happens to you, |
| 22049 | simply kill these groups with C-k. For avoiding this, turn off | 22049 | simply kill these groups with C-k. For avoiding this, turn off |
| 22050 | auto-subscription completely by setting the variable | 22050 | auto-subscription completely by setting the variable |
| 22051 | @code{gnus-auto-subscribed-groups} to @code{nil} (@pxref{Filtering New | 22051 | @code{gnus-auto-subscribed-groups} to @code{nil} (@pxref{Filtering New |
| @@ -22103,25 +22103,25 @@ mairix does only support us-ascii characters. | |||
| 22103 | @code{nnmairix} uses a rather brute force method to force Gnus to | 22103 | @code{nnmairix} uses a rather brute force method to force Gnus to |
| 22104 | completely reread the group on the mail back end after mairix was | 22104 | completely reread the group on the mail back end after mairix was |
| 22105 | called---it simply deletes and re-creates the group on the mail | 22105 | called---it simply deletes and re-creates the group on the mail |
| 22106 | back end. So far, this has worked for me without any problems, and I | 22106 | back end. So far, this has worked for me without any problems, and I |
| 22107 | don't see how @code{nnmairix} could delete other mail groups than its | 22107 | don't see how @code{nnmairix} could delete other mail groups than its |
| 22108 | own, but anyway: you really should have a backup of your mail | 22108 | own, but anyway: you really should have a backup of your mail |
| 22109 | folders. | 22109 | folders. |
| 22110 | 22110 | ||
| 22111 | @item | 22111 | @item |
| 22112 | All necessary information is stored in the group parameters | 22112 | All necessary information is stored in the group parameters |
| 22113 | (@pxref{Group Parameters}). This has the advantage that no active file | 22113 | (@pxref{Group Parameters}). This has the advantage that no active file |
| 22114 | is needed, but also implies that when you kill a @code{nnmairix} group, | 22114 | is needed, but also implies that when you kill a @code{nnmairix} group, |
| 22115 | it is gone for good. | 22115 | it is gone for good. |
| 22116 | 22116 | ||
| 22117 | @item | 22117 | @item |
| 22118 | @findex nnmairix-purge-old-groups | 22118 | @findex nnmairix-purge-old-groups |
| 22119 | If you create and kill a lot of @code{nnmairix} groups, the | 22119 | If you create and kill a lot of @code{nnmairix} groups, the |
| 22120 | ``zz_mairix-*'' groups will accumulate on the mail back end server. To | 22120 | ``zz_mairix-*'' groups will accumulate on the mail back end server. To |
| 22121 | delete old groups which are no longer needed, call | 22121 | delete old groups which are no longer needed, call |
| 22122 | @code{nnmairix-purge-old-groups}. Note that this assumes that you don't | 22122 | @code{nnmairix-purge-old-groups}. Note that this assumes that you don't |
| 22123 | save any ``real'' mail in folders of the form | 22123 | save any ``real'' mail in folders of the form |
| 22124 | @code{zz_mairix-<NAME>-<NUMBER>}. You can change the prefix of | 22124 | @code{zz_mairix-<NAME>-<NUMBER>}. You can change the prefix of |
| 22125 | @code{nnmairix} groups by changing the variable | 22125 | @code{nnmairix} groups by changing the variable |
| 22126 | @code{nnmairix-group-prefix}. | 22126 | @code{nnmairix-group-prefix}. |
| 22127 | 22127 | ||
| @@ -22132,14 +22132,14 @@ for mairix (@pxref{Propagating marks}): | |||
| 22132 | A problem can occur when using @code{nnmairix} with maildir folders and | 22132 | A problem can occur when using @code{nnmairix} with maildir folders and |
| 22133 | comes with the fact that maildir stores mail flags like @samp{Seen} or | 22133 | comes with the fact that maildir stores mail flags like @samp{Seen} or |
| 22134 | @samp{Replied} by appending chars @samp{S} and @samp{R} to the message | 22134 | @samp{Replied} by appending chars @samp{S} and @samp{R} to the message |
| 22135 | file name, respectively. This implies that currently you would have to | 22135 | file name, respectively. This implies that currently you would have to |
| 22136 | update the mairix database not only when new mail arrives, but also when | 22136 | update the mairix database not only when new mail arrives, but also when |
| 22137 | mail flags are changing. The same applies to new mails which are indexed | 22137 | mail flags are changing. The same applies to new mails which are indexed |
| 22138 | while they are still in the @samp{new} folder but then get moved to | 22138 | while they are still in the @samp{new} folder but then get moved to |
| 22139 | @samp{cur} when Gnus has seen the mail. If you don't update the database | 22139 | @samp{cur} when Gnus has seen the mail. If you don't update the database |
| 22140 | after this has happened, a mairix query can lead to symlinks pointing to | 22140 | after this has happened, a mairix query can lead to symlinks pointing to |
| 22141 | non-existing files. In Gnus, these messages will usually appear with | 22141 | non-existing files. In Gnus, these messages will usually appear with |
| 22142 | ``(none)'' entries in the header and can't be accessed. If this happens | 22142 | ``(none)'' entries in the header and can't be accessed. If this happens |
| 22143 | to you, using @kbd{G b u} and updating the group will usually fix this. | 22143 | to you, using @kbd{G b u} and updating the group will usually fix this. |
| 22144 | 22144 | ||
| 22145 | @end itemize | 22145 | @end itemize |
| @@ -23479,7 +23479,7 @@ Using the last function would be something like this: | |||
| 23479 | @c #### FIXME: faces and x-faces' implementations should really be harmonized. | 23479 | @c #### FIXME: faces and x-faces' implementations should really be harmonized. |
| 23480 | 23480 | ||
| 23481 | @code{Face} headers are essentially a funkier version of @code{X-Face} | 23481 | @code{Face} headers are essentially a funkier version of @code{X-Face} |
| 23482 | ones. They describe a 48x48 pixel colored image that's supposed to | 23482 | ones. They describe a 48x48 pixel colored image that's supposed to |
| 23483 | represent the author of the message. | 23483 | represent the author of the message. |
| 23484 | 23484 | ||
| 23485 | @cindex face | 23485 | @cindex face |
| @@ -23511,7 +23511,7 @@ easier insertion of Face headers in outgoing messages. | |||
| 23511 | converts the file to Face format by using the | 23511 | converts the file to Face format by using the |
| 23512 | @code{gnus-convert-image-to-face-command} shell command. | 23512 | @code{gnus-convert-image-to-face-command} shell command. |
| 23513 | 23513 | ||
| 23514 | Here's how you would typically use this function. Put something like the | 23514 | Here's how you would typically use this function. Put something like the |
| 23515 | following in your @file{~/.gnus.el} file: | 23515 | following in your @file{~/.gnus.el} file: |
| 23516 | 23516 | ||
| 23517 | @lisp | 23517 | @lisp |
| @@ -23690,7 +23690,7 @@ The following variables offer control over how things are displayed. | |||
| 23690 | 23690 | ||
| 23691 | @item gnus-gravatar-size | 23691 | @item gnus-gravatar-size |
| 23692 | @vindex gnus-gravatar-size | 23692 | @vindex gnus-gravatar-size |
| 23693 | The size in pixels of gravatars. Gravatars are always square, so one | 23693 | The size in pixels of gravatars. Gravatars are always square, so one |
| 23694 | number for the size is enough. | 23694 | number for the size is enough. |
| 23695 | 23695 | ||
| 23696 | @item gnus-gravatar-properties | 23696 | @item gnus-gravatar-properties |
| @@ -27874,7 +27874,7 @@ The estimated number of unread articles in the group buffer should now | |||
| 27874 | be correct for nnimap groups. This is achieved by calling | 27874 | be correct for nnimap groups. This is achieved by calling |
| 27875 | @code{nnimap-fixup-unread-after-getting-new-news} from the | 27875 | @code{nnimap-fixup-unread-after-getting-new-news} from the |
| 27876 | @code{gnus-setup-news-hook} (called on startup) and | 27876 | @code{gnus-setup-news-hook} (called on startup) and |
| 27877 | @code{gnus-after-getting-new-news-hook}. (called after getting new | 27877 | @code{gnus-after-getting-new-news-hook} (called after getting new |
| 27878 | mail). If you have modified those variables from the default, you may | 27878 | mail). If you have modified those variables from the default, you may |
| 27879 | want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If | 27879 | want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If |
| 27880 | you were happy with the estimate and want to save some (minimal) time | 27880 | you were happy with the estimate and want to save some (minimal) time |
| @@ -28760,7 +28760,7 @@ specified by RFC 1153. | |||
| 28760 | @cindex splitting, terminology | 28760 | @cindex splitting, terminology |
| 28761 | @cindex mail sorting | 28761 | @cindex mail sorting |
| 28762 | @cindex mail filtering (splitting) | 28762 | @cindex mail filtering (splitting) |
| 28763 | The action of sorting your emails according to certain rules. Sometimes | 28763 | The action of sorting your emails according to certain rules. Sometimes |
| 28764 | incorrectly called mail filtering. | 28764 | incorrectly called mail filtering. |
| 28765 | 28765 | ||
| 28766 | @end table | 28766 | @end table |
diff --git a/doc/misc/sem-user.texi b/doc/misc/sem-user.texi index 0a0239b97b3..e2f7ea51303 100644 --- a/doc/misc/sem-user.texi +++ b/doc/misc/sem-user.texi | |||
| @@ -1303,7 +1303,7 @@ You can create new types of decorations using the following function: | |||
| 1303 | Define a new decoration style with @var{name}. | 1303 | Define a new decoration style with @var{name}. |
| 1304 | @var{doc} is a documentation string describing the decoration style @var{name}. | 1304 | @var{doc} is a documentation string describing the decoration style @var{name}. |
| 1305 | It is appended to auto-generated doc strings. | 1305 | It is appended to auto-generated doc strings. |
| 1306 | An Optional list of @var{flags} can also be specified. Flags are: | 1306 | An optional list of @var{flags} can also be specified. Flags are: |
| 1307 | @code{:enabled} <value> - specify the default enabled value for @var{name}. | 1307 | @code{:enabled} <value> - specify the default enabled value for @var{name}. |
| 1308 | 1308 | ||
| 1309 | 1309 | ||
diff --git a/doc/misc/semantic.texi b/doc/misc/semantic.texi index 6e39d410223..f9ccd034fe6 100644 --- a/doc/misc/semantic.texi +++ b/doc/misc/semantic.texi | |||
| @@ -227,12 +227,12 @@ grammar developers; it is useful mostly for the hackers who would like | |||
| 227 | to learn more about how @semantic{} works. | 227 | to learn more about how @semantic{} works. |
| 228 | 228 | ||
| 229 | @menu | 229 | @menu |
| 230 | * Parser code :: Code used for the parsers | 230 | * Parser code:: Code used for the parsers |
| 231 | * Tag handling :: Code used for manipulating tags | 231 | * Tag handling:: Code used for manipulating tags |
| 232 | * Semanticdb Internals :: Code used in the semantic database | 232 | * Semanticdb Internals:: Code used in the semantic database |
| 233 | * Analyzer Internals :: Code used in the code analyzer | 233 | * Analyzer Internals:: Code used in the code analyzer |
| 234 | * Tools :: Code used in user tools | 234 | * Tools:: Code used in user tools |
| 235 | * Tests :: Code used for testing | 235 | * Tests:: Code used for testing |
| 236 | @end menu | 236 | @end menu |
| 237 | 237 | ||
| 238 | @node Parser code | 238 | @node Parser code |