org-man.el 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. ;;; org-man.el - Support for links to manpages in Org-mode
  2. ;;
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: https://orgmode.org
  6. ;; Version: 1.0
  7. ;;
  8. ;; This file is not yet part of GNU Emacs.
  9. ;;
  10. ;; This program is free software; you can redistribute it and/or modify
  11. ;; it under the terms of the GNU General Public License as published by
  12. ;; the Free Software Foundation; either version 3, or (at your option)
  13. ;; any later version.
  14. ;; This program is distributed in the hope that it will be useful,
  15. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. ;; GNU General Public License for more details.
  18. ;; You should have received a copy of the GNU General Public License
  19. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  20. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  21. ;;
  22. ;;; Commentary:
  23. (require 'org)
  24. (org-link-set-parameters "man"
  25. :follow #'org-man-open
  26. :export #'org-man-export
  27. :store #'org-man-store-link)
  28. (defcustom org-man-command 'man
  29. "The Emacs command to be used to display a man page."
  30. :group 'org-link
  31. :type '(choice (const man) (const woman)))
  32. (defun org-man-open (path)
  33. "Visit the manpage on PATH.
  34. PATH should be a topic that can be thrown at the man command."
  35. (funcall org-man-command path))
  36. (defun org-man-store-link ()
  37. "Store a link to a README file."
  38. (when (memq major-mode '(Man-mode woman-mode))
  39. ;; This is a man page, we do make this link
  40. (let* ((page (org-man-get-page-name))
  41. (link (concat "man:" page))
  42. (description (format "Manpage for %s" page)))
  43. (org-store-link-props
  44. :type "man"
  45. :link link
  46. :description description))))
  47. (defun org-man-get-page-name ()
  48. "Extract the page name from the buffer name."
  49. ;; This works for both `Man-mode' and `woman-mode'.
  50. (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
  51. (match-string 1 (buffer-name))
  52. (error "Cannot create link to this man page")))
  53. (defun org-man-export (link description format)
  54. "Export a man page link from Org files."
  55. (let ((path (format "http://man.he.net/?topic=%s&section=all" link))
  56. (desc (or description link)))
  57. (cond
  58. ((eq format 'html) (format "<a target=\"_blank\" href=\"%s\">%s</a>" path desc))
  59. ((eq format 'latex) (format "\\href{%s}{%s}" path desc))
  60. ((eq format 'texinfo) (format "@uref{%s,%s}" path desc))
  61. ((eq format 'ascii) (format "%s (%s)" desc path))
  62. (t path))))
  63. (provide 'org-man)
  64. ;;; org-man.el ends here