Browse Source

+ Changed options description to fit version 0.99.10

michael 27 years ago
parent
commit
541cbaa20b
1 changed files with 48 additions and 27 deletions
  1. 48 27
      docs/user.tex

+ 48 - 27
docs/user.tex

@@ -830,7 +830,8 @@ isn't under \dos.
 % Using the command-line options
 % Using the command-line options
 \section{Using the command-line options}
 \section{Using the command-line options}
 
 
-The available options are listed by category:
+The available options for version 0.99.10 of the compiler are listed by 
+category (see appendix A for a listing as generated by the compiler):
 
 
 %
 %
 % General options
 % General options
@@ -843,7 +844,16 @@ and exits after that.
 \olabel{h}
 \olabel{h}
 \item[-?] idem as \var{-h}, waiting after every screenfull for the enter key.
 \item[-?] idem as \var{-h}, waiting after every screenfull for the enter key.
 \item[-i] This option tells the compiler to print the copyright information.
 \item[-i] This option tells the compiler to print the copyright information.
-\olabel{i}
+\olabel{i} You can give it an option, as \var{-ixxx} where xxx can be one of the
+following:
+\begin{description}
+\item[D] : Returns the compiler date.
+\item[V] : Returns the compiler version.
+\item[SO] : Returns the compiler OS.
+\item[SP] : Returns the compiler processor.
+\item[TO] : Returns the target OS.
+\item[TP] : Returns the target Processor.
+\end{description}
 \item[-l] This option tells the compiler to print the \fpc logo on standard
 \item[-l] This option tells the compiler to print the \fpc logo on standard
 output. It also gives you the \fpc version number.
 output. It also gives you the \fpc version number.
 \olabel{l}
 \olabel{l}
@@ -879,8 +889,12 @@ conditional.
 same as specifying all options)
 same as specifying all options)
 \item \var{0} : Tells the compiler to write no messages. This is useful when
 \item \var{0} : Tells the compiler to write no messages. This is useful when
 you want to override the default setting in the configuration file.
 you want to override the default setting in the configuration file.
-\item \var{b} Tells the compiler to show all procedure declarations if an
+\item \var{b} : Tells the compiler to show all procedure declarations if an
 overloaded function error occurs.
 overloaded function error occurs.
+\item \var{x} : Tells the compiler to output some executable info (for Win32
+platform only).
+\item \var{r} : Rhide/GCC compatibility mode: formats the errors
+differently, so they are understood by RHIDE.
 \end{itemize}
 \end{itemize}
 \end{description}
 \end{description}
 
 
@@ -893,11 +907,12 @@ overloaded function error occurs.
 compiler can find the executables \file{as} (the assembler) and \file{ld} (the
 compiler can find the executables \file{as} (the assembler) and \file{ld} (the
 compiler).
 compiler).
 \olabel{e}
 \olabel{e}
+\item [-FD] same as \var{-e}.
 \item [-Fexxx] This option tells the compiler to write errors, etc. to 
 \item [-Fexxx] This option tells the compiler to write errors, etc. to 
 the file in \file{xxx}.
 the file in \file{xxx}.
 \olabel{Fe} 
 \olabel{Fe} 
-\item [-Fgxxx] (\linux only) \file{xxx} specifies the path where the compiler
-can find the \gnu C library.
+\item [-Fgxxx] (\linux only, obsolete) \file{xxx} specifies the path where the compiler
+can find the \gnu C library. This is superseded by the \var{-Fl} option.
 \olabel{Fg}
 \olabel{Fg}
 \item [-Fixxx] adds \var{xxx} to the path where the compiler searches for
 \item [-Fixxx] adds \var{xxx} to the path where the compiler searches for
 its include files.
 its include files.
@@ -918,6 +933,8 @@ will override the default messages.
 \olabel{Fr}
 \olabel{Fr}
 \item [-Fuxxx] Idem as \var{-Up}: Add \file{xxx} to the object path.
 \item [-Fuxxx] Idem as \var{-Up}: Add \file{xxx} to the object path.
 \olabel{Fu}
 \olabel{Fu}
+\item [-FUxxx] Tells the compiler to write units in directory \var{xxx}
+instead of the current directory.
 \item [-Ixxx] \olabel{I} Add \file{xxx} to the include file search path.
 \item [-Ixxx] \olabel{I} Add \file{xxx} to the include file search path.
 This path is used when looking for include files.
 This path is used when looking for include files.
 \item [-P] uses pipes instead of files when assembling. This may speed up
 \item [-P] uses pipes instead of files when assembling. This may speed up
@@ -967,7 +984,7 @@ to conditionally compile parts of your code.
 \file{gdb}
 \file{gdb}
 \item [-gg] idem as \var{-g}.
 \item [-gg] idem as \var{-g}.
 \item [-gd] \olabel{gd} generate debugging info for \file{dbx}.
 \item [-gd] \olabel{gd} generate debugging info for \file{dbx}.
