diff options
| author | Eric Abrahamsen | 2021-03-13 14:25:47 -0800 |
|---|---|---|
| committer | Eric Abrahamsen | 2021-04-13 08:45:07 -0700 |
| commit | 17ff8c3e5a9dec2640ca95d295110c81ebb59a2c (patch) | |
| tree | 1e987ecff578c4d12362a590bf6ba95bc401ac7d /doc | |
| parent | 1db460784e90b7c78c5d541640a4d520f9b406b1 (diff) | |
| download | emacs-17ff8c3e5a9dec2640ca95d295110c81ebb59a2c.tar.gz emacs-17ff8c3e5a9dec2640ca95d295110c81ebb59a2c.zip | |
Improvements to message-syntax-checks docs and options
* doc/misc/message.texi: Move the manual entry from the "News Headers"
section to the "Message Headers" section, as it is generally
applicable, not just to News.
* lisp/gnus/message.el (message-syntax-checks): Add an explicit alist
type specifying the valid options; point to the manual for more
information.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/message.texi | 163 |
1 files changed, 81 insertions, 82 deletions
diff --git a/doc/misc/message.texi b/doc/misc/message.texi index 1497c710e4e..d2353e6cec6 100644 --- a/doc/misc/message.texi +++ b/doc/misc/message.texi | |||
| @@ -1792,8 +1792,89 @@ member list with elements @code{CC} and @code{To}, then | |||
| 1792 | @code{message-carefully-insert-headers} will not insert a @code{To} | 1792 | @code{message-carefully-insert-headers} will not insert a @code{To} |
| 1793 | header when the message is already @code{CC}ed to the recipient. | 1793 | header when the message is already @code{CC}ed to the recipient. |
| 1794 | 1794 | ||
| 1795 | @item message-syntax-checks | ||
| 1796 | @vindex message-syntax-checks | ||
| 1797 | Controls what syntax checks should not be performed on outgoing posts. | ||
| 1798 | To disable checking of long signatures, for instance, add | ||
| 1799 | |||
| 1800 | @lisp | ||
| 1801 | (signature . disabled) | ||
| 1802 | @end lisp | ||
| 1803 | |||
| 1804 | to this list. | ||
| 1805 | |||
| 1806 | Valid checks are: | ||
| 1807 | |||
| 1808 | @table @code | ||
| 1809 | @item approved | ||
| 1810 | @cindex approved | ||
| 1811 | Check whether the article has an @code{Approved} header, which is | ||
| 1812 | something only moderators should include. | ||
| 1813 | @item continuation-headers | ||
| 1814 | Check whether there are continuation header lines that don't begin with | ||
| 1815 | whitespace. | ||
| 1816 | @item control-chars | ||
| 1817 | Check for invalid characters. | ||
| 1818 | @item empty | ||
| 1819 | Check whether the article is empty. | ||
| 1820 | @item existing-newsgroups | ||
| 1821 | Check whether the newsgroups mentioned in the @code{Newsgroups} and | ||
| 1822 | @code{Followup-To} headers exist. | ||
| 1823 | @item from | ||
| 1824 | Check whether the @code{From} header seems nice. | ||
| 1825 | @item illegible-text | ||
| 1826 | Check whether there is any non-printable character in the body. | ||
| 1827 | @item invisible-text | ||
| 1828 | Check whether there is any invisible text in the buffer. | ||
| 1829 | @item long-header-lines | ||
| 1830 | Check for too long header lines. | ||
| 1831 | @item long-lines | ||
| 1832 | @cindex long lines | ||
| 1833 | Check for too long lines in the body. | ||
| 1834 | @item message-id | ||
| 1835 | Check whether the @code{Message-ID} looks syntactically ok. | ||
| 1836 | @item multiple-headers | ||
| 1837 | Check for the existence of multiple equal headers. | ||
| 1838 | @item new-text | ||
| 1839 | Check whether there is any new text in the messages. | ||
| 1840 | @item newsgroups | ||
| 1841 | Check whether the @code{Newsgroups} header exists and is not empty. | ||
| 1842 | @item quoting-style | ||
| 1843 | Check whether text follows last quoted portion. | ||
| 1844 | @item repeated-newsgroups | ||
| 1845 | Check whether the @code{Newsgroups} and @code{Followup-To} headers | ||
| 1846 | contains repeated group names. | ||
| 1847 | @item reply-to | ||
| 1848 | Check whether the @code{Reply-To} header looks ok. | ||
| 1849 | @item sender | ||
| 1850 | @cindex Sender | ||
| 1851 | Insert a new @code{Sender} header if the @code{From} header looks odd. | ||
| 1852 | @item sendsys | ||
| 1853 | @cindex sendsys | ||
| 1854 | Check for the existence of version and sendsys commands. | ||
| 1855 | @item shoot | ||
| 1856 | Check whether the domain part of the @code{Message-ID} header looks ok. | ||
| 1857 | @item shorten-followup-to | ||
| 1858 | Check whether to add a @code{Followup-To} header to shorten the number | ||
| 1859 | of groups to post to. | ||
| 1860 | @item signature | ||
| 1861 | Check the length of the signature. | ||
| 1862 | @item size | ||
| 1863 | Check for excessive size. | ||
| 1864 | @item subject | ||
| 1865 | Check whether the @code{Subject} header exists and is not empty. | ||
| 1866 | @item subject-cmsg | ||
| 1867 | Check the subject for commands. | ||
| 1868 | @item valid-newsgroups | ||
| 1869 | Check whether the @code{Newsgroups} and @code{Followup-To} headers | ||
| 1870 | are valid syntactically. | ||
| 1795 | @end table | 1871 | @end table |
| 1796 | 1872 | ||
| 1873 | All these conditions are checked by default, except for @code{sender} | ||
| 1874 | for which the check is disabled by default if | ||
| 1875 | @code{message-insert-canlock} is non-@code{nil} (@pxref{Canceling News}). | ||
| 1876 | |||
| 1877 | @end table | ||
| 1797 | 1878 | ||
| 1798 | @node Mail Headers | 1879 | @node Mail Headers |
| 1799 | @section Mail Headers | 1880 | @section Mail Headers |
| @@ -2072,88 +2153,6 @@ Other variables for customizing outgoing news articles: | |||
| 2072 | 2153 | ||
| 2073 | @table @code | 2154 | @table @code |
| 2074 | 2155 | ||
| 2075 | @item message-syntax-checks | ||
| 2076 | @vindex message-syntax-checks | ||
| 2077 | Controls what syntax checks should not be performed on outgoing posts. | ||
| 2078 | To disable checking of long signatures, for instance, add | ||
| 2079 | |||
| 2080 | @lisp | ||
| 2081 | (signature . disabled) | ||
| 2082 | @end lisp | ||
| 2083 | |||
| 2084 | to this list. | ||
| 2085 | |||
| 2086 | Valid checks are: | ||
| 2087 | |||
| 2088 | @table @code | ||
| 2089 | @item approved | ||
| 2090 | @cindex approved | ||
| 2091 | Check whether the article has an @code{Approved} header, which is | ||
| 2092 | something only moderators should include. | ||
| 2093 | @item continuation-headers | ||
| 2094 | Check whether there are continuation header lines that don't begin with | ||
| 2095 | whitespace. | ||
| 2096 | @item control-chars | ||
| 2097 | Check for invalid characters. | ||
| 2098 | @item empty | ||
| 2099 | Check whether the article is empty. | ||
| 2100 | @item existing-newsgroups | ||
| 2101 | Check whether the newsgroups mentioned in the @code{Newsgroups} and | ||
| 2102 | @code{Followup-To} headers exist. | ||
| 2103 | @item from | ||
| 2104 | Check whether the @code{From} header seems nice. | ||
| 2105 | @item illegible-text | ||
| 2106 | Check whether there is any non-printable character in the body. | ||
| 2107 | @item invisible-text | ||
| 2108 | Check whether there is any invisible text in the buffer. | ||
| 2109 | @item long-header-lines | ||
| 2110 | Check for too long header lines. | ||
| 2111 | @item long-lines | ||
| 2112 | @cindex long lines | ||
| 2113 | Check for too long lines in the body. | ||
| 2114 | @item message-id | ||
| 2115 | Check whether the @code{Message-ID} looks syntactically ok. | ||
| 2116 | @item multiple-headers | ||
| 2117 | Check for the existence of multiple equal headers. | ||
| 2118 | @item new-text | ||
| 2119 | Check whether there is any new text in the messages. | ||
| 2120 | @item newsgroups | ||
| 2121 | Check whether the @code{Newsgroups} header exists and is not empty. | ||
| 2122 | @item quoting-style | ||
| 2123 | Check whether text follows last quoted portion. | ||
| 2124 | @item repeated-newsgroups | ||
| 2125 | Check whether the @code{Newsgroups} and @code{Followup-To} headers | ||
| 2126 | contains repeated group names. | ||
| 2127 | @item reply-to | ||
| 2128 | Check whether the @code{Reply-To} header looks ok. | ||
| 2129 | @item sender | ||
| 2130 | @cindex Sender | ||
| 2131 | Insert a new @code{Sender} header if the @code{From} header looks odd. | ||
| 2132 | @item sendsys | ||
| 2133 | @cindex sendsys | ||
| 2134 | Check for the existence of version and sendsys commands. | ||
| 2135 | @item shoot | ||
| 2136 | Check whether the domain part of the @code{Message-ID} header looks ok. | ||
| 2137 | @item shorten-followup-to | ||
| 2138 | Check whether to add a @code{Followup-To} header to shorten the number | ||
| 2139 | of groups to post to. | ||
| 2140 | @item signature | ||
| 2141 | Check the length of the signature. | ||
| 2142 | @item size | ||
| 2143 | Check for excessive size. | ||
| 2144 | @item subject | ||
| 2145 | Check whether the @code{Subject} header exists and is not empty. | ||
| 2146 | @item subject-cmsg | ||
| 2147 | Check the subject for commands. | ||
| 2148 | @item valid-newsgroups | ||
| 2149 | Check whether the @code{Newsgroups} and @code{Followup-To} headers | ||
| 2150 | are valid syntactically. | ||
| 2151 | @end table | ||
| 2152 | |||
| 2153 | All these conditions are checked by default, except for @code{sender} | ||
| 2154 | for which the check is disabled by default if | ||
| 2155 | @code{message-insert-canlock} is non-@code{nil} (@pxref{Canceling News}). | ||
| 2156 | |||
| 2157 | @item message-ignored-news-headers | 2156 | @item message-ignored-news-headers |
| 2158 | @vindex message-ignored-news-headers | 2157 | @vindex message-ignored-news-headers |
| 2159 | Regexp of headers to be removed before posting. The default is@* | 2158 | Regexp of headers to be removed before posting. The default is@* |