summaryrefslogtreecommitdiff
path: root/doc/refcard
diff options
context:
space:
mode:
authorLorry Tar Creator <lorry-tar-importer@baserock.org>2013-09-26 23:06:02 +0000
committer <>2015-02-03 11:56:22 +0000
commite0b511b834f3529395df67126a7314097c2cf97e (patch)
tree89945ae53183ab2acdc61659c8b0b3e57e4a1f3a /doc/refcard
parent2d8ae7b161658c4a589172db0072fc99f76fa979 (diff)
downloadtexinfo-tarball-master.tar.gz
Imported from /home/lorry/working-area/delta_texinfo-tarball/texinfo-5.2.tar.xz.HEADtexinfo-5.2master
Diffstat (limited to 'doc/refcard')
-rw-r--r--doc/refcard/Makefile43
-rwxr-xr-xdoc/refcard/txicmdcheck108
-rw-r--r--doc/refcard/txirefcard-a4.pdfbin94645 -> 99718 bytes
-rw-r--r--doc/refcard/txirefcard.pdfbin95335 -> 100469 bytes
-rw-r--r--doc/refcard/txirefcard.tex359
5 files changed, 311 insertions, 199 deletions
diff --git a/doc/refcard/Makefile b/doc/refcard/Makefile
new file mode 100644
index 0000000..a7c4ea7
--- /dev/null
+++ b/doc/refcard/Makefile
@@ -0,0 +1,43 @@
+# $Id: Makefile,v 1.4 2012-09-21 17:40:44 karl Exp $
+# Makefile for texinfo/doc/refcard.
+# This is not hooked into Automake, just here for those working on the refcard.
+#
+# Copyright 2008, 2012 Free Software Foundation, Inc.
+#
+# This file is free software; as a special exception the author gives
+# unlimited permission to copy and/or distribute it, with or without
+# modifications, as long as this notice is preserved.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+doc = txirefcard
+
+# parallel makes, etc., will fail.
+all: $(doc).pdf $(doc)-a4.pdf
+
+# trying to get it work with pdftex isn't worth the trouble.
+$(doc).pdf: $(doc).tex
+ tex '\nonstopmode \input $(doc)'
+ dvips -t landscape -t letter $(doc) -o
+ ps2pdf $(doc).ps
+
+$(doc)-a4.pdf: $(doc).tex
+ tex '\nonstopmode \let\afour=1 \input $(doc)'
+ dvips -t landscape -t a4 $(doc) -o
+ ps2pdf $(doc).ps $@
+
+check: ccheck vcheck
+
+ccheck:
+ txicmdcheck $(txi_check_args)
+
+vcheck:
+ txivarcheck $(txi_check_args)
+
+clean:
+ rm -f $(doc)*.dvi $(doc)*.log $(doc)*.ps
+
+distclean: clean
+ rm -f $(doc)*.pdf
diff --git a/doc/refcard/txicmdcheck b/doc/refcard/txicmdcheck
index 89f39f8..b986f85 100755
--- a/doc/refcard/txicmdcheck
+++ b/doc/refcard/txicmdcheck
@@ -1,6 +1,6 @@
#!/usr/bin/env perl
-# $Id: txicmdcheck,v 1.1 2008/09/07 22:47:47 karl Exp $
-# Copyright 2008 Free Software Foundation, Inc.
+# $Id: txicmdcheck 5320 2013-08-16 13:50:01Z karl $
+# Copyright 2008, 2011, 2012, 2013 Free Software Foundation, Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@@ -17,41 +17,53 @@
#
# Original author: Karl Berry.
#
-# Kludge of a script to check command lists in refcard vs. refman
-# for consistency. Would be nice to check makeinfo, too.
+# Kludge of a script to check command lists in refcard vs. refman vs.
+# tp for consistency.
exit (&main ());
-sub main
-{
- my @cardcmds = &read_refcard ("txirefcard.tex");
- my @mancmds = &read_refman ("../texinfo.txi");
- my (%mancmds, %cardcmds);
- @mancmds{@mancmds} = ();
- @cardcmds{@cardcmds} = ();
+sub main {
+ my $no_common = $ARGV[0] eq "--no-common";
+
+ my @card_cmds = &read_refcard ("txirefcard.tex");
+ my @man_cmds = &read_refman ("../texinfo.texi");
+ my @tp_cmds = &read_tp ("../../util/txicmdlist");
+ # perhaps we should check against the manual's fnindex too.
+
+ my (%card_cmds, %man_cmds, %tp_cmds);
+ @card_cmds{@card_cmds} = ();
+ @man_cmds{@man_cmds} = ();
+ @tp_cmds{@tp_cmds} = ();
my @found = ();
- for my $cc (@cardcmds) {
- if (exists $mancmds{$cc}) {
+ for my $cc (@card_cmds) {
+ if (exists $man_cmds{$cc} && exists $tp_cmds{$cc}) {
push (@found, $cc);
- delete $mancmds{$cc};
- delete $cardcmds{$cc};
+ delete $man_cmds{$cc};
+ delete $card_cmds{$cc};
+ delete $tp_cmds{$cc};
}
}
- printf " common %d: @{[sort @found]}\n", @found + 0;
- my @card_only = keys %cardcmds;
+
+ printf (" common %d: @{[sort @found]}\n", @found + 0)
+ unless $no_common;
+
+ my @card_only = keys %card_cmds;
printf "refcard only %s: @{[sort @card_only]}\n", @card_only + 0;
- my @man_only = keys %mancmds;
+
+ my @man_only = keys %man_cmds;
printf "refman only %s: @{[sort @man_only]}\n", @man_only + 0;
- return @card_only + @man_only;
+ my @tp_only = keys %tp_cmds;
+ printf "tp only %s: @{[sort @tp_only]}\n", @tp_only + 0;
+
+ return @card_only + @man_only + @tp_only;
}
-# Return command names given in the reference card.
+# Return command names from the reference card.
#
-sub read_refcard
-{
+sub read_refcard {
my ($fname) = @_;
my @ret = ();
@@ -66,8 +78,9 @@ sub read_refcard
s/}{.*//; # then the descriptions
s/^\\txicmdx{// && ($xcmd = 1); # used for the @def...x
s/^\\txicmd{//; # finally the markup cmd itself
+ s/\\ttbraced{}//g; # quote cmd list
- my (@cmds) = split (/, */, $_); # a couple of times we combine cmds
+ my (@cmds) = split (/,? +/, $_); # occasionally we combine cmds
# we typeset these specially in TeX.
if ("@cmds" eq "@#1footing") {
@@ -80,6 +93,7 @@ sub read_refcard
for my $c (@cmds) {
#warn "refcard $c\n";
#warn "refcard $c{x}\n" if $xcmd;
+ next if $c eq "txicommandconditionals"; # variable not separate in manual
if ($c eq '@\tildechar') { # TeX specialties, forcibly make them match
$c = '@~';
} elsif ($c eq '@\var{whitespace}') {
@@ -93,18 +107,18 @@ sub read_refcard
push (@ret, "${c}x") if $xcmd;
}
}
- push (@ret, '@,'); # our non-parsing above lost the comma
push (@ret, '@end', '@uref', '@appendixsection'); # described in text
+ push (@ret, '@,'); # our non-parsing above lost these
+ push (@ret, qw(@atchar @lbracechar @rbracechar @backslashchar));
close (FILE) || warn "close($FILE) failed: $!";
return @ret;
}
-# Return command names from the @-Command List summary node in the
-# reference manual.
+# Return command names from the @-Command List
+# node in the reference manual.
#
-sub read_refman
-{
+sub read_refman {
my ($fname) = @_;
my @ret = ();
@@ -118,7 +132,7 @@ sub read_refman
last if /^\@end table/; # ignore again after the summary
next unless s/^\@itemx? *\@//; # only want item[x]s in the table
chomp;
- s/\@\{.*//; # remove braced arguments
+ s/\@\{.+//; # remove braced arguments (but not @{)
s/ .*//; # remove arguments following a space
s/\@\@/@/g; # @@ -> @
next if $_ =~ /^\@(br|ctrl)$/; # @ignore-d in text
@@ -129,3 +143,39 @@ sub read_refman
close (FILE) || warn "close($FILE) failed: $!";
return @ret;
}
+
+
+# Return command names implemented in the general parser.
+# The argument is the command to run to return the list.
+#
+sub read_tp {
+ my ($prog) = @_;
+ my @ret = ();
+
+ local *FILE;
+ $FILE = "$prog |";
+ open (FILE) || die "open($FILE) failed: $!";
+ while (<FILE>) {
+ chomp;
+ # excise @<whitespace> commands from normal list.
+ next if $_ eq '@ ' || $_ eq "\@\t" || $_ eq "" || $_ eq '@';
+
+ # obsolete and/or subsidiary commands we don't want to document as usual.
+ next if $_ =~ /allow-recursion
+ |columnfractions
+ |cropmarks
+ |ctrl
+ |(even|every|odd)(foot|head)ingmarks
+ |quote-arg
+ |rmacro
+ |shorttitle$
+ |\|
+ /x;
+ push (@ret, $_);
+ }
+ close (FILE) || warn "close($FILE) failed: $!";
+
+ push (@ret, '@var{whitespace}');
+
+ return @ret;
+}
diff --git a/doc/refcard/txirefcard-a4.pdf b/doc/refcard/txirefcard-a4.pdf
index a630ca3..6db82bc 100644
--- a/doc/refcard/txirefcard-a4.pdf
+++ b/doc/refcard/txirefcard-a4.pdf
Binary files differ
diff --git a/doc/refcard/txirefcard.pdf b/doc/refcard/txirefcard.pdf
index 358c0cc..1f8e1e0 100644
--- a/doc/refcard/txirefcard.pdf
+++ b/doc/refcard/txirefcard.pdf
Binary files differ
diff --git a/doc/refcard/txirefcard.tex b/doc/refcard/txirefcard.tex
index 9e62723..7862b9b 100644
--- a/doc/refcard/txirefcard.tex
+++ b/doc/refcard/txirefcard.tex
@@ -1,5 +1,5 @@
% Texinfo reference card.
-% $Id: txirefcard.tex,v 1.1 2008/09/07 22:47:47 karl Exp $
+% $Id: txirefcard.tex 5381 2013-09-26 23:03:58Z karl $
%
%**start of header
% This file can be printed with 1, 2, or 3 columns per page (see below).
@@ -14,7 +14,7 @@
\newcount\letterpaper
\ifx\undefined\afour\letterpaper=1 \else\letterpaper=0 \fi
-% Copyright 2008 Free Software Foundation, Inc.
+% Copyright 2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
%
% This file is part of GNU Texinfo.
%
@@ -40,24 +40,24 @@
% Author:
% Robert D. Solimeno (adapted from Emacs reference card by Stephen Gildea)
% Internet: solimeno (at) gmail (dot) com
-%
+%
% The author thanks Karl Berry for the opportunity to contribute to this
% project and for his assistance and great patience as I learned how to
% use TeX.
-%
+%
% Much of the text is based on, and sometimes copied from, the @-Command
-% Summary node in texinfo.txi, written primarily by Bob Chassell.
+% Summary node in the Texinfo manual, originally written by Bob Chassell.
-\def\versionyear{2008} % year manual was updated
-\def\versionTexinfo{4.13} % version of Texinfo this manual is for
-\def\year{2008} % copyright year
+\def\versionyear{2013} % year manual was updated
+\def\versionTexinfo{5.2} % version of Texinfo this manual is for
\def\copyrightnotice{%
\vskip 1ex plus 1filll\begingroup\small
\advance\baselineskip by 1pt
-\centerline{Copyright \copyright\ \year\ Free Software Foundation, Inc.}
+\centerline{Copyright \copyright\ 2013 Free Software Foundation, Inc.}
\centerline{for Texinfo version \versionTexinfo, \versionyear}
\centerline{by Robert D. Solimeno}
+\centerline{and the Texinfo maintainers}
\smallskip
Copying and distribution of this material, with or without modification,
@@ -65,9 +65,9 @@
notice and this notice are preserved.
\smallskip
-For printed copies of the Texinfo manual, visit {\tt http://gnupress.org} or
-write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
-Floor, Boston, MA 02110-1301 USA.
+For printed copies of the Texinfo manual, visit {\tt
+http://www.gnupress.org} or write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
\endgroup}
@@ -114,7 +114,7 @@ Floor, Boston, MA 02110-1301 USA.
\font\subsubheadingfont=cmbx8 \scaledmag0
\font\smallfont=cmr8
\font\smallsy=cmsy8
- \font\eightrm=cmr8
+ \font\eightrm=cmr8
\font\eightbf=cmbx8
\font\eightit=cmti8
\font\eighttt=cmtt8
@@ -206,7 +206,7 @@ Floor, Boston, MA 02110-1301 USA.
\nobreak\noindent {\subheadingfont #1}%
\nobreak\vskip 0pt plus.5ex\nobreak}
%
-\outer\def\subsection#1{\glueabove{1ex plus.5ex minus.5ex}%
+\outer\def\subsection#1{\glueabove{.75ex plus.5ex minus.5ex}%
\nobreak\noindent \centerline{\it #1}%
\nobreak\vskip-.5ex % reduce parskip
\nobreak
@@ -219,6 +219,9 @@ Floor, Boston, MA 02110-1301 USA.
% inserted. Using \paralign instead of \halign solves this problem.
\def\paralign{\vskip\parskip\halign}
+% forced line break.
+\def\linebreak{\hfil\break}
+
% code, samp - typewriter, without or with surrounding quotes.
\def\code#1{{\tt#1}\null} %\null so not an abbrev even if period follows
\def\samp#1{`\code{#1}'}
@@ -282,7 +285,7 @@ Floor, Boston, MA 02110-1301 USA.
\def\txicmdx#1{\txicmd{#1\rmbrack[x]}}
% Enclose argument in roman brackets.
-\def\rmbrack[#1]{{\small[}#1{\small{]}\thinspace}}
+\def\rmbrack[#1]{{\small[}#1\/{\small{]}\thinspace}}
% Enclose argument in typewriter braces.
\def\ttbraced#1{\lbracechar#1\rbracechar}
@@ -307,7 +310,7 @@ Floor, Boston, MA 02110-1301 USA.
&\code{#3}\hfil\quad\cr}
% Define the LaTeX logo
-\def\LaTeX{L\kern-.26em \raise.7ex\hbox{\fiverm A}\kern-.15em \TeX}%
+\def\LaTeX{L\kern-.35em \raise.65ex\hbox{\fiverm A}\kern-.15em \TeX}%
% Define some special glyphs, taken from Texinfo.tex
% The @error{} command.
@@ -343,18 +346,43 @@ Floor, Boston, MA 02110-1301 USA.
\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
-% @registeredsymbol - R in a circle. The font for the R should really
-% be smaller yet, but lllsize is the best we can do for now.
-% Adapted from the plain.tex definition of \copyright.
-%
+% @registeredsymbol - R in a circle.
\def\registeredsymbol{%
$^{{\ooalign{\hfil\raise.07ex\hbox{\fiverm R}%
\hfil\crcr\Orb}}%
}$%
}
-\font\eurosym = feybr10 at 8pt
-\def\euro{{\eurosym e}}
+\def\ordf{\leavevmode\raise1ex\hbox{\fiverm \underbar{a}}}
+\def\ordm{\leavevmode\raise1ex\hbox{\fiverm \underbar{o}}}
+
+\font\eurofont = feybr10 at 8pt
+\def\euro{{\eurofont e}}
+
+\font\ecfont = ecrm0800
+\def\DH{{\ecfont \char"D0}} % Eth
+\def\dh{{\ecfont \char"F0}} % eth
+\def\TH{{\ecfont \char"DE}} % Thorn
+\def\th{{\ecfont \char"FE}} % thorn
+\def\guillemetleft{{\ecfont \char"13}}
+\def\guillemotleft{\guillemetleft}
+\def\guillemetright{{\ecfont \char"14}}
+\def\guillemotright{\guillemetright}
+\def\guilsinglleft{{\ecfont \char"0E}}
+\def\guilsinglright{{\ecfont \char"0F}}
+\def\quotedblbase{{\ecfont \char"12}}
+\def\quotesinglbase{{\ecfont \char"0D}}
+\def\ogonek#1{{%
+ \ecfont \setbox0=\hbox{#1}%
+ \ifdim\ht0=1ex\accent"0C #1%
+ \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
+ \fi
+}}
+% normal quotes
+\def\quoteleft{`}
+\def\quoteright{'}
+\def\quotedblleft{``}
+\def\quotedblright{''}
%**end of header
@@ -372,12 +400,12 @@ Texinfo source files are plain text; standard extensions are
begin with lines like this:
{\advance\baselineskip by -3pt
-\code{\bschar input texinfo}\hfil\break
-\code{@setfilename {\sl info-file-name}}\hfil\break
+\code{\bschar input texinfo}\linebreak
+\code{@setfilename {\sl info-file-name}}\linebreak
\code{@settitle {\sl name-of-manual}}}
-\dots the contents of the Texinfo document follow,
-ending with:\hfil\break
+\dots the contents of the Texinfo document,
+ending with:\linebreak
\code{@bye}
@@ -390,12 +418,15 @@ which they conventionally appear.
\txicmd{@setfilename}{info-file-name}{Provide a name to be used for the output files. This command is essential for \TeX\ formatting as well, even though it produces no output. Should be the first command in the input.}
\txicmd{@settitle}{title}{Specify document \var{title}.}
+\txicmd{@copying}{}{Specify copyright and licensing text. Pair with \code{@end copying}.}
+\txicmd{@insertcopying}{}{Insert text defined by \code{@copying}.}
\subsection{Internationalization}
\txicmd{@documentencoding}{enc}{Declare the input encoding to be \var{enc}; use right after \code{@setfilename}. Default is \code{US-ASCII}; other possibilities: \code{UTF-8}, \code{ISO-8859-1}, \code{koi8-r}, \dots}
\txicmd{@documentlanguage}{LL\rmbrack[\code{_}CC]}{Declare the current language as the two-character \acro{ISO}-639 abbreviation \var{LL}, optionally followed by an underscore and a two-letter \acro{ISO} 3166 two-letter country code (\var{CC}). Default is \code{en_US}.}
+\txicmd{@frenchspacing}{\code{on|off}}{Control spacing after punctuation.}
\subsection{Info directory specifications}
@@ -403,7 +434,7 @@ which they conventionally appear.
\txicmd{@dircategory}{category name}{Specify an Info directory section for this file's entries. Can be repeated. We try to follow the categories in the Free Software Directory.}
\txicmd{@direntry}{}{Begin the Info directory menu entries for this file. Pair with \tt @end direntry.}
-\subsection{HTML document description}
+\subsection{\acro{HTML} document description}
\txicmd{@documentdescription}{}{Set the document description text for \acro{HTML}; default is just the title of the document. Pair with \code{@end documentdescription}.}
@@ -429,12 +460,9 @@ which they conventionally appear.
\section{Nodes}
-\txicmd{@node}{name, next, previous, up}{Begin a new node. The \var{next}, \var{previous}, and \var{up} pointers are usually omitted in a normally-structured document.}
-
+\txicmd{@node}{name\rmbrack[, next, previous, up]}{Begin a new node. The \var{next}, \var{previous}, and \var{up} pointers are usually omitted in a normally-structured document.}
\txicmd{@top}{title}{Mark the topmost \code{@node} in the file, which must be defined on the line immediately preceding \code{@top}. The \var{title} is formatted as a chapter-level heading. The entire top node, including the \code{@node} and \code{@top} lines, are normally enclosed with \code{@ifnottex ... @end ifnottex}.}
-
\txicmd{@anchor}{\ttbraced{\var{name}}}{Define \var{name} as the current location, for use as a cross-reference target.}
-
\txicmd{@novalidate}{}{Suppress validation of node references and omit creation of auxiliary files with \TeX. Use before \code{@setfilename}.}
@@ -442,6 +470,7 @@ which they conventionally appear.
\txicmd{@lowersections}{}{Change subsequent chapters to sections, sections to subsections, and so on.}
\txicmd{@raisesections}{}{Change subsequent sections to chapters, subsections to sections, and so on.}
+\txicmd{@part}{title}{Print part page, beginning a group of chapters; included in contents.}
\subsection{Numbered, included in contents}
@@ -491,6 +520,7 @@ which they conventionally appear.
\txicmd{@pxref}{\ttbraced{node, \rmbrack[entry], \rmbrack[node-title], \rmbrack[info-file], \rmbrack[manual]}}{Like \code{@xref}, but starts with `see' instead of `See', and must be used inside parentheses.}
\txicmd{@ref}{\ttbraced{node, \rmbrack[entry], \rmbrack[node-title], \rmbrack[info-file], \rmbrack[manual]}}{Like \code{@xref}, but produces only the bare reference without `See' or `see'; must be followed by a punctuation mark.}
\txicmd{@inforef}{\ttbraced{node, \rmbrack[entry-name], info-file}}{Make a cross reference to an Info file for which there is no printed manual.}
+\txicmd{@xrefautomaticsectiontitle}{\code{on|off}}{By default, use the section title instead of the node name in cross references.}
\subsection{Outside of Info}
@@ -498,7 +528,7 @@ which they conventionally appear.
\txicmd{@cite}{\ttbraced{title}}{Indicate the name of a book or other reference that has no Info file; no hyperlink.}
-\section{Marking words and phrases}
+\section{Marking text}
\subsection{Markup for regular text}
@@ -523,6 +553,21 @@ which they conventionally appear.
\txicmd{@samp}{\ttbraced{text}}{Indicate a sequence of literal characters, in general. Quoted in Info output.}
\txicmd{@verb}{\ttbraced{delimchar literal-text delimchar}}{Output \var{literal-text}, delimited by the single character \var{delimchar}, exactly as is, including any whitespace or Texinfo special characters. Example: \code{@verb\ttbraced{|@ @\rbracechar|}}.}
+\subsection{GUI sequences}
+
+\txicmd{@clicksequence}{\ttbraced{action \code{@click\ttbraced{}} \var{action} \dots}}{Represent a sequence of \acro{GUI} actions or clicks.}
+\txicmd{@click}{\ttbraced{}}{Represent a single `click' in a \code{@clicksequene}.}
+\txicmd{@clickstyle}{\code{@}cmd}{Execute \var{@cmd} for each \code{@click}; default is \code{@arrow}. Empty braces usually following \code{@\var{cmd}} are omitted here.}
+\txicmd{@arrow}{\ttbraced{}}{Insert a right arrow glyph, $\rightarrow$.}
+
+\subsection{Math}
+
+\txicmd{@math}{\ttbraced{math}}{Format the given math (inline); \bschar{} becomes an escape character, and all \TeX\ math is available.}
+\txicmd{@minus}{\ttbraced{}}{Insert a minus sign, `$-$'.}
+\txicmd{@\bschar}{}{Inside \code{@math}, insert a math backslash, $\backslash$.}
+\txicmd{@geq}{\ttbraced{}}{Insert a greater-than-or-equal sign, $\geq$.}
+\txicmd{@leq}{\ttbraced{}}{Insert a less-than-or-equal sign, $\leq$.}
+
\subsection{Explicit font selection}
\txicmd{@sc}{\ttbraced{text}}{Set \var{text} in a small caps font in printed output, and uppercase in Info. No other font command has any effect in Info.}
@@ -534,29 +579,44 @@ which they conventionally appear.
\txicmd{@t}{\ttbraced{text}}{Set \var{text} in a fixed-width, typewriter-like font.}
-\section{Quotation and example environments}
+\section{Block environments}
-`Environments' in Texinfo begin with an \code{@\var{envname}} on a line
-of its own and continue through the following lines of input until a
+`Environments' in Texinfo begin with \code{@\var{envname}} on a line of
+its own and continue through the following lines of input until the
corresponding \code{@end \var{envname}} is seen.
\txicmd{@noindent}{}{Omit the normal indentation when starting a new paragraph; often used after environments.}
+\txicmd{@indent}{}{Insert normal paragraph indentation.}
\txicmd{@exdent}{line-of-text}{Output \var{line-of-text} without any indentation.}
-\txicmd{@cartouche}{}{Highlight an example or quotation by drawing a box with rounded corners around it. Pair with \code{@end cartouche}. No effect in Info.}
+\txicmd{@cartouche}{}{Highlight a block of text by drawing a box with rounded corners around it. Pair with \code{@end cartouche}. No effect in Info.}
+
+\subsection{Normally-filled displays using regular text fonts}
+
+In these environments, the input is automatically rebroken into lines of
+output as usual.
-\subsection{Displays in regular text fonts}
+\txicmd{@quotation}{}{Fill text, indent on both left and right, retain
+normal text font. Often used for quoting text. Pair with \code{@end quotation}.}
+\txicmd{@smallquotation}{}{Like \code{@quotation}, but select a smaller (text) font where possible. Pair with \code{@end quotation}.}
+\txicmd{@indentedblock}{}{Fill text, indent on left (but not right), retain normal text font. Pair with \code{@end indentedblock}.}
+\txicmd{@smallindentedblock}{}{Like \code{@indentedblock}, but select a smaller (text) font where possible. Pair with \code{@end smallindentedblock}.}
+\txicmd{@raggedright}{}{Leave right end ragged, but otherwise fill text; retain normal text font. Pair with \code{@end raggedright}.}
-\txicmd{@format}{}{Begin formatted text: do not fill text; retain normal
-margins and normal text font. Pair with \code{@end format}.}
+\subsection{Line-for-line displays using regular text fonts}
+
+In these environments, each line of input is a line of output.
+
+\txicmd{@format}{}{Begin formatted text: do not fill, retain normal margins and normal text font. Pair with \code{@end format}.}
\txicmd{@smallformat}{}{Like \code{@format}, but select a smaller (text) font where possible. Pair with \code{@end smallformat}.}
-\txicmd{@display}{}{Begin displayed text: do not fill, and indent text; retain normal text font. Pair with \code{@end display}.}
+\txicmd{@display}{}{Begin displayed text: do not fill, but indent text on left; retain normal text font. Pair with \code{@end display}.}
\txicmd{@smalldisplay}{}{Like \code{@display}, but select a smaller (text) font where possible. Pair with \code{@end smalldisplay}.}
-\txicmd{@flushleft}{}{Left justify lines: do not fill text, retain normal margins and normal text font. Pair with \code{@end flushleft}.}
+\txicmd{@flushleft}{}{Left justify lines, leaving the right end ragged: do not fill text, retain normal margins and normal text font. Pair with \code{@end flushleft}.}
\txicmd{@flushright}{}{Right justify lines, leaving the left end ragged: do not fill text, retain normal margins and normal text font. Pair with \code{@end flushright}.}
-\txicmd{@quotation}{}{Narrow both margins to indicate text that is quoted from another work; do normal line breaking and retain normal font. Takes optional argument of prefix text. Pair with \code{@end quotation}.}
\subsection{Displays using fixed-width fonts}
+In these environments also, each line of input is a line of output.
+
\txicmd{@example}{}{Begin an example. Indent text, do not fill, and select fixed-width font. Pair with \code{@end example}.}
\txicmd{@smallexample}{}{Like \code{@example}, but where possible, print text in a smaller font. Pair with \code{@end smallexample}.}
\txicmd{@lisp}{}{Like \code{@example}, but specifically for an example of Lisp code. Pair with \code{@end lisp}.}
@@ -576,19 +636,20 @@ margins and normal text font. Pair with \code{@end format}.}
\txicmd{@item}{}{Begin an item for the list and table commands.}
\txicmd{@itemx}{}{Used only with \code{@table}. Like \code{@item} but do not generate extra preceding vertical space. When several items have the same description, use \code{@item} for the first and \code{@itemx} for the rest.}
\txicmd{@headitem}{}{Used only for multitables. Like \code{@item}, but indicates a heading row.}
+\txicmd{@headitemfont}{\ttbraced{text}}{Set \var{text} in the heading row font.}
\txicmd{@asis}{text}{Prints \var{text} as-is; used as \var{formatting-command} for tables when no highlighting is desired.}
\section{Floating displays}
-\txicmd{@float}{}{Environment within which floating material is defined. Pair with \code{@end float}.}
-\txicmd{@listoffloats}{}{Produce a list of floats for a given float type.}
+\txicmd{@float}{}{Environment enclosing material which can float. Pair with \code{@end float}.}
+\txicmd{@listoffloats}{}{Generate a list of floats for a given float type.}
\txicmd{@caption}{}{Define the full caption for a \code{@float} anywhere in the float environment.}
\txicmd{@shortcaption}{}{Define the short caption for a \code{@float}, used in the list of floats.}
\txicmd{@image}{\ttbraced{filename, \rmbrack[width], \rmbrack[height], \rmbrack[alt], \rmbrack[ext]}}{Include graphics image in external \var{filename} scaled to the given width and/or height, using alt text and looking for \samp{\var{filename}.\var{ext}} first. Can occur inline or by itself on the page.}
\subsection{Footnotes}
-\txicmd{@footnote}{\ttbraced{text-of-footnote}}{Produce a footnote: \var{text-of-footnote} is printed at the bottom of the page by \TeX, while Info and others may format at either (by default) the end of the current node, or in a separate node.}
+\txicmd{@footnote}{\ttbraced{text-of-footnote}}{Insert a footnote: \var{text-of-footnote} is printed at the bottom of the page by \TeX, while Info and others may format at either (by default) the end of the current node, or in a separate node.}
\txicmd{@footnotestyle}{style}{Specify footnote style: \samp{end} or \samp{separate}.}
@@ -611,18 +672,20 @@ margins and normal text font. Pair with \code{@end format}.}
\subsection{Characters special to Texinfo}
-\txicmd{@@}{}{Insert an at sign, `@'.}
-\txicmd{@\lbracechar}{}{Insert a left brace, `$\{$'.}
-\txicmd{@\rbracechar}{}{Insert a right brace, `$\}$'.}
+\txicmd{@@}{, \code{@atchar\ttbraced{}}}{Insert an at sign, `@'.}
+\txicmd{@\lbracechar}{, \code{@lbracechar\ttbraced{}}}{Insert a left brace, `$\{$'.}
+\txicmd{@\rbracechar}{, \code{@rbracechar\ttbraced{}}}{Insert a right brace, `$\}$'.}
+\txicmd{@backslashchar}{\ttbraced{}}{Insert a typewriter backslash, {\tt\char`\\}.}
\txicmd{@comma}{\ttbraced{}}{Insert a comma character; needed only when a literal comma would be an argument separator, as in \code{@xref}.}
+\txicmd{@hashchar}{\ttbraced{}}{Insert a hash character, \#; needed only when a literal hash would introduce a \code{\#line} directive.}
\txicmd{@\var{whitespace}}{}{An \code{@} followed by a space, tab, or newline produces a normal, stretchable, interword space.}
\subsection{Spacing refinements}
\txicmd{@:}{}{Tell \TeX\ to refrain from inserting extra whitespace after an immediately preceding period, question mark, exclamation mark, or colon, as \TeX\ normally would.}
-\txicmd{@.}{}{Produce a period that ends a sentence; typically needed after an end-of-sentence capital letter.}
-\txicmd{@?}{}{Produce a question mark that ends a sentence.}
-\txicmd{@!}{}{Produce an exclamation point that ends a sentence.}
+\txicmd{@.}{}{Insert a period that ends a sentence; typically needed after an end-of-sentence capital letter.}
+\txicmd{@?}{}{Insert a question mark that ends a sentence.}
+\txicmd{@!}{}{Insert an exclamation point that ends a sentence.}
\txicmd{@dmn}{\ttbraced{dimension}}{Format a unit of measure, as in `12\thinspace{}pt'. Causes \TeX\ to insert a thin space before \var{dimension}. No effect in Info.}
\subsection{Accents}
@@ -639,6 +702,7 @@ exception of \code{@tieaccent}.
\txicmd{@\tildechar}{c}{Generate a tilde accent, \~o.}
\txicmd{@dotaccent}{c}{Generate a dot (over) accent, \.o.}
\txicmd{@H}{c}{Generate a long Hungarian umlaut accent, \H o.}
+\txicmd{@ogonek}{c}{Generate an ogonek diacritic, \ogonek{a}.}
\txicmd{@ringaccent}{c}{Generate a ring accent, \accent23o.}
\txicmd{@tieaccent}{\ttbraced{cc}}{Generate a tie-after accent, \t{oo}; argument must be given in braces.}
\txicmd{@u}{c}{Generate a breve accent, \u{o}.}
@@ -650,26 +714,31 @@ exception of \code{@tieaccent}.
\txicmd{@AA\txicmdarg{\ttbraced{}}, @aa}{\ttbraced{}}{Generate uppercase \AA\ and lowercase \aa.}
\txicmd{@AE\txicmdarg{\ttbraced{}}, @ae}{\ttbraced{}}{Generate uppercase \AE\ and lowercase \ae.}
+\txicmd{@DH\txicmdarg{\ttbraced{}}, @dh}{\ttbraced{}}{Generate uppercase \DH\ and lowercase \dh.}
\txicmd{@L\txicmdarg{\ttbraced{}}, @l}{\ttbraced{}}{Generate uppercase \L\ and lowercase \l.}
\txicmd{@O\txicmdarg{\ttbraced{}}, @o}{\ttbraced{}}{Generate uppercase \O\ and lowercase \o.}
\txicmd{@OE\txicmdarg{\ttbraced{}}, @oe}{\ttbraced{}}{Generate uppercase \OE\ and lowercase \oe.}
+\txicmd{@TH\txicmdarg{\ttbraced{}}, @th}{\ttbraced{}}{Generate uppercase \TH\ and lowercase \th.}
+\txicmd{@dotless}{\ttbraced{\code{i|j}}}{Generate dotless \i\ and \j.}
\txicmd{@exclamdown}{\ttbraced{}}{Generate an upside-down exclamation point, \raise.4ex\hbox{<}.}
+\txicmd{@ordf\txicmdarg{\ttbraced{}}, @ordm}{\ttbraced{}}{Generate \ordf\ and lowercase \ordm.}
\txicmd{@questiondown}{\ttbraced{}}{Generate an upside-down question mark, \raise.4ex\hbox{?`}.}
\txicmd{@ss}{\ttbraced{}}{Generate the German sharp-S (es-zet) letter, \ss.}
\subsection{Other text characters and logos}
-\txicmd{@dots}{\ttbraced{}}{Generate an ellipsis, `\dots'.}
-\txicmd{@enddots}{\ttbraced{}}{Generate an end-of-sentence ellipsis, `\dots' (more following space in \TeX.)}
-\txicmd{@bullet}{\ttbraced{}}{Generate a large round dot, $\bullet$ (\samp{*} in Info).}
-\txicmd{@euro}{\ttbraced{}}{Generate the Euro currency sign, \euro.}
-\txicmd{@pounds}{\ttbraced{}}{Generate the pounds sterling currency sign, {\it\$}.}
-\txicmd{@minus}{\ttbraced{}}{Generate a minus sign, `$-$'.}
-\txicmd{@copyright}{\ttbraced{}}{Generate the copyright symbol, \copyright.}
-\txicmd{@registeredsymbol}{\ttbraced{}}{Generate the registered symbol, \registeredsymbol.}
-\txicmd{@TeX}{\ttbraced{}}{Generate the \TeX\ logo.}
-\txicmd{@LaTeX}{\ttbraced{}}{Generate the \LaTeX\ logo.}
+\txicmd{@bullet}{\ttbraced{}}{Insert a large round dot, $\bullet$ (\samp{*} in Info).}
+\txicmd{@dots}{\ttbraced{}}{Insert an ellipsis, `\dots'.}
+\txicmd{@enddots}{\ttbraced{}}{Insert an end-of-sentence ellipsis, `\dots' (more following space in \TeX.)}
+\txicmd{@euro}{\ttbraced{}}{Insert the Euro currency sign, \euro.}
+\txicmd{@pounds}{\ttbraced{}}{Insert the pounds sterling currency sign, {\it\$}.}
+\txicmd{@textdegree}{\ttbraced{}}{Insert the degree symbol, $^\circ$.}
+\txicmd{@copyright}{\ttbraced{}}{Insert the copyright symbol, \copyright.}
+\txicmd{@registeredsymbol}{\ttbraced{}}{Insert the registered symbol, \registeredsymbol.}
+\txicmd{@TeX}{\ttbraced{}}{Insert the \TeX\ logo.}
+\txicmd{@LaTeX}{\ttbraced{}}{Insert the \LaTeX\ logo.}
\txicmd{@today}{\ttbraced{}}{Insert the current date, in `1 Jan 2000' style.}
+\txicmd{@guillemetleft\ttbraced{} @guillemetright\ttbraced{} @guillemotleft\ttbraced{} @guillemotright @guilsinglleft\ttbraced{} @guilsinglright\ttbraced{} @quotedblbase\ttbraced{} @quotedblleft @quotedblright\ttbraced{} @quoteleft\ttbraced{} @quoteright\ttbraced{} @quotesinglbase\ttbraced{}}{}{Insert various quotation marks: \guillemetleft\ \guillemetright\ \guillemotleft\ \guillemotright\ \guilsinglleft\ \guilsinglright\ \quotedblbase\ \quotedblleft\ \quotedblright\ \quoteleft\ \quoteright\ \quotesinglbase.}
\subsection{Glyphs for code examples}
@@ -680,25 +749,11 @@ exception of \code{@tieaccent}.
\txicmd{@print}{\ttbraced{}}{Indicate printed output, \print.}
\txicmd{@result}{\ttbraced{}}{Indicate the result of an expression, \result.}
-\subsection{GUI sequences}
-
-\txicmd{@clicksequence}{\ttbraced{action \code{@click\ttbraced{}} \var{action} \dots}}{Represent a sequence of \acro{GUI} actions or clicks.}
-\txicmd{@click}{\ttbraced{}}{Represent a single `click' in a \code{@clicksequene}.}
-\txicmd{@clickstyle}{\code{@}cmd}{Execute \var{@cmd} for each \code{@click}; default is \code{@arrow}. Empty braces usually following \code{@\var{cmd}} are omitted here.}
-\txicmd{@arrow}{\ttbraced{}}{Generate a right arrow glyph, $\rightarrow$.}
-
-\subsection{Math}
-
-\txicmd{@math}{\ttbraced{math}}{Format the given math (inline); \bschar{} becomes an escape character, and all \TeX\ math is available.}
-\txicmd{@\bschar}{}{Inside \code{@math}, generate a backslash, $\backslash$.}
-\txicmd{@geq}{\ttbraced{}}{Generate a greater-than-or-equal sign, $\geq$.}
-\txicmd{@leq}{\ttbraced{}}{Generate a less-than-or-equal sign, $\leq$.}
-
\section{Making and preventing breaks}
\txicmd{@*}{}{Force a line break.}
-\txicmd{@/}{}{Produces no output, but allows a line break.}
+\txicmd{@/}{}{Generates no output, but allows a line break.}
\txicmd{@-}{}{Insert a discretionary hyphenation point.}
\txicmd{@hyphenation}{\ttbraced{hy-phen-a-ted words}}{Explicitly define hyphenation points.}
\txicmd{@tie}{\ttbraced{}}{Generate a normal interword space at which a line break is not allowed.}
@@ -710,7 +765,7 @@ exception of \code{@tieaccent}.
\txicmd{@sp}{n}{Skip \var{n} blank lines.}
\txicmd{@page}{}{Start a new page in a printed manual. Ignored in other formats.}
\txicmd{@need}{mils}{Start a new page in a printed manual if fewer than \var{mils} thousandths of an inch remain on the current page. Ignored in other formats.}
-\txicmd{@group}{}{Disallow page breaks in following text. Pair with \code{@end group}. Ignored in other formats.}
+\txicmd{@group}{\dots\code{@end group}}{In \TeX\ output, disallow page breaks in enclosed text; ignored otherwise.}
\txicmd{@vskip}{amount}{In a printed manual, insert whitespace \var{amount}. Ignored in other formats.}
@@ -719,8 +774,7 @@ exception of \code{@tieaccent}.
The \code{...x} variant of each command is analogous to \code{@itemx},
leaving no extra space above. All definition commands must be written
entirely on one line. Multiword arguments must be enclosed in braces.
-Descriptive text is on the following lines, ended by \samp{@end
-\var{defcmdname}}.
+Descriptive text follows, ended by \samp{@end \var{defcmdname}}.
\subsection{Function-like definitions, untyped}
@@ -767,40 +821,52 @@ Descriptive text is on the following lines, ended by \samp{@end
\section{Conditionally (in)visible text}
\txicmd{@comment}{comment}{Begin a comment in Texinfo. The rest of the line is not visible in any output.}
-\txicmd{@c}{comment}{Synonym for \code{@comment}.}
-\txicmd{@ignore}{}{Begin text that will not appear in any output. Pair with \code{@end ignore}.}
+\txicmd{@c}{comment}{Synonym for \code{@comment}. \code{DEL} also starts a comrment.}
+\txicmd{@ignore}{\dots\code{@end ignore}}{Text that will not appear in any output.}
\subsection{Output formats}
-\txicmd{@ifdocbook}{}{Begin text to appear only in Docbook output. Pair with \code{@end ifdocbook}.}
-\txicmd{@ifhtml}{}{Begin text to appear only in HTML output. Pair with \code{@end ifhtml}.}
-\txicmd{@ifinfo}{}{Begin text to appear in both Info and (for historical compatibility) plain text output. Pair with \code{@end ifinfo}.}
-\txicmd{@ifplaintext}{}{Begin text to appear only in plain text output. Pair with \code{@end ifplaintext}.}
-\txicmd{@iftex}{}{Begin text to appear only in the \TeX\ output. Pair with \code{@end iftex}.}
-\txicmd{@ifxml}{}{Begin text that will appear only in the XML output. Pair with \tt @end ifxml.}
-\txicmd{@ifnotdocbook, @ifnothtml, @ifnotplaintext, @ifnottex, @ifnotxml}{}{Begin text to be ignored in one output format but not the others: \code{@ifnothtml} text is omitted from HTML output, etc. Pair with the corresponding \code{@end ifnot\var{format}}.}
-\txicmd{@ifnotinfo}{}{Like the other \code{@ifnot\dots} commands, but omit from plain text output as well as Info. Pair with \code{@end ifnotinfo}.}
+\txicmd{@ifdocbook}{\dots\code{@end ifdocbook}}{Texinfo text to appear only in Docbook output.}
+\txicmd{@ifhtml}{\dots\code{@end ifhtml}}{Text to appear only in \acro{HTML} output.}
+\txicmd{@ifinfo}{\dots\code{@end ifinfo}}{Text to appear in both Info and (for historical compatibility) plain text output.}
+\txicmd{@ifplaintext}{\dots\code{@end ifplaintext}}{Text to appear only in plain text output.}
+\txicmd{@iftex}{\dots\code{@end iftex}}{Text to appear only in the \TeX\ output.}
+\txicmd{@ifxml}{\dots\code{@end ifxml}}{Text to appear only in \acro{XML} output.}
+\txicmd{@ifnotdocbook @ifnothtml @ifnotplaintext @ifnottex @ifnotxml}{\dots\code{@end ifnot\var{format}}}{Begin text to be ignored in one output format but no others: \code{@ifnothtml} text is omitted from \acro{HTML} output, etc.}
+\txicmd{@ifnotinfo}{\dots\code{@end ifnotinfo}}{Like the other \code{@ifnot\dots} commands, but omit from plain text output as well as Info.}
+\txicmd{@inlinefmt}{\ttbraced{format, text}}{Include Texinfo \var{text} only in \var{format} output.}
+\txicmd{@inlinefmtifelse}{\ttbraced{format, then-text, else-text}}{Include either \var{then-text} or \var{else-text} according to whether \var{format} is being output.}
\subsection{Raw formatter text}
-\txicmd{@docbook}{}{Enter Docbook completely. Pair with \code{@end docbook}.}
-\txicmd{@html}{}{Enter \acro{HTML} completely. Pair with \code{@end html}.}
-\txicmd{@tex}{}{Enter \TeX\ completely (e.g., \bschar\ becomes an escape character). Pair with \code{@end tex}.}
-\txicmd{@xml}{}{Enter \acro{XML} completely. Pair with \code{@end xml}.}
+\txicmd{@docbook}{\dots\code{@end docbook}}{Enter Docbook completely.}
+\txicmd{@html}{\dots\code{@end html}}{Enter \acro{HTML} completely.}
+\txicmd{@tex}{\dots\code{@end tex}}{Enter \TeX\ completely (e.g., \bschar\ becomes an escape character).}
+\txicmd{@xml}{\dots\code{@end xml}}{Enter \acro{XML} completely.}
+\txicmd{@inlineraw}{\ttbraced{format, text}}{Include raw \var{text} only in \var{format} output.}
\subsection{Document variables}
\txicmd{@set}{name \rmbrack[string]}{Define the Texinfo variable \var{name}, optionally to the value \var{string}.}
-\txicmd{@clear}{name}{Undefine the Texinfo variable \var{name}.}
-\txicmd{@value}{\ttbraced{name}}{Insert the value of the Texinfo variable \var{name}.}
-\txicmd{@ifset}{name}{If the Texinfo variable \var{name} is set, format the following text. Pair with \code{@end ifset}.}
-\txicmd{@ifclear}{flag}{If the Texinfo variable \var{name} is not set, format the following text. Pair with \code{@end ifclear}.}
+\txicmd{@clear}{name}{Undefine \var{name}.}
+\txicmd{@value}{\ttbraced{name}}{Insert the value of \var{name}.}
+\txicmd{@ifset}{name \dots\code{@end ifset}}{If \var{name} is set, format enclosed text.}
+\txicmd{@ifclear}{name \dots\code{@end ifclear}}{If \var{name} is not set, format enclosed text.}
+\txicmd{@inlineifset}{\ttbraced{name, text}}{If \var{name} is set, format \var{text}.}
+\txicmd{@inlineifclear}{\ttbraced{name, text}}{If \var{name} is notset, format \var{text}.}
+
+\subsection{Testing for commands}
+
+\txicmd{@ifcommanddefined}{\var{cmd} \dots\code{@end ifcommanddefined}}{\linebreak Text to appear only if \code{@}\var{cmd} is defined \dots}
+\txicmd{@ifcommandnotdefined}{\var{cmd} \dots\code{@end ifcommandnotdefined}}{\linebreak\dots\ or not defined.}
+\txicmd{txicommandconditionals}{}{Texinfo variable predefined to true.}
\section{Defining new Texinfo commands}
\txicmd{@alias}{new\code{=}existing}{Make the command \code{@new} a synonym for the existing command \code{@existing}.}
-\txicmd{@macro}{macroname \ttbraced{\var{params}}}{Define a new Texinfo command \code{@\var{macroname}}. Pair with \code{@end macro}.}
+\txicmd{@macro}{macroname \ttbraced{\var{params}} \dots\code{@end macro}}{Define a new Texinfo command \code{@\var{macroname}}.}
+\txicmd{@unmacro}{macroname}{Undefine \code{@\var{macroname}} if it is defined.}
\txicmd{@definfoenclose}{newcmd\code{,} before\code{,} after}{Can only be used within \code{@ifinfo}; create a new command that encloses its argument in the \var{before} and \var{after} strings.}
@@ -812,16 +878,17 @@ Descriptive text is on the following lines, ended by \samp{@end
\section{Formatting and headers/footers for \TeX}
-\txicmd{@finalout}{}{Tell \TeX\ to omit the large black rectangles beside over-wide lines.}
+\txicmd{@allowcodebreaks}{\code{true|false}}{Control breaks at \code{-} and \code{_} in \TeX; default true.}
+\txicmd{@finalout}{}{Omit large black rectangles at overfull lines in \TeX\ output.}
+\txicmd{@fonttextsize}{\code{10|11}}{Change size of main body font in \TeX.}
\subsection{Paper sizes}
-\def\inch{$''$xx}
-The default paper size is \acro{US} letter-size, 8x11\inch.
+The default paper size is \acro{US} letter-size, 8x11in.
-\txicmd{@smallbook}{}{Format for a 7x9.25\inch\ trim size.}
+\txicmd{@smallbook}{}{Format for a 7x9.25in trim size.}
\txicmd{@afourpaper, @afivepaper}{}{Format for A4 and A5 paper sizes.}
-\txicmd{@afourlatex}{}{A variant for A4 with more whitespace.}
+\txicmd{@afourlatex}{}{Variant for A4 with more whitespace.}
\txicmd{@afourwide}{}{Format for A4 in landscape.}
\txicmd{@pagesizes}{\rmbrack[{width{\small][}, height}]}{Format for the explicitly given page dimensions, \var{width} by \var{height}.}
@@ -844,84 +911,35 @@ The default paper size is \acro{US} letter-size, 8x11\inch.
\section{Document preferences}
It is usually best to omit any of these settings from the Texinfo
-document, thus allowing users to override the defaults when processing
-the document according to their needs.
+document, thus allowing users to easily override the defaults when
+processing the document according to their desires.
-\txicmd{@setchapternewpage}{\code{on|off|odd}}{Specify whether chapters start on new pages, and if so, whether on odd-numbered (right-hand) new pages; also set the page headings accordingly.}
+\txicmd{@codequoteundirected}{\code{on|off}}{Use undirected single quote for \code{'}; default off.}
+\txicmd{@codequotebacktick}{\code{on|off}}{Use backtick (standalone grave accent) for \code{`}; default off.}
+\txicmd{@deftypefnnewline}{\code{on|off}}{Put return type on a line by itself; default off.}
+\txicmd{@exampleindent}{indent}{Indent example-like environments by \var{indent} number of spaces (perhaps 0).}
+\txicmd{@firstparagraphindent}{\code{insert|none}}{Indent first paragraphs after section headings, or not.}
\txicmd{@headings}{\code{on|off|single|double}}{Turn page headings on or off, specify single-sided or double-sided page headings for printing.}
+\txicmd{@kbdinputstyle}{\code{code|distinct|example}}{Specify font for \code{@kbd}: normal \code{@code} font, a distinct (slanted) typewriter font, or a distinct font only within \code{@example} and similar.}
\txicmd{@paragraphindent}{indent}{Indent paragraphs by \var{indent} number of spaces (perhaps 0); preserve source file indentation if \var{indent} is the string \code{asis}.}
-\txicmd{@exampleindent}{indent}{Indent example-like environments by \var{indent} number of spaces (perhaps 0).}
-\txicmd{@kbdinputstyle}{style}{Specify when \code{@kbd} should use a font distinct from \code{@code}.}
+\txicmd{@setchapternewpage}{\code{on|off|odd}}{Specify whether chapters start on new pages, and if so, whether on odd-numbered (right-hand) new pages; also set page headings accordingly.}
+\txicmd{@urefbreakstyle}{\code{after|before|none}}{Specify how \code{@uref} should break at special characters; default \code{after}.}
+
\section{Ending a Texinfo document}
\txicmd{@bye}{}{End reading the Texinfo source. Any following text in the file is ignored.}
+\smallskip Finally, this meta-command doesn't fit anywhere else:
+\txicmd{@errormsg}{\ttbraced{msg}}{Report \var{msg} as an error.}
+
-\chapter{Editing Texinfo sources in Emacs}
-
-The Texinfo major mode in GNU Emacs is for editing Texinfo source files.
-To enter Texinfo mode, visit a source file with one of the supported
-extensions. This list of mode commands is from Emacs 22.1.
-
-\key{C-c C-s}{texinfo-show-structure}
-\key{C-c ]}{up-list}
-\key{C-c \rbracechar}{up-list}
-
-\key{"}{texinfo-insert-quote}
-\key{M-RET}{texinfo-insert-@item}
-\key{C-c C-o}{texinfo-insert-block}
-\key{C-c \lbracechar}{texinfo-insert-braces}
-\key{C-c C-c C-d}{texinfo-start-menu-description}
-\key{C-c C-c C-e}{texinfo-insert-@emph}
-\key{C-c C-c C-s}{texinfo-insert-@strong}
-\key{C-c C-c c}{texinfo-insert-@code}
-\key{C-c C-c d}{texinfo-insert-@dfn}
-\key{C-c C-c e}{texinfo-insert-@end}
-\key{C-c C-c f}{texinfo-insert-@file}
-\key{C-c C-c i}{texinfo-insert-@item}
-\key{C-c C-c k}{texinfo-insert-@kbd}
-\key{C-c C-c m}{texinfo-insert-@email}
-\key{C-c C-c n}{texinfo-insert-@node}
-\key{C-c C-c o}{texinfo-insert-@noindent}
-\key{C-c C-c q}{texinfo-insert-@quotation}
-\key{C-c C-c s}{texinfo-insert-@samp}
-\key{C-c C-c t}{texinfo-insert-@table}
-\key{C-c C-c u}{texinfo-insert-@uref}
-\key{C-c C-c v}{texinfo-insert-@var}
-\key{C-c C-c x}{texinfo-insert-@example}
-
-\key{C-c C-u C-a}{texinfo-all-menus-update}
-\key{C-c C-u C-e}{texinfo-every-node-update}
-\key{C-c C-u RET}{texinfo-make-menu}
-\key{C-c C-u C-n}{texinfo-update-node}
-\key{C-c C-u m}{texinfo-master-menu}
-
-\key{C-c C-e C-b}{texinfo-format-buffer}
-\key{C-c C-e C-r}{texinfo-format-region}
-
-\key{C-c RET C-b}{makeinfo-buffer}
-\key{C-c RET C-k}{kill-compilation}
-\key{C-c RET C-l}{makeinfo-recenter-compilation-buffer}
-\key{C-c RET C-r}{makeinfo-region}
-\key{M-TAB}{ispell-complete-word}
-
-\key{C-c C-t C-b}{texinfo-tex-buffer}
-\key{C-c C-t C-d}{texinfo-delete-from-print-queue}
-\key{C-c C-t TAB}{texinfo-texindex}
-\key{C-c C-t C-k}{tex-kill-job}
-\key{C-c C-t C-l}{tex-recenter-output-buffer}
-\key{C-c C-t C-p}{texinfo-tex-print}
-\key{C-c C-t C-q}{tex-show-print-queue}
-\key{C-c C-t C-r}{texinfo-tex-region}
-\key{C-c C-t C-v}{texinfo-tex-view}
-\key{C-c C-t C-x}{texinfo-quit-job}
\chapter{Reading Info files}
There are two main Info readers: \code{M-x info} (\code{C-h i}) in GNU
Emacs, and the standalone \code{info} program. These basic keystrokes
-are for standalone Info, but most work in Emacs Info as well.
+work in both.
\begininfokeys %
\infokey q Quit Info altogether.\cr
@@ -931,7 +949,7 @@ are for standalone Info, but most work in Emacs Info as well.
\infokey Down Move down one line.\cr
\infokey DEL Scroll backward one screenful.\cr
\infokey SPC Scroll forward one screenful.\cr
-\infokey Home Go to the beginning of this node.\cr
+\infokey Home,b Go to the beginning of this node.\cr
\infokey End Go to the end of this node.\cr
\infokey TAB Skip to the next hypertext link.\cr
@@ -949,7 +967,7 @@ are for standalone Info, but most work in Emacs Info as well.
\infokey 1...9 Pick the first...ninth item in this node's menu.\cr
\infokey 0 Pick the last item in this node's menu.\cr
\infokey m Pick a menu item specified by name.\cr
-\infokey r Follow a cross reference specified by name.\cr
+\infokey f Follow a cross reference specified by name.\cr
\infokey g Go to a node specified by name.\cr
\infokey s Search forward for a specified string.\cr
@@ -957,11 +975,12 @@ are for standalone Info, but most work in Emacs Info as well.
\infokey \rbracechar{} Search for next occurrence.\cr
\infokey i Search for a specified string in the index, and\cr
\infokey {} select the node referenced by the first entry found.\cr
+\infokey I Synthesize menu of matching index entries.\cr
\infokey C-g Cancel the current operation.\cr
\endinfokeys
-The Texinfo reference manual is available via \code{info texinfo}\hfil\break
+The Texinfo reference manual is available via \code{info texinfo}\linebreak
(and at \code{http://www.gnu.org/software/texinfo/manual}).
\copyrightnotice