Fixes on typos, cleanup to improve parsing by other tools than texinfo

* Remove section 3.15: Predefined compilation variables, that is a duplicate of another section.
* Syncronized -> synchronized
* Fix duplicate section names 7.8.12.4 and 7.8.12.5 DISPLAY data-item, so that refs correctly work
* Other small typos



git-svn-id: svn+ssh://svn.code.sf.net/p/gnucobol/code/external-doc@5176 ed166372-6744-4ac0-a67f-bb1ae9efa102

Author: lefessan

guide/1.texi

@@ -142,7 +142,7 @@ The reality is, however, that good programmers have been practising code re-usab
 GnuCOBOL is a free and open sourced COBOL compiler and runtime environment, written using the C programming language which itself is free to use and can be used in all forms including for commercial purposes - there is no restrictions.  GnuCOBOL is typically distributed in source-code form, and must then be built for your computer's operating system using the system's C compiler and loader.  While originally developed for the UNIX and Linux operating systems, GnuCOBOL has also been successfully built for computers running OSX (a OpenBSD implementation) and Windows utilizing the UNIX-emulation features of such tools as Cygwin and MinGW.  Also see the @url{https://savannah.gnu.org/projects/gnucobol, GNU website} for more information.
 Pre built Implemeations for Windows can also be found at @url{https://www.arnoldtrembley.com/GnuCOBOL.htm}.
 
-The MinGW approach is a personal favourite with the author of this manual because it creates a GnuCOBOL compiler and runtime library that require only a single MinGW DLL to be available for the GnuCOBOL compiler, runtime library and user programs.  That DLL is freely distributable under the terms of the GNU General Public License.  A MinGW build of GnuCOBOL fits easily on and runs from a 128MB flash drive with no need to install any software onto the Windows computer that will be using it.  Some functionality of the language, dealing with the sharing of files between concurrently executing GnuCOBOL programs and record locking on certain types of files, is sacrificed however as the underlying operating system routines needed to implement them aren't available to Windows and aren't provided by MinGW. The current version for MinGW is available at the download link along with various other platforms at the GnuCOBOL @url{ https://sourceforge.net/projects/gnucobol/files/gnu-cobol}, download website.
+The MinGW approach is a personal favourite with the author of this manual because it creates a GnuCOBOL compiler and runtime library that require only a single MinGW DLL to be available for the GnuCOBOL compiler, runtime library and user programs.  That DLL is freely distributable under the terms of the GNU General Public License.  A MinGW build of GnuCOBOL fits easily on and runs from a 128MB flash drive with no need to install any software onto the Windows computer that will be using it.  Some functionality of the language, dealing with the sharing of files between concurrently executing GnuCOBOL programs and record locking on certain types of files, is sacrificed however as the underlying operating system routines needed to implement them aren't available to Windows and aren't provided by MinGW. The current version for MinGW is available at the download link along with various other platforms at the GnuCOBOL @url{https://sourceforge.net/projects/gnucobol/files/gnu-cobol}, download website.
 
 GnuCOBOL has also been built as a truly native Windows application utilizing Microsoft's freely-downloadable Visual Studio Community  package to provide the C compiler and linker/loader.  This approach does not lend itself well to a ``portable'' distribution.
 

guide/10.texi

@@ -868,6 +868,28 @@ Sticky-linkage (linkage-section items remaining allocated between invocations) i
 
 @item TRUNC
 Numeric data items are truncated according to their @code{PICTURE} clauses.
+
+While still supported, this may well be removed in the future and should not be
+used. See @code{GCCOMP} and @code{GNUCOBOL} instead:
+
+@item OCCOMP
+The size of a @code{COMP} @var{item} is determined according to the GnuCOBOL scheme, where for a @code{PICTURE} of length:
+@table @asis
+@item 1 - 2
+@var{item} = 1 byte
+
+@item 3 - 4
+@var{item} = 2 bytes
+
+@item 5 - 9
+@var{item} = 4 bytes
+
+@item 10 - 18
+@var{item} = 8 bytes
+@end table
+
+@item OPENCOBOL
+GnuCOBOL is compiling the source unit.
 @end table
 @comment *********************************************************************
 @comment ** 10.1.4 Locating Copybooks                                        **

guide/11.texi

@@ -363,7 +363,7 @@ Arguments must be described in both the calling and called programs, and while t
 
 @item @syntaxref{SIGN}
 
-@item @syntaxref{SYNCRONIZED}
+@item @syntaxref{SYNCHRONIZED}
 
 @item @syntaxref{USAGE}
 @end itemize

guide/2.texi

@@ -655,6 +655,7 @@ Without specifying the environment variable COB_LEGACY = 1, will give you, what
 1. Using FOREGROUND-COLOR and a color code from 8 to 15: the character will be HIGHLIGHT (and that is the new color).
 
 2. Using BACKGROUND-COLOR and a color code from 8 to 15: the character will be the corresponding color coded from 0 to 7 and BLINK. (the character flashes on the screen)
+
 With specifying the parameter COB_LEGACY = 1 will give you what follows:
 
 3  Using FOREGROUND-COLOR and a color code from 8 to 15: the foreground character will be the new color.
@@ -1053,7 +1054,8 @@ Literals are constant values that will not change during the execution of a prog
 @comment *********************************************************************
 @comment ** 2.1.19.1 Numeric Literals                                       **
 @comment *********************************************************************
-@newunit{2.1.19.1,Numeric Literals}A numeric literal
+@newunit{2.1.19.1,Numeric Literals}
+A numeric literal
 @idx{Literals (Numeric)}
 @itemize @bullet
 @item

guide/3.texi

@@ -30,7 +30,6 @@ The compiler command-line option @option{-D} offers additional control (@pxref{c
 * 3.12: >>LISTING.
 * 3.13: >>LEAP-SECONDS.
 * 3.14: $ Directives.
-* 3.15: Predefined compilation variables.
 @end menu
 @comment *********************************************************************
 @comment ** 3.1 >>CALL-CONVENTION                                           **
@@ -339,7 +338,7 @@ The remaining options of the @directive{>>SET} provide equivalent functionality
 @code{>>SOURCE FORMAT IS FREE}
 
 @item >>SET SOURCEFORMAT AS VARIABLE
-@code{>>SOURCE FORMAT IS }
+@code{>>SOURCE FORMAT IS VARIABLE}
 
 @item >>SET SOURCEFORMAT AS XOPEN
 @code{>>SOURCE FORMAT IS XOPEN}
@@ -475,101 +474,6 @@ Allows for more than 60 seconds per minute.
 @newsection{3.14,$ Directives}
 @diagram{CDF $ Directive,CDF-DOLLAR,CDF-DOLLAR,None}
 Offers support for MF Compiler Directives.
-@comment ********************************************************************
-@comment ** 3.15 Predefined Compilation Variables (taken from grammar doc) **
-@comment ********************************************************************
-@page
-@newsection{3.15,Predefined compilation variables}
-GnuCOBOL defines @dfn{compilation variables} when various conditions are true.
-If the condition associated with a variable is false, the variable is not defined.
-@table @code
-@item DEBUG
-The -d debug flag is specified.
-
-@item EXECUTABLE
-Module being compiled contains the main program.
-
-@item GCCOMP
-The size of a @code{COMP} @var{item} is determined according to the GnuCOBOL scheme where for a picture of length:
-@table @asis
-@item 1 - 2
-@var{item} = 1 byte
-
-@item 3 - 4
-@var{item} = 2 bytes
-
-@item 5 - 9
-@var{item} = 4 bytes
-
-@item 10 - 18
-@var{item} = 8 bytes
-@end table
-
-@item GNUCOBOL
-GnuCOBOL is compiling the source unit.
-
-@item HOSTSIGNS
-A signed packed decimal item's value may be considered @code{NUMERIC} if sign = @code{X"F"}.
-
-@item IBMCOMP
-The size of a COMP @var{item} is determined according to the IBM scheme, where for a @code{PICTURE} of length:
-@table @asis
-@item 1 - 4
-@var{item} = 2 bytes
-
-@item 5 - 9
-@var{item} = 4 bytes
-
-@item 10 - 18
-@var{item} = 8 bytes
-@end table
-
-@item MODULE
-The element being compiled does not contain the main program.
-
-@item NOHOSTSIGNS
-A signed packed decimal item's value may @i{not} be considered @code{NUMERIC} if sign = @code{X"F"}.
-
-@item NOIBMCOMP
-The size of a @code{COMP} item is @i{not} determined according to the IBM scheme.
-
-@item NOSTICKY-LINKAGE
-Sticky linkage (linkage section items remaining allocated between invocations) is @i{not} active.
-
-@item NOTRUNC
-Numeric data items are truncated according to their internal representation.
-
-@item P64
-Pointers are greater than 32 bits.
-
-@item STICKY-LINKAGE
-Sticky linkage (linkage section items remaining allocated between invocations) is active.
-
-@item TRUNC
-Numeric data items are truncated according to their @code{PICTURE} clauses.
-
-While still supported, this may well be removed in the future and should not be
-used. See @code{GCCOMP} and @code{GNUCOBOL} instead:
-
-@item OCCOMP
-The size of a @code{COMP} @var{item} is determined according to the GnuCOBOL scheme, where for a @code{PICTURE} of length:
-@table @asis
-@item 1 - 2
-@var{item} = 1 byte
-
-@item 3 - 4
-@var{item} = 2 bytes
-
-@item 5 - 9
-@var{item} = 4 bytes
-
-@item 10 - 18
-@var{item} = 8 bytes
-@end table
-
-@item OPENCOBOL
-GnuCOBOL is compiling the source unit.
-@end table
 @iftex
 @sp 3
 @center ------------------------------------------------------------

guide/6.texi

@@ -249,7 +249,7 @@ Every sort file description (@code{SD} or @code{FD}) must be followed by at leas
 The reserved words @code{BY}, @code{IS}, @code{KEY}, @code{ON} and @code{WHEN} are optional and may be included, or not, at the discretion of the programmer.  The presence or absence of these words has no effect upon the program.
 
 @item
-The reserved words @code{SYNCRONIZED} and @code{SYNCRONISED} are interchangeable.  Both may be abbreviated to @code{SYNC}.
+The reserved words @code{SYNCHRONIZED} and @code{SYNCHRONISED} are interchangeable.  Both may be abbreviated to @code{SYNC}.
 
 @item
 The reserved word @code{PICTURE} may be abbreviated to @code{PIC}.
@@ -304,7 +304,7 @@ The working-storage section is used to describe data items that are not part of
 The reserved words @code{BY}, @code{CHARACTER}, @code{IS}, @code{KEY}, @code{ON}, @code{RIGHT} (JUSTIFIED), @code{TIMES} and @code{WHEN} are optional and may be included, or not, at the discretion of the programmer.  The presence or absence of these words has no effect upon the program.
 
 @item
-The reserved words @code{SYNCRONIZED} and @code{SYNCHRONISED} are interchangeable.  Both may be abbreviated as @code{SYNC}.
+The reserved words @code{SYNCHRONIZED} and @code{SYNCHRONISED} are interchangeable.  Both may be abbreviated as @code{SYNC}.
 
 @item
 The reserved word @code{PICTURE} may be abbreviated to @code{PIC}.
@@ -356,7 +356,7 @@ The local-storage section is similar to working-storage, but describes data with
 The reserved words @code{BY}, @code{CHARACTER} @code{IS}, @code{KEY}, @code{ON}, @code{RIGHT} (JUSTIFIED), @code{TIMES} and @code{WHEN}  are optional and may be included, or not, at the discretion of the programmer.  The presence or absence of these words has no effect upon the program.
 
 @item
-The reserved words @code{SYNCRONIZED} and @code{SYNCHRONISED} are interchangeable.  Both may be abbreviated as @code{SYNC}.
+The reserved words @code{SYNCHRONIZED} and @code{SYNCHRONISED} are interchangeable.  Both may be abbreviated as @code{SYNC}.
 
 @item
 The reserved word @code{PICTURE} may be abbreviated to @code{PIC}.
@@ -405,7 +405,7 @@ The linkage section describes data within a subprogram that serves as either inp
 The reserved words @code{BY}, @code{CHARACTER}, @code{IS}, @code{KEY}, @code{ON} and @code{WHEN} are optional and may be included, or not, at the discretion of the programmer.  The presence or absence of these words has no effect upon the program.
 
 @item
-The reserved words @code{SYNCRONIZED} and ``@code{SYNCHRONISED}'' are interchangeable.  Both may be abbreviated as @code{SYNC}.
+The reserved words @code{SYNCHRONIZED} and ``@code{SYNCHRONISED}'' are interchangeable.  Both may be abbreviated as @code{SYNC}.
 
 @item
 The reserved word @code{PICTURE} may be abbreviated to @code{PIC}.
@@ -972,7 +972,7 @@ The intent of a 77-level item is to be able to create a stand-alone elementary d
 The reserved words @code{CHARACTER}, @code{IS}, @code{RIGHT} (JUSTIFIED) and @code{WHEN} are optional and may be omitted.  The presence or absence of these words has no effect upon the program.
 
 @item
-The reserved word @code{JUSTIFIED} may be abbreviated as @code{JUST}, the reserved word @code{PICTURE} may be abbreviated as @code{PIC} and the reserved words @code{SYNCRONIZED} and @code{SYNCHRONISED} may be abbreviated as @code{SYNC}.
+The reserved word @code{JUSTIFIED} may be abbreviated as @code{JUST}, the reserved word @code{PICTURE} may be abbreviated as @code{PIC} and the reserved words @code{SYNCHRONIZED} and @code{SYNCHRONISED} may be abbreviated as @code{SYNC}.
 
 @item
 New programs requiring a stand-alone elementary item should be coded to use a level number of 01 rather than 77.
@@ -1107,7 +1107,7 @@ Executing the statement @code{SET @var{condition-name-1} TO FALSE} will cause @v
 * 6.9.43B: SIZE.
 * 6.9.44: SOURCE.
 * 6.9.45: SUM.
-* 6.9.46: SYNCRONIZED.
+* 6.9.46: SYNCHRONIZED.
 * 6.9.46B: TIME OUT
 * 6.9.47: TO.
 * 6.9.48: TYPE.
@@ -2745,21 +2745,21 @@ If, however, you want to reset the @code{SUM} counter only when the control foot
 @end enumerate
 @end enumerate
 @comment *********************************************************************
-@comment ** 6.9.46 SYNCRONIZED                                              **
+@comment ** 6.9.46 SYNCHRONIZED                                              **
 @comment *********************************************************************
 @page
-@newsubsection{6.9.46,SYNCRONIZED}
-@diagram{SYNCRONIZED,DD-SYNCRONIZED,DD-SYNCRONIZED,DD-SYNC-LEFT-RIGHT}
+@newsubsection{6.9.46,SYNCHRONIZED}
+@diagram{SYNCHRONIZED,DD-SYNCHRONIZED,DD-SYNCHRONIZED,DD-SYNC-LEFT-RIGHT}
 This syntax is valid in the following sections:
 @code{FILE}, @code{WORKING-STORAGE}, @code{LOCAL-STORAGE}, @code{LINKAGE}
 
 This optional clause optimizes the storage of binary numeric items to store them in such a manner as to make it as fast as possible for the CPU to fetch them.
 @enumerate
 @item
-The reserved words @code{SYNCRONIZED} and @code{SYNCHRONISED} are interchangeable, and may be abbreviated as @code{SYNC}.
+The reserved words @code{SYNCHRONIZED} and @code{SYNCHRONISED} are interchangeable, and may be abbreviated as @code{SYNC}.
 
 @item
-If the @code{SYNCRONIZED} clause is coded on anything but a numeric data item with a @syntaxref{USAGE} that specifies storage of data in a binary form, the @code{SYNCRONIZED} clause will be ignored.
+If the @code{SYNCHRONIZED} clause is coded on anything but a numeric data item with a @syntaxref{USAGE} that specifies storage of data in a binary form, the @code{SYNCHRONIZED} clause will be ignored.
 
 @item
 Synchronization is performed (by the compiler) as follows:
@@ -2778,7 +2778,7 @@ If the binary item occupies eight bytes of storage, the binary item is allocated
 @end enumerate
 @end enumerate
 @iftex
-The following illustrates the allocation of a group of data items both without and with the @code{SYNCRONIZED} option.  The grey blocks represent the unused bytes that are allocated in the Group-Item-2 structure because of the @code{SYNC} clauses.
+The following illustrates the allocation of a group of data items both without and with the @code{SYNCHRONIZED} option.  The grey blocks represent the unused bytes that are allocated in the Group-Item-2 structure because of the @code{SYNC} clauses.
 @sp 1
 @image{synchronization,6in}
 @end iftex
@@ -2968,7 +2968,7 @@ Figure 2. Example Showing How TYPEDEF and TYPE Clauses Can Be Used
 @end example
 @end enumerate
 This syntax is valid in the following sections:
-@code {REPORT}
+@code{REPORT}
 
 As Format 2
 @enumerate
@@ -3104,12 +3104,16 @@ The following table summarizes the various USAGE specifications available in Gnu
 @end multitable
 
 @t{BINARY-C-LONG [ SIGNED ]}@*@t{~~~~~~~~~~~~~}
+@multitable @columnfractions 0.05 0.4 0.55
 
 @item Depending on the system hardware, the range is either 0 to 2^31 or 0 to 2^63.
+@end multitable
 
 @t{BINARY-C-LONG UNSIGNED}@*@t{~~~~~~~~~~~~~ ~~~~~~~~}
 
+@multitable @columnfractions 0.05 0.4 0.55
 @item Depending on the system hardware, the range is either 0 to 2^32 or 0 to 2^64. This USAGE should only be used for direct CALLs into C and otherwise should not be used (and it won't compile with any strict -std as it is a GnuCOBOL-only extension).
+@end multitable
 
 
 @t{BINARY-CHAR [ SIGNED ]}@*@t{~~~~~~~~~~~}

guide/7.texi

@@ -696,7 +696,7 @@ As part of the @code{TIMES} clause of a @statementref{PERFORM}.
 *   7.8.12.1: DISPLAY UPON device
 *   7.8.12.2: DISPLAY UPON COMMAND-LINE
 *   7.8.12.3: DISPLAY UPON ENVIRONMENT-NAME
-*   7.8.12.4: DISPLAY Data-Item
+*   7.8.12.4: DISPLAY data-item
 *   7.8.12.5: DISPLAY data-item (Microsoft v1, 2)
 @end detailmenu
 * 7.8.13: DIVIDE
@@ -1475,11 +1475,11 @@ The @code{ALLOCATE} statement is used to dynamically allocate memory at run-time
 The reserved words @code{INITIALIZED} and @code{INITIALISED} are interchangeable.
 
 @item
-If data-name-1 is specified, the RETURNING phrase may be omitted; otherwise, the RETURNING phrase shall be
+If @var{identifier-1} is specified, the RETURNING phrase may be omitted; otherwise, the RETURNING phrase shall be
 specified.
 
 @item
-If used, @var{expression-1} must be an arithmetic expression with a non-zero positive integer value and the RETURNING  phrase must be specified.
+If used, @var{arithmetic-expression-1} must be an arithmetic expression with a non-zero positive integer value and the RETURNING  phrase must be specified.
 
 @item
 If used, @var{identifier-1} should be an 01-level item defined in working-storage or local-storage with the @syntaxref{BASED} attribute.  It may be an 01 item defined in the linkage section without the @code{BASED} attribute, but using such a data item is not recommended.
@@ -1496,7 +1496,7 @@ When the @var{identifier-1} option is used in conjunction with
 @syntaxidx{INITIALIZED} (or its internationalized alternative @code{INITIALISED}), the allocated memory block will be initialized as if an @syntaxrefalt{INITIALIZE @var{identifier-1} WITH FILLER ALL TO VALUE THEN TO DEFAULT,INITIALIZE} were executed.
 
 @item
-When the @code{@var{expression-1} CHARACTERS} option is used, @code{INITIALIZED} will initialize the allocated memory block to binary zeros.  If @code{INITIALIZED} is not used, the initial contents of allocated memory will be left to whatever rules of memory allocation are in effect for the operating system the program is running under.
+When the @code{@var{arithmetic-expression-1} CHARACTERS} option is used, @code{INITIALIZED} will initialize the allocated memory block to binary zeros.  If @code{INITIALIZED} is not used, the initial contents of allocated memory will be left to whatever rules of memory allocation are in effect for the operating system the program is running under.
 
 @item
 There are two basic ways in which this statement is used.  The simplest is:
@@ -1887,11 +1887,11 @@ Consider using @syntaxref{SET ENVIRONMENT} in lieu of @code{DISPLAY} to set envi
 The optional @code{ON EXCEPTION} and @code{NOT ON EXCEPTION} clauses may be used to detect and react to the failure or success, respectively, of an attempt to display output to the specified item.  @xref{ON EXCEPTION + NOT ON EXCEPTION}, for additional information.
 @end enumerate
 @comment *************************************************************
-@comment ** 7.8.12.4 DISPLAY Data-Item                              **
+@comment ** 7.8.12.4 DISPLAY data-item                              **
 @comment *************************************************************
 @page
-@newunit{7.8.12.4,DISPLAY Data-Item}
-@diagram{DISPLAY Data-Item,PD-DISPLAY-4,PD-DISPLAY-4,PD-DISPLAY-4}
+@newunit{7.8.12.4,DISPLAY data-item}
+@diagram{DISPLAY data-item,PD-DISPLAY-4,PD-DISPLAY-4,PD-DISPLAY-4}
 This format of the @statement{DISPLAY} presents data onto a formatted screen.
 @enumerate
 @comment Syntactical Specifications:
@@ -1976,7 +1976,7 @@ When @code{DISPLAY} is used without line or column controls only one variable or
 @comment ** 7.8.12.5 DISPLAY data-item (Microsoft v1, 2)            **
 @comment *************************************************************
 @page
-@newunit{7.8.12.5,DISPLAY data-item}
+@newunit{7.8.12.5,DISPLAY data-item (Microsoft)}
 @diagram{DISPLAY data-item,PD-DISPLAY-5,PD-DISPLAY-5,None}
 This format of the @statement{DISPLAY} presents data onto a formatted screen using the Microsoft format from v1 and v2 compilers (MsDos).