mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 14:30:50 -08:00
Code Issues Projects Releases Wiki Activity

Slightly improve hashcash documentation

Browse source 
* lisp/mail/hashcash.el: Improve Commentary.
(hashcash-program):
* lisp/gnus/message.el (message-generate-hashcash): Improve
docstring.
This commit is contained in:
Stefan Kangas 2023-02-18 13:00:04 +01:00
parent 6ea3c105ab
commit 4a90d67eb6
2 changed files with 14 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

5
lisp/gnus/message.el
View file

@ -1926,9 +1926,10 @@ no, only reply back to the author."
"Whether to generate X-Hashcash: headers. "Whether to generate X-Hashcash: headers.
If t, always generate hashcash headers. If `opportunistic', If t, always generate hashcash headers. If `opportunistic',
only generate hashcash headers if it can be done without the user only generate hashcash headers if it can be done without the user
waiting (i.e., only asynchronously). waiting (i.e., only asynchronously). If nil, don't generate
hashcash headers.
You must have the \"hashcash\" binary installed, see `hashcash-path'." You must have the \"hashcash\" binary installed, see `hashcash-program'."
:version "24.1" :version "24.1"
:group 'message-headers :group 'message-headers
:link '(custom-manual "(message)Mail Headers") :link '(custom-manual "(message)Mail Headers")

18
lisp/mail/hashcash.el
View file

@ -25,16 +25,16 @@
;; The hashcash binary is at http://www.hashcash.org/. ;; The hashcash binary is at http://www.hashcash.org/.
;; ;;
;; Call mail-add-payment to add a hashcash payment to a mail message ;; Call `mail-add-payment' to add a hashcash payment to a mail message
;; in the current buffer. ;; in the current buffer.
;; ;;
;; Call mail-add-payment-async after writing the addresses but before ;; Call `mail-add-payment-async' after writing the addresses but
;; writing the mail to start calculating the hashcash payment ;; before writing the mail to start calculating the hashcash payment
;; asynchronously. ;; asynchronously.
;; ;;
;; The easiest way to do this automatically for all outgoing mail ;; The easiest way to do this automatically for all outgoing mail is
;; is to set `message-generate-hashcash' to t. If you want more ;; to set `message-generate-hashcash' to `opportunistic' or t. If you
;; control, try the following hooks. ;; want more control, try the following hooks.
;; ;;
;; To automatically add payments to all outgoing mail when sending: ;; To automatically add payments to all outgoing mail when sending:
;; (add-hook 'message-send-hook 'mail-add-payment) ;; (add-hook 'message-send-hook 'mail-add-payment)
@ -44,6 +44,8 @@
;; ;;
;; To check whether calculations are done before sending: ;; To check whether calculations are done before sending:
;; (add-hook 'message-send-hook 'hashcash-wait-or-cancel) ;; (add-hook 'message-send-hook 'hashcash-wait-or-cancel)
;;
;; For more information, see Info node `(gnus) Hashcash'.
;;; Code: ;;; Code:
@ -87,7 +89,9 @@ is used instead."
(define-obsolete-variable-alias 'hashcash-path 'hashcash-program "24.4") (define-obsolete-variable-alias 'hashcash-path 'hashcash-program "24.4")
(defcustom hashcash-program "hashcash" (defcustom hashcash-program "hashcash"
"The name of the hashcash executable. "The name of the hashcash executable.
If this is not in your PATH, specify an absolute file name." If this is not in your PATH, specify an absolute file name.
See also `message-generate-hashcash'."
:type '(choice (const nil) file)) :type '(choice (const nil) file))
(defcustom hashcash-extra-generate-parameters '("-Z2") (defcustom hashcash-extra-generate-parameters '("-Z2")