| <!DOCTYPE html> |
| <html> |
| <!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ --> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022), |
| a documentation system that can produce both online information and a |
| printed manual from a single source using semantic markup. |
| |
| Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 Free Software Foundation, Inc. |
| |
| Permission is granted to copy, distribute and/or modify this document |
| under the terms of the GNU Free Documentation License, Version 1.3 or |
| any later version published by the Free Software Foundation; with no |
| Invariant Sections, with no Front-Cover Texts, and with no Back-Cover |
| Texts. A copy of the license is included in the section entitled |
| "GNU Free Documentation License". --> |
| <title>@allowcodebreaks (GNU Texinfo 6.8dev)</title> |
| |
| <meta name="description" content="@allowcodebreaks (GNU Texinfo 6.8dev)"> |
| <meta name="keywords" content="@allowcodebreaks (GNU Texinfo 6.8dev)"> |
| <meta name="resource-type" content="document"> |
| <meta name="distribution" content="global"> |
| <meta name="Generator" content="texi2any"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| |
| <link href="index.html" rel="start" title="Top"> |
| <link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index"> |
| <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> |
| <link href="Breaks.html" rel="up" title="Breaks"> |
| <link href="_0040w.html" rel="next" title="@w"> |
| <link href="_0040_002d-_0040hyphenation.html" rel="prev" title="@- @hyphenation"> |
| <style type="text/css"> |
| <!-- |
| div.example {margin-left: 3.2em} |
| --> |
| </style> |
| |
| |
| </head> |
| |
| <body lang="en"> |
| <div class="section-level-extent" id="g_t_0040allowcodebreaks"> |
| <div class="nav-panel"> |
| <p> |
| Next: <a href="_0040w.html" accesskey="n" rel="next"><code class="code">@w</code>{<var class="var">text</var>}: Prevent Line Breaks</a>, Previous: <a href="_0040_002d-_0040hyphenation.html" accesskey="p" rel="prev"><code class="code">@-</code> and <code class="code">@hyphenation</code>: Helping TeX Hyphenate</a>, Up: <a href="Breaks.html" accesskey="u" rel="up">Forcing and Preventing Breaks</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> |
| </div> |
| <hr> |
| <h3 class="section" id="g_t_0040allowcodebreaks_003a-Control-Line-Breaks-in-_0040code">12.4 <code class="code">@allowcodebreaks</code>: Control Line Breaks in <code class="code">@code</code></h3> |
| |
| <a class="anchor" id="allowcodebreaks"></a><a class="index-entry-id" id="index-allowcodebreaks"></a> |
| <a class="index-entry-id" id="index-Breaks_002c-within-_0040code"></a> |
| <a class="index-entry-id" id="index-_002d_002c-breakpoint-within-_0040code"></a> |
| <a class="index-entry-id" id="index-Hyphen_002c-breakpoint-within-_0040code"></a> |
| <a class="index-entry-id" id="index-Dash_002c-breakpoint-within-_0040code"></a> |
| <a class="index-entry-id" id="index-_005f_002c-breakpoint-within-_0040code"></a> |
| <a class="index-entry-id" id="index-Underscore_002c-breakpoint-within-_0040code"></a> |
| |
| <p>Ordinarily, TeX considers breaking lines at ‘<samp class="samp">-</samp>’ and ‘<samp class="samp">_</samp>’ |
| characters within <code class="code">@code</code> and related commands |
| (see <a class="pxref" href="_0040code.html"><code class="code">@code</code>{<var class="var">sample-code</var>}</a>), more or less as if they were “empty” |
| hyphenation points. |
| </p> |
| <p>This is necessary since many manuals, especially for Lisp-family |
| languages, must document very long identifiers. On the other hand, |
| some manuals don’t have this problem, and you may not wish to allow a |
| line break at the underscore in, for example, <code class="code">SIZE_MAX</code>, or even |
| worse, after any of the four underscores in <code class="code">__typeof__</code>. |
| </p> |
| <p>So Texinfo provides this command: |
| </p> |
| <div class="example"> |
| <pre class="example-preformatted">@allowcodebreaks false |
| </pre></div> |
| |
| <p>to prevent from breaking at ‘<samp class="samp">-</samp>’ or ‘<samp class="samp">_</samp>’ within |
| <code class="code">@code</code>. You can go back to allowing such breaks with |
| <code class="code">@allowcodebreaks true</code>. Write these commands on lines by |
| themselves. |
| </p> |
| <p>These commands can be given anywhere in the document. For example, |
| you may have just one problematic paragraph where you need to turn off |
| the breaks, but want them in general, or vice versa. |
| </p> |
| <p>This command has no effect except in TeX output. |
| </p> |
| |
| </div> |
| |
| |
| |
| </body> |
| </html> |
