File indexing completed on 2024-11-24 04:34:43
0001 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 0002 <html> 0003 <!-- This document is an unofficial reference manual for LaTeX, a 0004 document preparation system, version of November 2018. 0005 0006 This manual was originally translated from LATEX.HLP v1.0a in the 0007 VMS Help Library. The pre-translation version was written by 0008 George D. Greenwade of Sam Houston State University. The 0009 LaTeX 2.09 version was written by Stephen Gilmore. The 0010 LaTeX2e version was adapted from this by Torsten Martinsen. Karl 0011 Berry made further updates and additions, and gratefully acknowledges 0012 using Hypertext Help with LaTeX, by Sheldon Green, and 0013 LaTeX Command Summary (for LaTeX 2.09) by 0014 L. Botway and C. Biemesderfer (published by the TeX Users 0015 Group as TeXniques number 10), as reference material. We also 0016 gratefully acknowledge additional material appearing in 0017 latex2e-reference by Martin Herbert Dietze. (From these references no 0018 text was directly copied.) 0019 0020 Copyright 2007, 2008, 2009, 2010, 2011, 2012, 2013, 0021 2014, 2015, 2016, 2017, 2018 Karl Berry. 0022 0023 Copyright 1988, 1994, 2007 Stephen Gilmore. 0024 0025 Copyright 1994, 1995, 1996 Torsten Martinsen. 0026 0027 Permission is granted to make and distribute verbatim copies of 0028 this manual provided the copyright notice and this permission notice 0029 are preserved on all copies. 0030 0031 0032 Permission is granted to copy and distribute modified versions of this 0033 manual under the conditions for verbatim copying, provided that the entire 0034 resulting derived work is distributed under the terms of a permission 0035 notice identical to this one. 0036 0037 Permission is granted to copy and distribute translations of this manual 0038 into another language, under the above conditions for modified versions. --> 0039 <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> 0040 <head> 0041 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 0042 <title>\message (LaTeX2e unofficial reference manual (November 2018))</title> 0043 0044 <meta name="description" content="\message (LaTeX2e unofficial reference manual (November 2018))"> 0045 <meta name="keywords" content="\message (LaTeX2e unofficial reference manual (November 2018))"> 0046 <meta name="resource-type" content="document"> 0047 <meta name="distribution" content="global"> 0048 <meta name="Generator" content="makeinfo"> 0049 <link href="index.html#Top" rel="start" title="Top"> 0050 <link href="IndexDocument.html#Index" rel="index" title="Index"> 0051 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> 0052 <link href="_005cwrite.html#g_t_005cwrite" rel="up" title="\write"> 0053 <link href="_005cwlog.html#g_t_005cwlog" rel="next" title="\wlog"> 0054 <link href="_005cwrite.html#g_t_005cwrite" rel="prev" title="\write"> 0055 <style type="text/css"> 0056 <!-- 0057 /* $Id: latex2e.css 690 2018-09-15 15:20:19Z jimhefferon $ 0058 Minor css for latexrefman. Public domain. 0059 Originally written by Jim Hefferon and Karl Berry, 2018. */ 0060 0061 /* So you can style for yourself */ 0062 @import url("/css/latexreflocal.css"); 0063 0064 0065 0066 a.summary-letter {text-decoration: none} 0067 blockquote.indentedblock {margin-right: 0em} 0068 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller} 0069 blockquote.smallquotation {font-size: smaller} 0070 div.display {margin-left: 3.2em} 0071 div.example {margin-left: 3.2em} 0072 div.lisp {margin-left: 3.2em} 0073 div.smalldisplay {margin-left: 3.2em} 0074 div.smallexample {margin-left: 3.2em} 0075 div.smalllisp {margin-left: 3.2em} 0076 kbd {font-style: oblique} 0077 pre.display {font-family: inherit} 0078 pre.format {font-family: inherit} 0079 pre.menu-comment {font-family: serif} 0080 pre.menu-preformatted {font-family: serif} 0081 pre.smalldisplay {font-family: inherit; font-size: smaller} 0082 pre.smallexample {font-size: smaller} 0083 pre.smallformat {font-family: inherit; font-size: smaller} 0084 pre.smalllisp {font-size: smaller} 0085 span.nolinebreak {white-space: nowrap} 0086 span.roman {font-family: initial; font-weight: normal} 0087 span.sansserif {font-family: sans-serif; font-weight: normal} 0088 ul.no-bullet {list-style: none} 0089 BODY { 0090 margin-top: 1em; 0091 margin-left: 1em; /* auto results in two-digit <ol> lost off left */ 0092 margin-right: 1em; 0093 margin-bottom: 1em; 0094 /* the idea is to use the whole window, unless it is ridiculously 0095 wide, probably with too-small fonts, too. */ 0096 max-width: 64em; 0097 } 0098 0099 /* Because we want @math{... @code ...} to be upright, not slanted, 0100 and Texinfo won't fix it. */ 0101 code {font-style:normal; font-family:monospace; } 0102 0103 /* We put a link to our own home page at the bottom. */ 0104 div.referenceinfo {font-size:small;} 0105 0106 --> 0107 </style> 0108 0109 0110 </head> 0111 0112 <body lang="en"> 0113 <a name="g_t_005cmessage"></a> 0114 <div class="header"> 0115 <p> 0116 Next: <a href="_005cwlog.html#g_t_005cwlog" accesskey="n" rel="next">\wlog</a>, Up: <a href="_005cwrite.html#g_t_005cwrite" accesskey="u" rel="up">\write</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="IndexDocument.html#Index" title="Index" rel="index">Index</a>]</p> 0117 </div> 0118 <hr> 0119 <a name="g_t_005cmessage-1"></a> 0120 <h4 class="subsection">27.5.1 <code>\message</code></h4> 0121 0122 <a name="index-_005cmessage"></a> 0123 0124 <p>Synopsis: 0125 </p> 0126 <div class="example"> 0127 <pre class="example">\message{<var>string</var>} 0128 </pre></div> 0129 0130 <p>Write <code>string</code> to the log file and the terminal. 0131 </p> 0132 <p>Typically, LaTeX authors use <code>\typeout</code> (see <a href="_005ctypeout.html#g_t_005ctypeout">\typeout</a>). It 0133 allows you to use <code>\protect</code> on any fragile commands in 0134 <var>string</var> (see <a href="_005cprotect.html#g_t_005cprotect">\protect</a>). But <code>\typeout</code> always inserts a 0135 newline at the end of <var>string</var> while <code>\message</code> does not, so 0136 the latter can be useful. 0137 </p> 0138 <p>With this example document body. 0139 </p> 0140 <div class="example"> 0141 <pre class="example">before\message{One Two}\message{Three}\message{Four^^JI} 0142 \message{declare a thumb war.}After 0143 </pre></div> 0144 0145 <p>under some circumstances (see below) LaTeX writes the following to 0146 both the terminal and the log file. 0147 </p> 0148 <div class="example"> 0149 <pre class="example">One Two Three Four 0150 I declare a thumb war. 0151 </pre></div> 0152 0153 <p>Note that <code>^^J</code> produces a newline. Also, in the output document, 0154 between ‘<samp>before</samp>’ and ‘<samp>After</samp>’ will be a single space (from 0155 the end of line following ‘<samp>I}</samp>’). 0156 </p> 0157 <p>While <code>\message</code> allows you more control over formatting 0158 interaction lines, a gotcha is that LaTeX may mess up your formatting 0159 because it inserts line breaks depending on what it has already put 0160 out. Contrast this document body, where the ‘<samp>Two</samp>’ has moved, to the 0161 one given above. 0162 </p> 0163 <div class="example"> 0164 <pre class="example">before\message{One}\message{Two Three}\message{Four^^JI} 0165 \message{declare a thumb war.}After 0166 </pre></div> 0167 0168 <p>This can happen: when LaTeX is outputting the messages to the 0169 terminal, now the message with ‘<samp>One</samp>’ is shorter and it fits at the 0170 end of the output terminal line, and so LaTeX breaks the line between 0171 it and the ‘<samp>Two Three</samp>’. That line break appears also in the log 0172 file. This line break insertion can depend on, for instance, the length 0173 of the full path names of included files. So producing finely-formatted 0174 lines in a way that is portable is hard. 0175 </p> 0176 0177 0178 0179 <hr/><div class='referenceinfo'> <a href='https://latexref.xyz/'> <i>Unofficial LaTeX2e reference manual</i></a></div> 0180 </body> 0181 </html>