Florian Ragwitz
and 1 contributors

NAME

Emacs::PodMode - Emacs major mode for editing .pod-files

VERSION

version 1.04

DESRIPTION

POD is the Plain Old Documentation format of Perl. This mode supports writing POD.

USAGE

Put the file pod-mode.el into your load-path and the following into your ~/.emacs:

    (autoload 'pod-mode "pod-mode"
      "Mode for editing POD files" t)

To associate pod-mode with .pod files add the following to your ~/.emacs:

    (add-to-list 'auto-mode-alist '("\\.pod$" . pod-mode))

To automatically turn on font-lock-mode add the following to your ~/.emacs:

    (add-hook 'pod-mode-hook 'font-lock-mode)

In addition to the standard POD commands, custom commands as defined by a Pod::Weaver configuration are supported. However, for those to work, eproject.el as available at http://github.com/jrockway/eproject is required.

Make sure to require eproject.el or create an autoload for eproject-maybe-turn-on if you expect custom commands to work.

When automatically inserting hyperlink formatting codes to modules or sections within modules, autocompletion for module names will be provided if perldoc.el, as available at git://gaffer.ptitcanardnoir.org/perldoc-el.git, is present.

SEE ALSO

For the actual mode please refer to pod-mode.el.

AUTHORS

  • Steffen Schwigon <ss5@renormalist.net>

  • Florian Ragwitz <rafl@debian.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2010 by Steffen Schwigon.

This is free software, licensed under:

  The GNU General Public License, Version 2, June 1991