More work on manual.
[elpher.git] / elpher.el
index 7cceacb..c0734ca 100644 (file)
--- a/elpher.el
+++ b/elpher.el
@@ -4,7 +4,7 @@
 
 ;; Author: Tim Vaughan <tgvaughan@gmail.com>
 ;; Created: 11 April 2019
-;; Version: 1.4.1
+;; Version: 1.4.2
 ;; Keywords: comm gopher
 ;; Homepage: https://github.com/tgvaughan/elpher
 ;; Package-Requires: ((emacs "25"))
 
 ;;; 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,
 ;; - caching of visited sites (both content and cursor position),
 ;; - pleasant and configurable colouring of Gopher directories,
 ;; - direct visualisation of image files,
@@ -45,6 +45,9 @@
 ;; Faces, caching and other options can be configured via
 ;; the Elpher customization group in Applications.
 
+;; Elpher is under active development, and any suggestions for
+;; improvements are welcome!
+
 ;;; Code:
 
 (provide 'elpher)
@@ -55,7 +58,7 @@
 ;;; Global constants
 ;;
 
-(defconst elpher-version "1.4.1"
+(defconst elpher-version "1.4.2"
   "Current version of elpher.")
 
 (defconst elpher-margin-width 6
@@ -86,7 +89,7 @@
          "i - r: redraw current page (using cached contents if available)\tfake\tfake\t1"
          "i - R: reload current page (regenerates cache)\tfake\tfake\t1"
          "i - T: toggle TLS mode\tfake\tfake\t1"
-         "i - d: download directory entry under cursor\tfake\tfake\t1"
+         "i - d/D: download item under cursor or current page\tfake\tfake\t1"
          "i - w: display the raw server response for the current page\tfake\tfake\t1"
          "i - S: set an explicit character coding system (default is to autodetect)\tfake\tfake\t1"
          "i\tfake\tfake\t1"
@@ -225,7 +228,7 @@ before attempting to connect to the server."
   (elt address 3))
 
 (defun elpher-address-use-tls-p (address)
-  "Returns non-nil if ADDRESS is marked as needing TLS."
+  "Return non-nil if ADDRESS is marked as needing TLS."
   (elt address 4))
 
 (defun elpher-address-special-p (address)
@@ -417,8 +420,8 @@ away CRs and any terminating period."
 (defun elpher-insert-index-record (display-string address)
   "Function to insert an index record into the current buffer.
 The contents of the record are dictated by DISPLAY-STRING and ADDRESS."
-  (let ((type-map-entry (alist-get (elpher-address-type address)
-                                   elpher-type-map)))
+  (let* ((type (elpher-address-type address))
+         (type-map-entry (alist-get type elpher-type-map)))
     (if type-map-entry
         (let* ((margin-code (elt type-map-entry 1))
                (face (elt type-map-entry 2))
@@ -467,11 +470,12 @@ The contents of the record are dictated by DISPLAY-STRING and ADDRESS."
   "Retrieve selector specified by ADDRESS, then execute AFTER.
 The result is stored as a string in the variable ‘elpher-selector-string’."
   (setq elpher-selector-string "")
-  (when (and (elpher-address-use-tls-p address)
-             (not elpher-use-tls)
-             (gnutls-available-p))
-    (setq elpher-use-tls t)
-    (message "Engaging TLS mode."))
+  (when (elpher-address-use-tls-p address)
+      (if (gnutls-available-p)
+          (when (not elpher-use-tls)
+            (setq elpher-use-tls t)
+            (message "Engaging TLS mode."))
+        (error "Cannot retrieve TLS selector: GnuTLS not available")))
   (condition-case the-error
       (let* ((kill-buffer-query-functions nil)
              (proc (open-network-stream "elpher-process"
@@ -899,11 +903,14 @@ host, selector and port."
     (message "No current site.")))
 
 (defun elpher-toggle-tls ()
-  "Toggle TLS mode."
+  "Toggle TLS encryption mode."
   (interactive)
   (setq elpher-use-tls (not elpher-use-tls))
   (if elpher-use-tls
-      (message "TLS mode enabled.  (Will not affect current page until reload.)")
+      (if (gnutls-available-p)
+          (message "TLS mode enabled.  (Will not affect current page until reload.)")
+        (setq elpher-use-tls nil)
+        (error "Cannot enable TLS mode: GnuTLS not available"))
     (message "TLS mode disabled.  (Will not affect current page until reload.)")))
 
 (defun elpher-view-raw ()
@@ -935,6 +942,18 @@ host, selector and port."
                                #'elpher-get-node-download)))
       (error "No link selected"))))
 
+(defun elpher-download-current ()
+  "Download the current page."
+  (interactive)
+  (if (elpher-address-special-p (elpher-node-address elpher-current-node))
+      (error "Cannot download this page")
+    (elpher-visit-node (elpher-make-node
+                        (elpher-node-display-string elpher-current-node)
+                        (elpher-node-address elpher-current-node)
+                        elpher-current-node)
+                       #'elpher-get-node-download
+                       t)))
+
 (defun elpher-build-link-map ()
   "Build alist mapping link names to destination nodes in current buffer."
   (let ((link-map nil)
@@ -1034,7 +1053,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
@@ -1129,6 +1148,7 @@ host, selector and port."
     (define-key map (kbd "T") 'elpher-toggle-tls)
     (define-key map (kbd "w") 'elpher-view-raw)
     (define-key map (kbd "d") 'elpher-download)
+    (define-key map (kbd "D") 'elpher-download-current)
     (define-key map (kbd "m") 'elpher-jump)
     (define-key map (kbd "i") 'elpher-info-link)
     (define-key map (kbd "I") 'elpher-info-current)
@@ -1153,6 +1173,7 @@ host, selector and port."
         (kbd "T") 'elpher-toggle-tls
         (kbd "w") 'elpher-view-raw
         (kbd "d") 'elpher-download
+        (kbd "D") 'elpher-download-current
         (kbd "m") 'elpher-jump
         (kbd "i") 'elpher-info-link
         (kbd "I") 'elpher-info-current
@@ -1168,7 +1189,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))