-
+\item [-gh] use the heaptrc unit (see \unitsref).
 \item[-Oxxx] \olabel{O} optimize the compiler's output; \var{xxx} can have one
 \item[-Oxxx] \olabel{O} optimize the compiler's output; \var{xxx} can have one
 of the following values :
 of the following values :
 \begin{description}
 \begin{description}
@@ -1005,8 +1022,6 @@ the following:
 \end{itemize}
 \end{itemize}
 \item [-uxxx] \olabel{u} undefine the symbol \var{xxx}. This is the opposite
 \item [-uxxx] \olabel{u} undefine the symbol \var{xxx}. This is the opposite
 of the \var{-d} option.
 of the \var{-d} option.
-\item [-Uld] \olabel{Uld} make dynamic library from unit.
-\item [-Uls] \olabel{Uls} make static library from unit.
 \item [-uxxx] \olabel{U} Undefine symbol \var{xxx}.
 \item [-uxxx] \olabel{U} Undefine symbol \var{xxx}.
 
 
 \item [-Xx] \olabel{X} executable options. This tells the compiler what
 \item [-Xx] \olabel{X} executable options. This tells the compiler what
@@ -1059,9 +1074,6 @@ compatible.
 \item [-Ss] \olabel{Ss} The name of constructors must be \var{init}, and the
 \item [-Ss] \olabel{Ss} The name of constructors must be \var{init}, and the
 name of destructors should be \var{done}.
 name of destructors should be \var{done}.
 \item [-St] \olabel{St} Allow the \var{static} keyword in objects.
 \item [-St] \olabel{St} Allow the \var{static} keyword in objects.
-\item [-Sv] allow variable directives (cvar, external, public, export).
-You cannot use the \var{cvar} or \var{external} modifiers on variables,
-unless you use this switch.
 \item [-Un] \olabel{Un} Do not check the unit name. Normally, the unit name
 \item [-Un] \olabel{Un} Do not check the unit name. Normally, the unit name
 is the same as the filename. This option allows both to be different.
 is the same as the filename. This option allows both to be different.
 \item [-Us] \olabel{Us} Compile a system unit. This option causes the
 \item [-Us] \olabel{Us} Compile a system unit. This option causes the
@@ -2208,9 +2220,9 @@ The following is alphabetical listing of all command-line options, as
 generated by the compiler:
 generated by the compiler:
 \begin{verbatim}
 \begin{verbatim}
 ppc386 [options] <inputfile> [options]
 ppc386 [options] <inputfile> [options]
-+ switch option on, - off
+put + after a boolean switch option to enable it, - to disable it
   -a     the compiler doesn't delete the generated assembler file
   -a     the compiler doesn't delete the generated assembler file
-           -al        list sourcecode lines in assembler file  (still BETA !!)
+           -al        list sourcecode lines in assembler file
   -B     build all modules
   -B     build all modules
   -C     code generation options
   -C     code generation options
            -CD        create dynamic library
            -CD        create dynamic library
@@ -2227,7 +2239,9 @@ ppc386 [options] <inputfile> [options]
   -e<x>  set path to executable
   -e<x>  set path to executable
   -E     same as -Cn
   -E     same as -Cn
   -F     set file names and paths
   -F     set file names and paths
+           -FD<x>     sets the directory where to search for compiler utilities
            -Fe<x>     redirect error output to <x>
            -Fe<x>     redirect error output to <x>
+           -FE<x>     set exe/unit output path to <x>
            -Fg<x>     same as -Fl
            -Fg<x>     same as -Fl
            -Fi<x>     adds <x> to include path
            -Fi<x>     adds <x> to include path
            -Fl<x>     adds <x> to library path
            -Fl<x>     adds <x> to library path
@@ -2235,10 +2249,18 @@ ppc386 [options] <inputfile> [options]
            -Fo<x>     adds <x> to object path
            -Fo<x>     adds <x> to object path
            -Fr<x>     load error message file <x>
            -Fr<x>     load error message file <x>
            -Fu<x>     adds <x> to unit path
            -Fu<x>     adds <x> to unit path
+           -FU<x>     set unit output path to <x>, overrides -FE
   -g     generate debugger information
   -g     generate debugger information
            -gg        use gsym
            -gg        use gsym
            -gd        use dbx
            -gd        use dbx
+           -gh        use heap trace unit
   -i     information
   -i     information
+           -iD        return compiler date
+           -iV        return compiler version
+           -iSO       return source OS
+           -iSP       return source processor
+           -iTO       return target OS
+           -iTP       return target processor
   -I<x>  adds <x> to include path
   -I<x>  adds <x> to include path
   -k<x>  Pass <x> to the linker
   -k<x>  Pass <x> to the linker
   -l     write logo
   -l     write logo
@@ -2249,7 +2271,7 @@ ppc386 [options] <inputfile> [options]
   -S     syntax options
   -S     syntax options
            -S2        switch some Delphi 2 extensions on
            -S2        switch some Delphi 2 extensions on
            -Sc        supports operators like C (*=,+=,/= and -=)
            -Sc        supports operators like C (*=,+=,/= and -=)
