devdocs/elisp/mode-help.html


1
2
3
4
5
6
7
8
9
10

 <h4 class="subsection">Getting Help about a Major Mode</h4>    <p>The <code>describe-mode</code> function provides information about major modes. It is normally bound to <kbd>C-h m</kbd>. It uses the value of the variable <code>major-mode</code> (see <a href="major-modes">Major Modes</a>), which is why every major mode command needs to set that variable. </p> <dl> <dt id="describe-mode">Command: <strong>describe-mode</strong> <em>&amp;optional buffer</em>
</dt> <dd>
<p>This command displays the documentation of the current buffer’s major mode and minor modes. It uses the <code>documentation</code> function to retrieve the documentation strings of the major and minor mode commands (see <a href="accessing-documentation">Accessing Documentation</a>). </p> <p>If called from Lisp with a non-<code>nil</code> <var>buffer</var> argument, this function displays the documentation for that buffer’s major and minor modes, rather than those of the current buffer. </p>
</dd>
</dl><div class="_attribution">
  <p class="_attribution-p">
    Copyright &copy; 1990-1996, 1998-2022 Free Software Foundation, Inc. <br>Licensed under the GNU GPL license.<br>
    <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Mode-Help.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Mode-Help.html</a>
  </p>
</div>