Next: , Previous: Documentation Basics, Up: Documentation   [Contents][Index]


23.2 ÀâÌÀʸ»úÎó¤Î»²¾È

Function: documentation-property symbol property &optional verbatim

¤³¤Î´Ø¿ô¤Ï¡¢¥·¥ó¥Ü¥ësymbol¤Î°À­¥ê¥¹¥È¤Ë °À­property¤Çµ­Ï¿¤µ¤ì¤Æ¤¤¤ëÀâÌÀʸ»úÎó¤òÊÖ¤¹¡£ ɬÍפʤé¤Ð¥Õ¥¡¥¤¥ë¤«¤é¥Æ¥­¥¹¥È¤ò¼è¤ê½Ð¤·¡¢ ¼ÂºÝ¤Î¥­¡¼¥Ð¥¤¥ó¥Ç¥£¥ó¥°¤ËÃÖ¤­´¹¤¨¤ë¤¿¤á¤Ë substitute-command-keys¤ò¼Â¹Ô¤¹¤ë¡£ ¡Êverbatim¤¬nil°Ê³°¤Ç¤¢¤ë¤È¡¢ÃÖ´¹¤ò¹Ô¤ï¤Ê¤¤¡£¡Ë

(documentation-property 'command-line-processed
   'variable-documentation)
     ⇒ "Non-nil once command line has been processed"
(symbol-plist 'command-line-processed)
     ⇒ (variable-documentation 188902)
Function: documentation function &optional verbatim

¤³¤Î´Ø¿ô¤Ï¡¢´Ø¿ôfunction¤ÎÀâÌÀʸ»úÎó¤òÊÖ¤¹¡£ ɬÍפʤé¤Ð¥Õ¥¡¥¤¥ë¤«¤é¥Æ¥­¥¹¥È¤ò¼è¤ê½Ð¤¹¡£ ³¤¤¤Æ¡¢¡Êverbatim¤¬nil¤Ê¤é¤Ð¡Ë ¼ÂºÝ¤Î¡Ê¸½ºß¤Î¡Ë¥­¡¼¥Ð¥¤¥ó¥Ç¥£¥ó¥°¤ò´Þ¤ó¤ÀÃͤòÊÖ¤¹¤¿¤á¤Ë substitute-command-keys¤ò¼Â¹Ô¤¹¤ë¡£

´Ø¿ôdocumentation¤Ï¡¢function¤Ë´Ø¿ôÄêµÁ¤¬¤Ê¤¤¤È ¥¨¥é¡¼void-function¤òÄÌÃΤ¹¤ë¡£ ¤·¤«¤·¡¢´Ø¿ôÄêµÁ¤ËÀâÌÀʸ»úÎ󤬤ʤ¯¤Æ¤â¥¨¥é¡¼¤Ç¤Ï¤Ê¤¤¡£ ¤½¤Î¾ì¹ç¡¢documentation¤Ïnil¤òÊÖ¤¹¡£

2¤Ä¤Î´Ø¿ôdocumentation¤Èdocumentation-property¤òÍѤ¤¤Æ¡¢ ¿ô¸Ä¤Î¥·¥ó¥Ü¥ë¤ÎÀâÌÀʸ»úÎó¤ò¥Ð¥Ã¥Õ¥¡‘*Help*’¤Ëɽ¼¨¤¹¤ëÎã¤ò¼¨¤·¤Þ¤¹¡£

(defun describe-symbols (pattern)
  "Describe the Emacs Lisp symbols matching PATTERN.
All symbols that have PATTERN in their name are described
in the `*Help*' buffer."
  (interactive "sDescribe symbols matching: ")
  (let ((describe-func
         (function 
          (lambda (s)
            ;; Print description of symbol.
            (if (fboundp s)             ; ¤³¤ì¤Ï´Ø¿ô
                (princ
                 (format "%s\t%s\n%s\n\n" s
                   (if (commandp s) 
                       (let ((keys (where-is-internal s)))
                         (if keys
                             (concat
                              "Keys: "
                              (mapconcat 'key-description 
                                         keys " "))
                           "Keys: none"))
                     "Function")
                   (or (documentation s) 
                       "not documented"))))
            
            (if (boundp s)              ; ¤³¤ì¤ÏÊÑ¿ô
                (princ
                 (format "%s\t%s\n%s\n\n" s
                   (if (user-variable-p s) 
                       "Option " "Variable")
                   (or (documentation-property 
                         s 'variable-documentation)
                       "not documented")))))))
        sym-list)
    ;; ¥Ñ¥¿¡¼¥ó¤Ë°ìÃפ¹¤ë¥·¥ó¥Ü¥ë¤Î¥ê¥¹¥È¤òºî¤ë
    (mapatoms (function 
               (lambda (sym)
                 (if (string-match pattern (symbol-name sym))
                     (setq sym-list (cons sym sym-list))))))
    ;; ¥Ç¡¼¥¿¤òɽ¼¨¤¹¤ë
    (with-output-to-temp-buffer "*Help*"
      (mapcar describe-func (sort sym-list 'string<))
      (print-help-return-message))))

´Ø¿ôdescribe-symbols¤Ïapropos¤Î¤è¤¦¤Ëưºî¤·¤Þ¤¹¤¬¡¢ ¤è¤ê¿¤¯¤Î¾ðÊó¤òÄ󶡤·¤Þ¤¹¡£

(describe-symbols "goal")

---------- Buffer: *Help* ----------
goal-column     Option 
*Semipermanent goal column for vertical motion, as set by …
set-goal-column Keys: C-x C-n
Set the current horizontal position as a goal for C-n and C-p.
Those commands will move to this position in the line moved to
rather than trying to keep the same horizontal position.
With a non-nil argument, clears out the goal column
so that C-n and C-p resume vertical motion.
The goal column is stored in the variable `goal-column'.
temporary-goal-column   Variable
Current goal column for vertical motion.
It is the column where point was
at the start of current run of vertical motion commands.
When the `track-eol' feature is doing its job, the value is 9999.
---------- Buffer: *Help* ----------
Function: Snarf-documentation filename

¤³¤Î´Ø¿ô¤Ï¡¢¼Â¹Ô²Äǽ¤ÊEmacs¤ò¥À¥ó¥×¤¹¤ëľÁ°¤Î Emacs¤Î½é´ü²½½èÍýÃæ¤Ë¤Î¤ß»È¤ï¤ì¤ë¡£ ¥Õ¥¡¥¤¥ëfilename¤Ë³ÊǼ¤µ¤ì¤¿ÀâÌÀʸ»úÎó¤Î¥Õ¥¡¥¤¥ëÆâ°ÌÃÖ¤òõ¤·½Ð¤·¡¢ ¤½¤ì¤é¤Î¾ðÊó¤ò¼ÂºÝ¤Îʸ»úÎó¤Î¤«¤ï¤ê¤Ë ¥á¥â¥êÆâ¤Î´Ø¿ôÄêµÁ¤äÊÑ¿ô¤Î°À­¥ê¥¹¥È¤Ëµ­Ï¿¤¹¤ë¡£ see Building Emacs¡£

Emacs¤Ï¥Õ¥¡¥¤¥ëfilename¤ò¥Ç¥£¥ì¥¯¥È¥êemacs/etc¤«¤éÆÉ¤à¡£ ¥À¥ó¥×¤·¤¿Emacs¤ò¤Î¤Á¤Ë¼Â¹Ô¤¹¤ë¤È¡¢ Ʊ¤¸¥Õ¥¡¥¤¥ë¤ò¥Ç¥£¥ì¥¯¥È¥êdoc-directory¤Çõ¤¹¡£ Ä̾filename¤Ï"DOC-version"¤Ç¤¢¤ë¡£

Variable: doc-directory

¤³¤ÎÊÑ¿ô¤Ï¡¢ÁȤ߹þ¤ß¤Ç¤¢¤Ã¤¿¤ê¤¢¤é¤«¤¸¤á¥í¡¼¥ÉºÑ¤ß¤Î´Ø¿ô¤äÊÑ¿ô¤Î ÀâÌÀʸ»úÎó¤ò¼ý¤á¤¿¥Õ¥¡¥¤¥ë"DOC-version"¤òÃÖ¤¤¤¿ ¥Ç¥£¥ì¥¯¥È¥ê¤Î̾Á°¤òÊÝ»ý¤¹¤ë¡£

¤Û¤È¤ó¤É¤Î¾ì¹ç¡¢¤³¤ì¤Ïdata-directory¤ÈƱ¤¸¤Ç¤¢¤ë¡£ Emacs¤ò¥¤¥ó¥¹¥È¡¼¥ë¤»¤º¤Ë¹½ÃÛ¤·¤¿¥Ç¥£¥ì¥¯¥È¥ê¤«¤éµ¯Æ°¤¹¤ë¤È¡¢ ¤½¤ì¤é¤Ï°Û¤Ê¤ë¤³¤È¤¬¤¢¤ë¡£ Help Functions¤Îdata-directory¤ò»²¾È¡£

Emacs¤Î¸Å¤¤ÈǤǤϡ¢¤³¤ÎÌÜŪ¤Ë¤Ïexec-directory¤òÍѤ¤¤Æ¤¤¤¿¡£


Next: , Previous: Documentation Basics, Up: Documentation   [Contents][Index]