Updated package header.

[elpher.git] / elpher.el

diff --git a/elpher.el b/elpher.el
index 3fb2183..8e2e48e 100644 (file)
--- a/elpher.el
+++ b/elpher.el
@@ -26,24 +26,26 @@
 
 ;;; Commentary:
 
-;; Elpher aims to provide a practical gopher client for GNU Emacs.
-;; It supports:
+;; Elpher aims to provide a practical and friendly gopher client
+;; for GNU Emacs.  It supports:
 
-;; - intuitive keyboard and mouse-driven interface,
+;; - an intuitive keyboard and mouse-driven interface,
+;; - followable web and gopher links in plain text,
 ;; - caching of visited sites (both content and cursor position),
 ;; - pleasant and configurable colouring of Gopher directories,
 ;; - direct visualisation of image files,
 ;; - (m)enu key support, similar to Emacs' info browser,
-;; - clickable web and gopher links in plain text,
 ;; - a simple bookmark management system,
-;; - support for TLS gopherholes.
+;; - support for TLS.
 
 ;; To launch Elpher, simply use 'M-x elpher'.  This will open a start
 ;; page containing information on key bindings and suggested starting
 ;; points for your gopher exploration.
 
-;; Faces, caching and other options can be configured via
-;; the Elpher customization group in Applications.
+;; Further instructions can be found in the Elpher info manual.
+
+;; Elpher is under active development, and any suggestions for
+;; improvements are welcome!
 
 ;;; Code:
 
@@ -192,6 +194,13 @@ Otherwise, use the system browser via the BROWSE-URL function."
   "If non-nil, display current node information in buffer header."
   :type '(boolean))
 
+(defcustom elpher-auto-disengage-TLS nil
+  "If non-nil, automatically disengage TLS following an unsuccessful connection.
+While enabling this may seem convenient, it is also potentially dangerous as it
+allows switching from an encrypted channel back to plain text without user input."
+  :type '(boolean))
+
+
 ;;; Model
 ;;
 
@@ -496,9 +505,11 @@ up to the calling function."
     (error
      (if (and (consp the-error)
               (eq (car the-error) 'gnutls-error)
-              (not (elpher-address-use-tls-p address)))
+              (not (elpher-address-use-tls-p address))
+              (or elpher-auto-disengage-TLS
+                  (yes-or-no-p "Could not establish encrypted connection.  Disable TLS mode? ")))
          (progn
-           (message "Could not establish TLS connection.  Disengaging TLS mode.")
+           (message "Disengaging TLS mode.")
            (setq elpher-use-tls nil)
            (elpher-get-selector address after))
        (elpher-process-cleanup)
@@ -1062,7 +1073,7 @@ host, selector and port."
       (error "No link selected"))))
 
 (defun elpher-bookmarks ()
-  "Visit bookmarks."
+  "Visit bookmarks page."
   (interactive)
   (switch-to-buffer "*elpher*")
   (elpher-visit-node
@@ -1198,7 +1209,11 @@ host, selector and port."
   "Keymap for gopher client.")
 
 (define-derived-mode elpher-mode special-mode "elpher"
-  "Major mode for elpher, an elisp gopher client.")
+  "Major mode for elpher, an elisp gopher client.
+
+This mode is automatically enabled by the interactive
+functions which initialize the gopher client, namely
+`elpher', `elpher-go' and `elpher-bookmarks'.")
 
 (when (fboundp 'evil-set-initial-state)
   (evil-set-initial-state 'elpher-mode 'motion))