guide/JM_man_view.rst

   1 =======================
   2 JM-man-view.el の使い方
   3 =======================
   4
   5 ``JM-man-view`` とは、メール本文が man page のファイルのものを整形して表示するための Emacs Lisp です (Emacs 上で動くメーラを使っている人は特に便利です)。
   6
   7 必要なもの
   8 ==========
   9
  10 * `JM-man-view.el <http://git.sourceforge.jp/view?p=linuxjm/jm.git;a=blob_plain;f=admin/JM-man-view.el;hb=HEAD>`_
  11 * `woman.el <https://sites.google.com/site/fjwcentaur/emacs>`_ (emacs21 以降では標準添付になっており、特に入手の必要はありません)
  12 * Emacs (woman.el が XEmacs 上では動かないので XEmacs はダメです)
  13
  14 設定方法
  15 ========
  16
  17 1. ``woman.el`` と ``JM-man-view.el`` を ``load-path`` に置きます。 具体的には、例えば ~/elisp/ に両者を置き、 .emacs に
  18
  19    .. code-block:: none
  20
  21       (setq load-path (cons (expand-file-name "~/elisp") load-path))
  22
  23    と追記するとよいでしょう。
  24 2. .emacs に以下を追記します。
  25
  26    .. code-block:: none
  27
  28       ;; woman
  29       (autoload 'woman "woman"
  30         "Decode and browse a UN*X man page." t)
  31       (autoload 'woman-find-file "woman"
  32         "Find, decode and browse a specific UN*X man-page file." t)
  33       ;; JM-man-view
  34       (autoload 'JM-man-view "JM-man-view" nil t)
  35       (autoload 'JM-man-mail-view "JM-man-view" nil t)
  36
  37 以上で設定は終わりです。
  38
  39 使いかた
  40 ========
  41
  42 メールが表示されているバッファに移動して、
  43 ``M-x JM-man-view`` とすれば、 ``woman`` によって整形されたマニュアルが
  44 別フレーム (X ならウィンドウ) に表示されます。
  45 Wanderlust/Mew を使っている場合は、 Summary モードで ``M-x JM-man-mail-view`` とすれ
  46 ばマニュアルが表示されます。
  47
  48 メールの条件
  49 ============
  50
  51 ``JM-man-view.el`` は、整形対象とするバッファにおける roff 文書に対して、以下の仮定を置いています。
  52
  53 * マニュアル部分の先頭行は、roffのコメントである .\" で始まる (行頭が .\")
  54 * メール本文の最後まで manual である(= 本文の末尾にコメント等がない)
  55
  56 JMpost で投げられるマニュアルは上の条件を満たしますので、 特に意識しなくともかまいません。
  57
  58 制限
  59 ====
  60
  61 現在のところ、``woman.el`` は mdoc 形式のマニュアルの変換ができないようです。
  62 したがって ``JM-man-view.el`` でも、 この形式のマニュアルは閲覧できないことになります。