devdocs/elisp/auto-filling.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

 <h3 class="section">Auto Filling</h3>   <p>Auto Fill mode is a minor mode that fills lines automatically as text is inserted. See <a href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Auto-Fill.html#Auto-Fill">Auto Fill</a> in <cite>The GNU Emacs Manual</cite>. This section describes some variables used by Auto Fill mode. For a description of functions that you can call explicitly to fill and justify existing text, see <a href="filling">Filling</a>. </p> <p>Auto Fill mode also enables the functions that change the margins and justification style to refill portions of the text. See <a href="margins">Margins</a>. </p> <dl> <dt id="auto-fill-function">Variable: <strong>auto-fill-function</strong>
</dt> <dd>
<p>The value of this buffer-local variable should be a function (of no arguments) to be called after self-inserting a character from the table <code>auto-fill-chars</code>, see below. It may be <code>nil</code>, in which case nothing special is done in that case. </p> <p>The value of <code>auto-fill-function</code> is <code>do-auto-fill</code> when Auto Fill mode is enabled. That is a function whose sole purpose is to implement the usual strategy for breaking a line. </p>
</dd>
</dl> <dl> <dt id="normal-auto-fill-function">Variable: <strong>normal-auto-fill-function</strong>
</dt> <dd><p>This variable specifies the function to use for <code>auto-fill-function</code>, if and when Auto Fill is turned on. Major modes can set buffer-local values for this variable to alter how Auto Fill works. </p></dd>
</dl> <dl> <dt id="auto-fill-chars">Variable: <strong>auto-fill-chars</strong>
</dt> <dd><p>A char table of characters which invoke <code>auto-fill-function</code> when self-inserted—space and newline in most language environments. They have an entry <code>t</code> in the table. </p></dd>
</dl> <dl> <dt id="comment-auto-fill-only-comments">User Option: <strong>comment-auto-fill-only-comments</strong>
</dt> <dd><p>This variable, if non-<code>nil</code>, means to fill lines automatically within comments only. More precisely, this means that if a comment syntax was defined for the current buffer, then self-inserting a character outside of a comment will not call <code>auto-fill-function</code>. </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/Auto-Filling.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Auto-Filling.html</a>
  </p>
</div>