X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.el;h=703e1e4938600f2fe1f99db31515b9093a5734b5;hp=340f9df8b6a04c04975e561cc46f48ac0630cc3e;hb=efc5b2480f8e40b48298cd2617aecb7df11c032b;hpb=4a7a614530e7d74318b96de4c210ea9fac9df7bc diff --git a/elpher.el b/elpher.el index 340f9df..703e1e4 100644 --- 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, -;; - caching of visited sites (both content and cursor position), +;; - intuitive keyboard and mouse-driven browsing, +;; - out-of-the-box compatibility with evil-mode, +;; - clickable web and gopher links *in plain text*, +;; - caching of visited sites, ;; - 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. +;; - connections using TLS encryption. ;; 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. Any suggestions for +;; improvements are welcome! ;;; Code: @@ -1071,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 @@ -1207,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))