xref: /netbsd-src/external/gpl3/gcc.old/dist/gcc/doc/include/gcc-common.texi (revision 8feb0f0b7eaff0608f8350bbfa3098827b4bb91b)
1*8feb0f0bSmrg@c Copyright (C) 2001-2020 Free Software Foundation, Inc.
236ac495dSmrg@c This is part of the GCC manual.
336ac495dSmrg@c For copying conditions, see the file gcc.texi.
436ac495dSmrg
536ac495dSmrg@c Version number and development mode.
636ac495dSmrg@c version-GCC is @set to the base GCC version number.
736ac495dSmrg@c DEVELOPMENT is @set for an in-development version, @clear for a
836ac495dSmrg@c release version (corresponding to ``experimental''/anything else
936ac495dSmrg@c in gcc/DEV-PHASE).
1036ac495dSmrg
1136ac495dSmrg@include gcc-vers.texi
1236ac495dSmrg
1336ac495dSmrg@c Common macros to support generating man pages:
1436ac495dSmrg
1536ac495dSmrg@macro gcctabopt{body}
1636ac495dSmrg@code{\body\}
1736ac495dSmrg@end macro
1836ac495dSmrg@macro gccoptlist{body}
1936ac495dSmrg@smallexample
2036ac495dSmrg\body\
2136ac495dSmrg@end smallexample
2236ac495dSmrg@end macro
2336ac495dSmrg@c Makeinfo handles the above macro OK, TeX needs manual line breaks;
2436ac495dSmrg@c they get lost at some point in handling the macro.  But if @macro is
2536ac495dSmrg@c used here rather than @alias, it produces double line breaks.
2636ac495dSmrg@iftex
2736ac495dSmrg@alias gol = *
2836ac495dSmrg@end iftex
2936ac495dSmrg@ifnottex
3036ac495dSmrg@macro gol
3136ac495dSmrg@end macro
3236ac495dSmrg@end ifnottex
3336ac495dSmrg
3436ac495dSmrg@c For FSF printing, define FSFPRINT.  Also update the ISBN and last
3536ac495dSmrg@c printing date for the manual being printed.
3636ac495dSmrg@c @set FSFPRINT
3736ac495dSmrg@ifset FSFPRINT
3836ac495dSmrg@smallbook
3936ac495dSmrg@finalout
4036ac495dSmrg@c Cause even numbered pages to be printed on the left hand side of
4136ac495dSmrg@c the page and odd numbered pages to be printed on the right hand
4236ac495dSmrg@c side of the page.  Using this, you can print on both sides of a
4336ac495dSmrg@c sheet of paper and have the text on the same part of the sheet.
4436ac495dSmrg
4536ac495dSmrg@c The text on right hand pages is pushed towards the right hand
4636ac495dSmrg@c margin and the text on left hand pages is pushed toward the left
4736ac495dSmrg@c hand margin.
4836ac495dSmrg@c (To provide the reverse effect, set bindingoffset to -0.75in.)
4936ac495dSmrg@tex
5036ac495dSmrg\global\bindingoffset=0.75in
5136ac495dSmrg\global\normaloffset =0.75in
5236ac495dSmrg@end tex
5336ac495dSmrg@end ifset
5436ac495dSmrg
5536ac495dSmrg@c Macro to generate a "For the N.N.N version" subtitle on the title
5636ac495dSmrg@c page of TeX documentation.  This macro should be used in the
5736ac495dSmrg@c titlepage environment after the title and any other subtitles have
5836ac495dSmrg@c been placed, and before any authors are placed.
5936ac495dSmrg@macro versionsubtitle
6036ac495dSmrg@ifclear DEVELOPMENT
6136ac495dSmrg@subtitle For @sc{gcc} version @value{version-GCC}
6236ac495dSmrg@end ifclear
6336ac495dSmrg@ifset DEVELOPMENT
6436ac495dSmrg@subtitle For @sc{gcc} version @value{version-GCC} (pre-release)
6536ac495dSmrg@end ifset
6636ac495dSmrg@ifset VERSION_PACKAGE
6736ac495dSmrg@sp 1
6836ac495dSmrg@subtitle @value{VERSION_PACKAGE}
6936ac495dSmrg@end ifset
7036ac495dSmrg@c Even if there are no authors, the second titlepage line should be
7136ac495dSmrg@c forced to the bottom of the page.
7236ac495dSmrg@vskip 0pt plus 1filll
7336ac495dSmrg@end macro
74