-           -Sd        compiler disposes asm lists (uses less memory but slower)
+           -Sd        tries to be Delphi compatible
            -Se        compiler stops after the first error
            -Se        compiler stops after the first error
            -Sg        allow LABEL and GOTO
            -Sg        allow LABEL and GOTO
            -Si        support C++ stlyed INLINE
            -Si        support C++ stlyed INLINE
@@ -2258,14 +2280,7 @@ ppc386 [options] <inputfile> [options]
            -Sp        tries to be gpc compatible
            -Sp        tries to be gpc compatible
            -Ss        constructor name must be init (destructor must be done)
            -Ss        constructor name must be init (destructor must be done)
            -St        allow static keyword in objects
            -St        allow static keyword in objects
-           -Sv        allow variable directives (cvar,external,public,export)
   -s     don't call assembler and linker (only with -a)
   -s     don't call assembler and linker (only with -a)
-  -T<x>  Target operating system
-           -TGO32V1   version 1 of DJ Delorie DOS extender
-           -TGO32V2   version 2 of DJ Delorie DOS extender
-           -TLINUX    Linux
-           -TOS2      OS/2 2.x
-           -TWin32    Windows 32 Bit
   -u<x>  undefines the symbol <x>
   -u<x>  undefines the symbol <x>
   -U     unit options
   -U     unit options
            -Un        don't check the unit name
            -Un        don't check the unit name
@@ -2273,14 +2288,14 @@ ppc386 [options] <inputfile> [options]
            -Us        compile a system unit
            -Us        compile a system unit
   -v<x>  Be verbose. <x> is a combination of the following letters :
   -v<x>  Be verbose. <x> is a combination of the following letters :
            e : Show errors (default)       d : Show debug info
            e : Show errors (default)       d : Show debug info
-           w : Show warnings               u : Show used files
-           n : Show notes                  t : Show tried files
+           w : Show warnings               u : Show unit info
+           n : Show notes                  t : Show tried/used files
            h : Show hints                  m : Show defined macros
            h : Show hints                  m : Show defined macros
            i : Show general info           p : Show compiled procedures
            i : Show general info           p : Show compiled procedures
            l : Show linenumbers            c : Show conditionals
            l : Show linenumbers            c : Show conditionals
            a : Show everything             0 : Show nothing (except errors)
            a : Show everything             0 : Show nothing (except errors)
-           b : Show all procedure
-               declarations if an error
+           b : Show all procedure          r : Rhide/GCC compatibility mode
+               declarations if an error    x : Executable info (Win32 only)
                occurs
                occurs
   -X     executable options
   -X     executable options
            -Xc        link with the c library
            -Xc        link with the c library
@@ -2289,14 +2304,14 @@ ppc386 [options] <inputfile> [options]
            -XS        link with static libraries (defines FPC_LINK_STATIC)
            -XS        link with static libraries (defines FPC_LINK_STATIC)
 
 
 Processor specific options:
 Processor specific options:
-  -A     output format
+  -A<x>  output format
            -Ao        coff file using GNU AS
            -Ao        coff file using GNU AS
            -Anasmcoff coff file using Nasm
            -Anasmcoff coff file using Nasm
            -Anasmelf  elf32 (linux) file using Nasm
            -Anasmelf  elf32 (linux) file using Nasm
            -Anasmobj  obj file using Nasm
            -Anasmobj  obj file using Nasm
            -Amasm     obj using Masm (Mircosoft)
            -Amasm     obj using Masm (Mircosoft)
            -Atasm     obj using Tasm (Borland)
            -Atasm     obj using Tasm (Borland)
-  -R     assembler reading style
+  -R<x>  assembler reading style
            -Ratt      read AT&T style assembler
            -Ratt      read AT&T style assembler
            -Rintel    read Intel style assembler
            -Rintel    read Intel style assembler
            -Rdirect   copy assembler text directly to assembler file
            -Rdirect   copy assembler text directly to assembler file
@@ -2312,6 +2327,12 @@ Processor specific options:
                      -Op1  set target processor to 386/486
                      -Op1  set target processor to 386/486
                      -Op2  set target processor to Pentium/PentiumMMX (tm)
                      -Op2  set target processor to Pentium/PentiumMMX (tm)
                      -Op3  set target processor to PPro/PII/c6x86/K6 (tm)
                      -Op3  set target processor to PPro/PII/c6x86/K6 (tm)
+  -T<x>  Target operating system
+           -TGO32V1   version 1 of DJ Delorie DOS extender
+           -TGO32V2   version 2 of DJ Delorie DOS extender
+           -TLINUX    Linux
+           -TOS2      OS/2 2.x
+           -TWin32    Windows 32 Bit
   
   
   -?     shows this help
   -?     shows this help
   -h     shows this help without waiting
   -h     shows this help without waiting