aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEric Abrahamsen2021-03-13 14:25:47 -0800
committerEric Abrahamsen2021-04-13 08:45:07 -0700
commit17ff8c3e5a9dec2640ca95d295110c81ebb59a2c (patch)
tree1e987ecff578c4d12362a590bf6ba95bc401ac7d
parent1db460784e90b7c78c5d541640a4d520f9b406b1 (diff)
downloademacs-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.
-rw-r--r--doc/misc/message.texi163
-rw-r--r--lisp/gnus/message.el24
2 files changed, 95 insertions, 92 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}
1793header when the message is already @code{CC}ed to the recipient. 1793header when the message is already @code{CC}ed to the recipient.
1794 1794
1795@item message-syntax-checks
1796@vindex message-syntax-checks
1797Controls what syntax checks should not be performed on outgoing posts.
1798To disable checking of long signatures, for instance, add
1799
1800@lisp
1801(signature . disabled)
1802@end lisp
1803
1804to this list.
1805
1806Valid checks are:
1807
1808@table @code
1809@item approved
1810@cindex approved
1811Check whether the article has an @code{Approved} header, which is
1812something only moderators should include.
1813@item continuation-headers
1814Check whether there are continuation header lines that don't begin with
1815whitespace.
1816@item control-chars
1817Check for invalid characters.
1818@item empty
1819Check whether the article is empty.
1820@item existing-newsgroups
1821Check whether the newsgroups mentioned in the @code{Newsgroups} and
1822@code{Followup-To} headers exist.
1823@item from
1824Check whether the @code{From} header seems nice.
1825@item illegible-text
1826Check whether there is any non-printable character in the body.
1827@item invisible-text
1828Check whether there is any invisible text in the buffer.
1829@item long-header-lines
1830Check for too long header lines.
1831@item long-lines
1832@cindex long lines
1833Check for too long lines in the body.
1834@item message-id
1835Check whether the @code{Message-ID} looks syntactically ok.
1836@item multiple-headers
1837Check for the existence of multiple equal headers.
1838@item new-text
1839Check whether there is any new text in the messages.
1840@item newsgroups
1841Check whether the @code{Newsgroups} header exists and is not empty.
1842@item quoting-style
1843Check whether text follows last quoted portion.
1844@item repeated-newsgroups
1845Check whether the @code{Newsgroups} and @code{Followup-To} headers
1846contains repeated group names.
1847@item reply-to
1848Check whether the @code{Reply-To} header looks ok.
1849@item sender
1850@cindex Sender
1851Insert a new @code{Sender} header if the @code{From} header looks odd.
1852@item sendsys
1853@cindex sendsys
1854Check for the existence of version and sendsys commands.
1855@item shoot
1856Check whether the domain part of the @code{Message-ID} header looks ok.
1857@item shorten-followup-to
1858Check whether to add a @code{Followup-To} header to shorten the number
1859of groups to post to.
1860@item signature
1861Check the length of the signature.
1862@item size
1863Check for excessive size.
1864@item subject
1865Check whether the @code{Subject} header exists and is not empty.
1866@item subject-cmsg
1867Check the subject for commands.
1868@item valid-newsgroups
1869Check whether the @code{Newsgroups} and @code{Followup-To} headers
1870are valid syntactically.
1795@end table 1871@end table
1796 1872
1873All these conditions are checked by default, except for @code{sender}
1874for 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
2077Controls what syntax checks should not be performed on outgoing posts.
2078To disable checking of long signatures, for instance, add
2079
2080@lisp
2081(signature . disabled)
2082@end lisp
2083
2084to this list.
2085
2086Valid checks are:
2087
2088@table @code
2089@item approved
2090@cindex approved
2091Check whether the article has an @code{Approved} header, which is
2092something only moderators should include.
2093@item continuation-headers
2094Check whether there are continuation header lines that don't begin with
2095whitespace.
2096@item control-chars
2097Check for invalid characters.
2098@item empty
2099Check whether the article is empty.
2100@item existing-newsgroups
2101Check whether the newsgroups mentioned in the @code{Newsgroups} and
2102@code{Followup-To} headers exist.
2103@item from
2104Check whether the @code{From} header seems nice.
2105@item illegible-text
2106Check whether there is any non-printable character in the body.
2107@item invisible-text
2108Check whether there is any invisible text in the buffer.
2109@item long-header-lines
2110Check for too long header lines.
2111@item long-lines
2112@cindex long lines
2113Check for too long lines in the body.
2114@item message-id
2115Check whether the @code{Message-ID} looks syntactically ok.
2116@item multiple-headers
2117Check for the existence of multiple equal headers.
2118@item new-text
2119Check whether there is any new text in the messages.
2120@item newsgroups
2121Check whether the @code{Newsgroups} header exists and is not empty.
2122@item quoting-style
2123Check whether text follows last quoted portion.
2124@item repeated-newsgroups
2125Check whether the @code{Newsgroups} and @code{Followup-To} headers
2126contains repeated group names.
2127@item reply-to
2128Check whether the @code{Reply-To} header looks ok.
2129@item sender
2130@cindex Sender
2131Insert a new @code{Sender} header if the @code{From} header looks odd.
2132@item sendsys
2133@cindex sendsys
2134Check for the existence of version and sendsys commands.
2135@item shoot
2136Check whether the domain part of the @code{Message-ID} header looks ok.
2137@item shorten-followup-to
2138Check whether to add a @code{Followup-To} header to shorten the number
2139of groups to post to.
2140@item signature
2141Check the length of the signature.
2142@item size
2143Check for excessive size.
2144@item subject
2145Check whether the @code{Subject} header exists and is not empty.
2146@item subject-cmsg
2147Check the subject for commands.
2148@item valid-newsgroups
2149Check whether the @code{Newsgroups} and @code{Followup-To} headers
2150are valid syntactically.
2151@end table
2152
2153All these conditions are checked by default, except for @code{sender}
2154for 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
2159Regexp of headers to be removed before posting. The default is@* 2158Regexp of headers to be removed before posting. The default is@*
diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el
index f3b830cf849..02db38725a9 100644
--- a/lisp/gnus/message.el
+++ b/lisp/gnus/message.el
@@ -187,22 +187,26 @@ Otherwise, most addresses look like `angles', but they look like
187 187
188(defcustom message-syntax-checks 188(defcustom message-syntax-checks
189 (if message-insert-canlock '((sender . disabled)) nil) 189 (if message-insert-canlock '((sender . disabled)) nil)
190 ;; Guess this one shouldn't be easy to customize...
191 "Controls what syntax checks should not be performed on outgoing posts. 190 "Controls what syntax checks should not be performed on outgoing posts.
192To disable checking of long signatures, for instance, add 191To disable checking of long signatures, for instance, add
193 `(signature . disabled)' to this list. 192 `(signature . disabled)' to this list.
194 193
195Don't touch this variable unless you really know what you're doing. 194Don't touch this variable unless you really know what you're doing.
196 195
197Checks include `approved', `bogus-recipient', `continuation-headers', 196See the Message manual for the meanings of the valid syntax check
198`control-chars', `empty', `existing-newsgroups', `from', `illegible-text', 197types."
199`invisible-text', `long-header-lines', `long-lines', `message-id', 198 :group 'message-headers
200`multiple-headers', `new-text', `newsgroups', `quoting-style', 199 :link '(custom-manual "(message)Message Headers")
201`repeated-newsgroups', `reply-to', `sender', `sendsys', `shoot', 200 :type '(alist
202`shorten-followup-to', `signature', `size', `subject', `subject-cmsg' 201 :key-type symbol
203and `valid-newsgroups'." 202 :value-type (const disabled)
204 :group 'message-news 203 :options (approved bogus-recipient continuation-headers
205 :type '(repeat sexp)) ; Fixme: improve this 204 control-chars empty existing-newsgroups from illegible-text
205 invisible-text long-header-lines long-lines message-id
206 multiple-headers new-text newgroups quoting-style
207 repeated-newsgroups reply-to sender sendsys shoot
208 shorten-followup-to signature size subject subject-cmsg
209 valid-newsgroups)))
206 210
207(defcustom message-required-headers '((optional . References) 211(defcustom message-required-headers '((optional . References)
208 From) 212 From)