* moved to install/man/

docs/ppc386.1

@@ -1,427 +0,0 @@
-.TH ppc386 1 "30 may 1999" FPC "Free Pascal Compiler"
-.SH NAME
-ppc386 \- Free Pascal Compiler (FPC) binary, name derived from Portable Pascal Compiler
-
-.SH SYNOPSIS
-
-.B "ppc386 [options] [sourcefile]"
-.BR
-
-.SH DESCRIPTION
-This binary is the main binary of the
-.I Free Pascal Compiler (FPC)
-which is a
-.I Turbo Pascal
-and
-.I Delphi (2.0) compatible
-standalone (non GCC frontend) multitarget Pascal compiler.
-.PP
-The compiler uses
-.BR LD (1)
-and can use
-.BR AS (1)
-(see parameter \-Aas, but also has its own binary object writer.
-.PP
-The current main targets are
-.I Go32V2
-(Dos DJGPP extender),
-.I Linux,
-.I OS/2
-and
-.I Win32.
-The other targets (M68K compilers for Atari and Amiga) are based on older
-versions of the compiler.
-.PP
-This manpage is meant for quick\-reference only. FPC comes with a great (600+ pages)
-manual, which is updated constantly, while this man page can be out of date.
-
-.SH Version number
-
-Right now the compiler uses versionnumbers like 0.99.12 and 0.99.13. After
-the 1.0 release this will change to 1.0 and 1.1. Both version naming types have
-in common that if the last number is even (0.99.12, 1.0), it is stable, and the last number odd
-is a dialy changing development version.(0.99.13, 1.1) just like the kernel.
-Fixes to releases will be named 0.99.12-x with x a number (e.g. 0.99.12-1)
-.PP
-Version 0.99.5 however is a stable release. It was made before the even/odd version
-naming system was introduced.
-
-.SH Usage
-
-The compilation proces is started by typing
-.I ppc386
-followed by a sourcefile name (normally with .pas or .pp extension). Before processing the actual processing of the source file,
-.BR ppc386.cfg (5)
-the configuration file of the compiler is read which contains the location of the
-RTL, other packages (API, FCL, FreeVision), and optionally default values for some
-switches. See the separate manpage of
-.BR ppc386.cfg (5)
-for more information.
-
-.SH Options
-
-.PP
-General options
-
-.IP \fI\-h\fP
-if you specify this option, the compiler outputs a list of all options,
-and exits after that.
-.IP \fI\-?\fP
-idem as \-h, but waiting after every screenfull for the enter key.
-.IP \fI\-i\fP
-This option tells the compiler to print the copyright information.
-   You can give it an option, as -ixxx} where "xxx" can be one of the
-following:
-.RS
-.IP \fID\fP
-Returns the compiler date.
-.IP \fIV\fP
-Returns the compiler version.
-.IP \fISO\fP
-Returns the compiler OS.
-.IP \fISP\fP
-Returns the compiler processor.
-.IP \fITO\fP
-Returns the target OS.
-.IP \fITP\fP
-Returns the target Processor.
-.RE
-.IP \fI-l\fP
-This option tells the compiler to print the
-.I FPC
-logo on standard output. It also gives you the
-.I FPC
-version number.
-.IP \fI-n\fP
-Tells the compiler not to read the configuration file
-.BR ppc386.cfg (5)
-
-.PP
-Options for getting feedback
-.IP \fI-vxxx\fP
-Be verbose. "xxx" is a combination of the following:
-.RS
-.IP \fIe\fP
-Tells the compiler to show only errors. This option is on by default.
-.IP \fIi\fP
-Tells the compiler to show some general information.
-.IP \fIw\fP
-Tells the compiler to issue warnings.
-.IP \fIn\fP
-Tells the compiler to issue notes.
-.IP \fIh\fP
-Tells the compiler to issue hints.
-.IP \fIl\fP
-Tells the compiler to show the line numbers as it processes a
-file. Numbers are shown per 100.
-.IP \fIu\fP
-Tells the compiler to print the names of the files it opens.
-.IP \fIt\fP
-Tells the compiler to print the names of the files it tries
-to open.
-.IP \fIp\fP
-Tells the compiler to print the names of procedures and
-functions as it is processing them.
-.IP \fIc\fP
-Tells the compiler to warn you when it processes a
-conditional.
-.IP \fIm\fP
-Tells the compiler to write which macros are defined.
-.IP \fId\fP
-Tells the compiler to write other debugging info.
-.IP \fIa\fP
-Tells the compiler to write all possible info. (this is the
-same as specifying all options)
-.IP \fI0\fP
-Tells the compiler to write no messages. This is useful when
-you want to override the default setting in the configuration file.
-.IP \fIb\fP
-Tells the compiler to show all procedure declarations if an
-overloaded function error occurs.
-.IP \fIx\fP
-Tells the compiler to output some executable info (for Win32
-platform only).
-.IP \fIr\fP
-Rhide/GCC compatibility mode: formats the error differently, so they
-are understood by RHIDE.
-.RE
-.PP
-Options concerning files and directories
-.IP \fI-exxx\fP
-"xxx" specifies the directory where thc ompiler can find the executables
-as (the assembler) and ld (the compiler).
-
-.IP \fI-FD\fP
-same as
-.I -e.
-.IP \fI-Fexxx\fP
-This option tells the compiler to write errors, etc. to
-the file "xxx".
-.IP \fI-Fgxxx\fP
-(linux only, obsolete) "xxx" specifies the path where the compiler
-can find the
-.I GNU C
-library. This is superseded by the
-.I -Fl
-option.
-.IP \fI-Fixxx\fP
-adds "xxx" to the path where the compiler searches for
-its include files.
-.IP \fI-Flxxx\fP
-Adds "xxx" to the library searching path, and is passe to the linker.
-
-.IP \fI-FLxxx\fP
-( Linux only) Tells the compiler to use "xxx" as the
-dynamic linker. Default this is /lib/ld-linux.so.2, or
-lib/ld-linux.so.1, depending on which one is found.
-.IP \fI-Foxxx\fP
-Adds "xxx" to the object file path. This path is used
-when looking for files that need to be linked in.
-.IP \fI-Frxxx\fP
-"xxx" specifies the file which contain the compiler
-messages. Default the compiler ahs built-in messages. Specifying this option
-will override the default messages.
-.IP \fI-Fuxxx\fP
-Idem as
-.I -Up
-Add "xxx" to the object path.
-.IP \fI-FUxxx\fP
-Tells the compiler to write units in directory "xxx" instead of the current
-directory.
-.IP \fI-Ixxx\fP
-Add "xxx" to the include file search path.
-This path is used when looking for include files.
-.IP \fI-P\fP
-uses pipes instead of files when assembling. This may speed up
-the compiler on OS/2 and Linux. Only with assemblers (such as
-.I GNU AS
-that support piping..
-.IP \fI-Upxxx\fP
-Tells the compiler to add "xxx" to the path where to find
-units.
-By default, the compiler only searches for units in the current directory
-and the directory where the compiler itself resides. This option tells the
-compiler also to look in the directory "xxx."
-
-.PP Options controlling the kind of output
-for more information on these options, see also the programmers manual.
-.IP \fI-a\fP
-Tells the compiler not to delete the assembler file.
-This also counts for the (possibly) generated batch script.
-.IP \fI-al\fP
-Tells the compiler to include the sourcecode lines
-in the assembler file as comments. This feature is still experimental, and
-should be used with caution.
-.IP \fI-Axxx\fP
-specifies what kind of assembler should be generated . Here
-"xxx" is one of the following :
-.RS
-.IP \fIAS\fP
-A unix .o (object) file, using
-.I GNU AS
-.IP \fInasmcoff\fP
-a coff file using the
-.I nasm
-assembler.
-.IP \fInasmelf\fP
-a ELF32 file (LINUX only) using the
-.I nasm
-assembler.
-.IP \fInasmonj\fP
-a obj file  using the
-.I nasm
-assembler.
-.IP \fImasm\fP
-An obj file using the Microsoft
-.I masm
-assembler.
-.IP \fItasm\fP
-An obj file using the Borland
-.I tasm
-assembler.
-.RE
-
-.IP \fI-CD\fP
-Create dynamic library.
-.IP \fI-Chxxx\fP
-Reserves "xxx" bytes heap. "xxx" shoul be between 1024 and 67107840.
-.IP \fI-Ci\fP
-Generate Input/Output checking code.
-.IP \fI-Cn\fP
-Omit the linking stage.
-.IP \fI-Co\fP
-Generate Integer overflow checking code.
-.IP \fI-Cr\fP
-Generate Range checking code.
-.IP \fI-Csxxx\fP
-Set stack size to "xxx".
-.IP \fI-CS\fP
-Create static library.
-.IP \fI-Ct\fP
-generate stack checking code.
-.IP \fI-Cx\fP
-Use smartlinking when compiling and linking units.
-.IP \fI-dxxx\fP
-Define the symbol name "xxx". This can be used
-to conditionally compile parts of your code.
-
-
-
-.IP \fI-E\fP
-Same as -Cn.
-.IP \fI-g\fP
-Generate debugging information for debugging with
-.I GDB
-
-.IP \fI-gg\fP
-idem as -g.
-.IP \fI-gd\fP
-generate debugging info for dbx.
-.IP \fI-gh\fP
-use the heaptrc unit (see the units part of the FPC manual).
-.IP \fI-Oxxx\fP
-optimize the compiler's output; "xxx" can have one
-of the following values :
-.RS
-.IP \fIg\fP
-optimize for size, try to generate smaller code.
-.IP \fIG\fP
-optimize for time, try to generate faster code (default).
-.IP \fIr\fP
-keep certain variables in registers (experimental, use with caution).
-.IP \fIu\fP
-uncertain optimizations
-.IP \fI1\fP
-Level 1 optimizations (quick optimizations).
-.IP \fI2\fP
-Level 2 optimizations (-O1 plus some slower optimizations).
-.IP \fI3\fP
-Level 3 optimizations (-O2 plus -Ou).
-.IP \fIPn\fP
-Specify processor : n can be one of
-.RS
-.IP \fI1\fP
-optimize for 386/486
-.IP \fI2\fP
-optimize for Pentium/PentiumMMX (tm)
-.IP \fI3\fP
-optimizations for PentiumPro / P-II / Cyrix 6x86 / K6 (tm)
-.RE
-
-The exact effect of these effects can be found in the programmers part of the manual.
-.RE
-.IP \fI-oxxx\fP
-Tells the compiler to use "xxx" as the name of the output
-file (executable). Only with programs.
-.IP \fI-pg\fP
-Generate profiler code for gprof.
-.IP \fI-s\fP
-Tells the compiler not to call the assembler and linker.
-Instead, the compiler writes a script, PPAS.BAT under DOS, or
-ppas.sh under Linux, which can then be executed to produce an
-executable.
-.IP \fI-Txxx\fP
-Specifies the target operating system. "xxx" can be one of the following:
-.RS
-.IP \fIGO32V1\fP
-DOS and version 1 of the DJ DELORIE extender (no longer maintained).
-.IP \fIGO32V2\fP
-DOS and version 2 of the DJ DELORIE extender.
-.IP \fILINUX\fP
-Linux.
-.IP \fIOS2\fP
-OS/2 (2.x) (this is still under development).
-.IP \fIWIN32\fP
-Windows 32 bit.
-.RE
-.IP \fI-uxxx\fP
-undefine the symbol "xxx". This is the opposite
-of the -d option.
-.IP \fI-uxxx\fP
-Undefine symbol "xxx".
-.IP \fI-Xx\fP
-Executable options. These tell the compiler what
-kind of executable should be generated. the parameter "x"
-can be one of the following:
-.RS
-.IP \fIc\fP
-(Linux only) Link with the C library. You should only use this when
-you start to port \fpc to another operating system.
-.IP \fID\fP
-Link with dynamic libraries (defines the FPC_LINK_DYNAMIC symbol)
-.IP \fIs\fP
-Strip the symbols from the executable.
-.IP \fIS\fP
-Link with static libraries (defines th FPC_LINK_STATIC symbol)
-.RE
-
-.PP
-Options concerning the sources (language options)
-for more information on these options, see also Programmers Manual
-.IP \fI-Rxxx\fP
-Specifies what assembler you use in your "asm" assembler code
-blocks. Here "xxx" is one of the following:
-.RS
-.IP \fIatt\fP
-Asm blocks contain AT&T assembler.
-.IP \fIintel\fP
-Asm blocks contain Intel assembler.
-.IP \fIdirect\fP
-Asm blocks should be copied as-is in the assembler
-file.
-.RE
-.IP \fI-S2\fP
-Switch on Delphi 2 extensions.
-.IP \fI-Sc\fP
-Support C-style operators, i.e. *=, +=, /= and -=.
-.IP \fI-Sd\fP
-tells the compiler to dispose asmlists. This uses less memory,
-but is slower.
-.IP \fI-Se\fP
-The compiler stops after the first error. Normally,
-the compiler tries to continue compiling after an error, until 50 errors are
-reached, or a fatal error is reached, and then it stops. With this switch,
-the compiler will stop after the first error.
-.IP \fI-Sg\fP
-Support the label and goto commands.
-.IP \fI-Si\fP
-Support C++ style INLINE.
-.IP \fI-Sm\fP
-Support C-style macros.
-.IP \fI-So\fP
-Try to be Borland TP 7.0 compatible (no function
-overloading etc.).
-.IP \fI-Sp\fP
-Try to be
-.I GPC (GNU Pascal Compiler)
-compatible.
-.IP \fI-Ss\fP
-The name of constructors must be "init", and the
-name of destructors should be "done".
-.IP \fI-St\fP
-Allow the "static" keyword in objects.
-.IP \fI-Un\fP
-Do not check the unit name. Normally, the unit name
-is the same as the filename. This option allows both to be different.
-.IP \fI-Us\fP
-Compile a system unit. This option causes the
-compiler to define only some very basic types.
-
-.SH Acknowledgements
-
-The manual (on which the manpage is based) was mainly written by Michael van Canneyt.
-.PP
-Questions/corrections can be mailed to fpc\[email protected]
-.PP
-Also thanks to the rest of the FPC development team.
-
-.SH SEE ALSO
-.BR  ppc386.cfg (5)
-.BR  ppdep (1)
-.BR  ppudump (1)
-.BR  ppumove (1)
-.BR  ptop (1)
-.BR  h2pas (1)
-.BR  ld (1)
-.BR  as (1)
-

docs/ppc386.cfg.5

@@ -1,285 +0,0 @@
-.TH ppc386.cfg 5 "30 may 1999" FPC "FPC configuration file"
-.SH NAME
-ppc386.cfg \- Free Pascal Compiler (FPC) configuration file, name derived from Portable Pascal Compiler.
-
-.SH DESCRIPTION
-This is the main configuration file of the
-.I Free Pascal Compiler (FPC)
-.PP
-All commandline options of the compiler (described in
-.BR ppc386 (1)
-) can be specified in the ppc386.cfg
-
-When the configuration file is found, it is read, and the lines
-it contains are treated like you typed them on the command line see
-.BR ppc386 (1)
-with some extra condtional possibilities.
-
-.SH SYNTAX
-
-You can specify comments in the configuration file with the # sign.
-Everything from the # on will be ignored, unless it is one of the keywords (see below).
-
-The compiler looks for the ppc386.cfg file in the following places :
-.PP
-\	\fI\- Under Linux\fP
-.br
-\	\	\- The current directory.
-.br
-\	\	\- Home directory, looks for .ppc386.cfg
-.br
-\	\	\- The directory specified in the environment
-.br
-\	\	     variable PPC\_CONFIG\_PATH, and if it's not
-.br
-\	\	     set under /etc.
-.PP
-\	\fI- Under all other OSes:\fP
-.br
-\	\	\- The current directory.
-.br
-\	\	\- The directory specified in the environment
-.br
-\	\	     variable  PPC\_CONFIG\_PATH.
-.br
-\	\	\- The directory where the compiler binary is.
-.br
-
-.PP
-When the compiler has finished reading the configuration file, it continues
-to treat the command line options.
-
-One of the command\-line options allows you to specify a second configuration
-file: Specifying \@foo on the command line will use file foo instead of ppc386.cfg
-and read further options from there. When the compiler has finished reading
-this file, it continues to process the command line.
-
-The configuration file allows some kind of preprocessing. It understands the
-following directives, which you should place on the first column of a line :
-.PP
-
-\	#IFDEF
-.br
-\	#IFNDEF
-.br
-\	#ELSE
-.br
-\	#ENDIF
-.br
-\	#DEFINE
-.br
-\	#UNDEF
-.br
-\	#WRITE
-.br
-\	#INCLUDE
-.br
-\	#SECTION
-.br
-They work the same way as their $...  directive counterparts in Pascal:
-
-.IP \fI#IFDEF\fP
-.RS
-.IP \fISyntax\fP
-#IFDEF name
-
-Lines following #IFDEF are skipped read if the keyword "name"
-following it is not defined.
-
-They are read until the keywords #ELSE or #ENDIF are
-encountered, after which normal processing is resumed.
-
-.IP \fIExample\fP
-#IFDEF VER0_99_12
-.br
-\-Fu/usr/lib/fpc/0.99.12/rtl
-.br
-#ENDIF
-.br
-.PP
-In the above example, /usr/lib/fpc/0.99.12/rtl will be added to
-the path if you're compiling with version 0.99.12 of the compiler.
-.RE
-
-.IP \fI#IFNDEF\fP
-.RS
-.IP \fISyntax\fP
-#IFNDEF name
-
-Lines following #IFDEF are skipped read if the keyword "name"
-following it is defined.
-
-They are read until the keywords #ELSE or #ENDIF are
-encountered, after which normal processing is resumed.
-
-.IP \fIExample\fP
-#IFNDEF VER0_99_12
-.br
--Fu/usr/lib/fpc/0.99.13/rtl
-.br
-#ENDIF
-.PP
-In the above example, /usr/lib/fpc/0.99.13/rtl will be added to
-the path if you're NOT compiling with version 0.99.12 of the compiler.
-.RE
-.IP \fI#ELSE\fP
-.RS
-.IP \fISyntax\fP
-#ELSE
-
-#ELSE can be specified after a #IFDEF or #IFNDEF
-directive as an alternative.
-Lines following #ELSE are skipped read if the preceding #IFDEF
-#IFNDEF was accepted.
-
-They are skipped until the keyword #ENDIF is
-encountered, after which normal processing is resumed.
-
-.IP \fIExample\fP
-
-#IFDEF VER0_99_12
-.br
--Fu/usr/lib/fpc/0.99.12/rtl
-.br
-#ELSE
-.br
--Fu/usr/lib/fpc/0.99.13/rtl
-.br
-#ENDIF
-.br
-.PP
-In the above example, /usr/lib/fpc/0.99.12/rtl will be added to
-the path if you're compiling with version 0.99.12 of the compiler,
-otherwise /usr/lib/fpc/0.99.13/rtl will be added to the path.
-.RE
-.IP \fI#ENDIF\fP
-.RS
-.IP \fISyntax\fP
-#ENDIF
-.PP
-#ENDIF marks the end of a block that started with #IF(N)DEF,
-possibly with an #ELSE between it.
-.RE
-
-.IP \fI#DEFINE\fP
-.RS
-.IP \fISyntax\fP
-#DEFINE name
-.PP
-#DEFINE defines a new keyword. This has the same effect as a
-"\-dname"  command\-line option.
-.RE
-
-.IP \fI#UNDEF\fP
-.RS
-.IP \fISyntax\fP
-#UNDEF name
-
-#UNDEF un-defines a keyword if it existed.
-This has the same effect as a "-uname" command-line option.
-.RE
-
-.IP \fI#WRITE\fP
-.RS
-.IP \fISyntax\fP
-#WRITE Message Text
-
-#WRITE writes "Message Text" to the screen.
-This can be useful to display warnings if certain options are set.
-
-.IP \fIExample\fP
-#IFDEF DEBUG
-.br
-#WRITE Setting debugging ON...
-.br
--g
-.br
-#ENDIF
-.br
-
-.PP
-if "DEBUG is defined, this will produce a line
-
-Setting debugging ON...
-
-and will then switch on debugging information in the compiler.
-.RE
-
-.IP \fI#INCLUDE\fP
-.RS
-.IP \fISyntax\fP
-#INCLUDE filename
-
-#INCLUDE instructs the compiler to read the contents of
-"filename" before continuing to process options in the current file.
-
-This can be useful if you want to have a particular configuration file
-for a project (or, under Linux, in your home directory), but still want to
-have the global options that are set in a global configuration file.
-
-.IP \fIExample\fP
-#IFDEF LINUX
-.br
-  #INCLUDE /etc/ppc386.cfg
-.br
-#ELSE
-.br
-  #IFDEF GO32V2
-.br
-    #INCLUDE c:\\pp\\bin\\ppc386.cfg
-.br
-  #ENDIF
-.br
-#ENDIF
-.br
-.PP
-This will include /etc/ppc386.cfg if you're on a linux machine,
-and will include c:\\pp\\bin\\ppc386.cfg on a dos machine.
-.RE
-.IP \fI#SECTION\fP
-.RS
-.IP \fISyntax\fP
-#SECTION name
-
-The #SECTION directive acts as a #IFDEF directive, only
-it doesn't require an #ENDIF directive. the special name COMMON
-always exists, i.e. lines following #SECTION COMMON are always read.
-.RE
-
-.SH Example
-
-A standard block often used in (the Linux version of) ppc386.cfg is
-
--vwhin
-.br
-#IFDEF VER0_99_12
-.br
- #IFDEF FPC_LINK_STATIC
-.br
-  \-Fu/usr/lib/fpc/0.99.12/rtl/static
-.br
-  \-Fu/usr/lib/fpc/0.99.12/units/static
-.br
- #ENDIF
-.br
- #IFDEF FPC_LINK_DYNAMIC
-.br
-  \-Fu/usr/lib/fpc/0.99.12/rtl/shared
-.br
-  \-Fu/usr/lib/fpc/0.99.12/units/shared
-.br
- #ENDIF
-.br
- \-Fu/usr/lib/fpc/0.99.12/rtl
-.br
- \-Fu/usr/lib/fpc/0.99.12/units
-.br
-#ENDIF
-.PP
-The block is copied into the ppc386.cfg file for each version you use (normally
-the latest release (0.99.12 is released any day now) and the lastest developpers
-snapshot (which will be version 0.99.13, even numbers are releases, odd are
-development versions).
-
-.SH SEE ALSO
-.BR  ppc386 (1)

docs/ppudump.1

@@ -1,51 +0,0 @@
-.TH ppudump 1 "5 June 1999" FreePascal "Free Pascal Unit dump utility"
-.SH NAME
-ppudump \- The FPC Pascal unit dump program.
-
-.SH SYNOPSIS
-
-\fIppudump\fP [-h] [-v[h|i|m|d|s|b|a]] ppu-file1 ppufile2 ...
-
-.SH Description
-
-\fIppudump\fP writes the contents of a Free Pascal unit file to standard
-output. It gives a listing of all definitions in the unit file. The format
-of the listing can be controlled by the options.
-
-.SH Usage
-
-You can invoke ppudump with as arguments the names of the units that you
-want to dump. You need not specify a extension, by default \fI.ppu\fP is
-assumed. The output goes to standard output.
-
-.SH Options
-
-\fIppudump\fP has only two options:
-
-.IP \fI\-h\fP 
-shows a short help screen.
-.IP \fI\-v\fP
-Controls the level of verbosity. \-v accepts any combination of the following 
-letters behind it:
-.RS
-.IP \fIa\fP
-Shows all information stored in the PPU file.
-.IP \fIb\fP
-Shows the browser information in the PPU file (if present).
-.IP \fId\fP
-Shows the definitions in the PPU file.
-.IP \fIh\fP 
-Shows the header information in the PPU file.
-.IP \fIi\fP
-Shows only interface information, implementation information is
-not shown.
-.IP \fIm\fP
-Shows only implementation information, interface interface is not shown.
-.IP \fIs\fP
-Shows the symbols stored in the PPU file.
-.RE
-
-.SH SEE ALSO
-.IP 
-.BR  ppc386 (1)
-.BR  ppumove (1)

docs/ptop.1

@@ -1,75 +0,0 @@
-.TH ptop 1 "30 may 1999" FreePascal "ptop source beautifier"
-.SH NAME
-ptop \- The FPC Pascal configurable source beautifier.
-
-Origin probably Pascal\-TO\-Pascal.
-
-.SH SYNOPSIS
-
-\fIptop\fP "[-v] [-i indent] [-b bufsize ][-c optsfile] infile outfile"
-
-.SH Description
-
-\fIptop\fP is a more or less configurable \fIsource beautifier\fP for pascal sources,
-and specially the ones supported by FPC (which are more or less TurboPascal or
-Delphi 2.0 compatible).
-.PP
-ptop belongs to the \fIFPC utils\fP package, which currently also contains ppdep, h2pas, ppudump
-and ppumove.
-
-.SH Usage
-
-ptop basically reformats "infile" and outputs the result to "outfile". ptop uses
-a configuration file explained further below, and can generate a default
-configurationfile for you to edit. (not needed if you use the defaults)
-
-.SH Options
-.IP \-h
-Writes a short description of these switches.
-.IP \-c
-read options from configuration file. A configuration file is not needed, ptop
-will revert to internal defaults then. See also \-g
-.IP \-i ident
-Sets the number of indent spaces used for BEGIN END; and other blocks.
-.IP \-b bufsize
-Sets the buffersize to bufsize. Default 255, 0 is considered non\-valid and ignored.
-.IP \-v
-be verbose. Currently only outputs the number of lines read/written and some error messages.
-.IP \-g ptop.cfg
-Writes a default configuration file to be edited to the file "ptop.cfg"
-.PP
-Try to play with ptop and its configfile until you find the effect you desire. The
-configurability and possibilities of ptop are quite large compared to shareware
-source beautifier found on e.g. SIMTEL.
-.PP
-
-.SH Acknowledgements
-
-The writer of the program, Michael van Canneyt, who also helped out explaining
-the format of ptop.cfg.
-.PP
-Questions/corrections can be mailed to fpc\[email protected]
-.PP
-Also thanks to the rest of the FPC development team.
-
-The program is a modernized (OOP, Streams, Delphi extensions) version based on a
-program by Peter Grogono, who in turn based his program on a Pascal pretty-printer written by Ledgard,
-Hueras, and Singer.  See SIGPLAN Notices, Vol. 12, No. 7, July 1977,
-pages 101-105, and PP.DOC/HLP.
-.BR
-This version of PP developed under Pascal/Z V4.0 or later.
-Very minor modifications for Turbo Pascal made by Willett Kempton
-March 1984 and Oct 84.  Runs under 8-bit Turbo or 16-bit Turbo.
-Toad Hall tweak, rewrite for TP 5, 28 Nov 89
-
-
-.SH SEE ALSO
-.IP "ptop config file"
-.BR ptop.cfg (5)
-.IP "Compiler"
-.BR  ppc386 (1)
-.IP "Other FPC utils"
-.BR  ppdep (1)
-.BR  ppudump (1)
-.BR  ppumove (1)
-.BR  h2pas (1)

docs/ptop.cfg.5

@@ -1,185 +0,0 @@
-.TH ptop.cfg 5 "31 may 1999" FreePascal "ptop source beautifier config file"
-.SH NAME
-ptop.cfg \- The ptop source\-beautifier configuration file.
-
-ptop is the source beautifier of the FreePascal project.
-
-Origin probably Pascal\-TO\-Pascal.cfg
-
-.SH DESCRIPTION
-This is the main configuration file of the
-.I ptop FPC source beautifier
-.PP
-The configuration file for
-.BR ptop (1)
-isn't necessarily called ptop.cfg, and is also
-not auto-loaded, so the name doesn't matter much. This man\-page describes
-the structure of such a configuration file for
-.BR ptop (1)
-
-.SH Structure
-
-The structure of a ptop configuration file is a simple buildingblock repeated several (20-30) times,
-for each pascal keyword known to the ptop program. (see the default configuration file or ptopu.pp source to
-find out which keywords are known)
-.PP
-The basic building block of the configuration file consists out of one or two lines,
-describing how ptop should react on a certain keyword.
-First a line without square brackets with the following format:
-.PP
-keyword=option1,option2,option3,...
-.PP
-If one of the options is "dindonkey" (see further below), a second line
-(with square brackets) is needed like this:
-.PP
-[keyword]=otherkeyword1,otherkeyword2,otherkeyword3,...
-.PP
-As you can see the block contains two types of identifiers, keywords(keyword and otherkeyword1..3 in above example)
-and options, (option1..3 above).
-.PP
-\fIKeywords\fP
-are the built-in valid Pascal structure-identifiers like BEGIN, END, CASE, IF,
-THEN, ELSE, IMPLEMENTATION. The default configuration file lists most of these.
-.PP
-Besides the real Pascal keywords, some other codewords are used for operators
-and comment expressions. These are listed in the following table:
-
-Name of codeword\	\	operator
-.br
--------------\	\	\	-----
-.br
-casevar\	\	\	\	: in a case label (<>'colon')
-.br
-becomes\	\	\	\	:=
-.br
-delphicomment\	\	\	//
-.br
-opencomment\	\	\	{ or (*
-.br
-closecomment\	\	\	} or *)
-.br
-semicolon\	\	\	\	;
-.br
-colon\	\	\	\	:
-.br
-equals\	\	\	\	=
-.br
-openparen\	\	\	\	[
-.br
-closeparen\	\	\	]
-.br
-period\	\	\	\	.
-.PP
-
-The \fIOptions\fP codewords define actions to be taken when the keyword before
-the equal sign is found.
-.PP
-Option	\	\	does what
-.br
--------\	\	\	---------
-.br
-crsupp\	\	\	suppress CR before the keyword.
-.br
-crbefore\	\	\	force CR before keyword
-\	\	\	\	(doesn't go with crsupp :) )
-.br
-blinbefore\	\	blank line before keyword.
-.br
-dindonkey\	\	\	de\-indent on assiociated keywords
-\	\	\	\	(see below)
-.br
-dindent\	\	\	deindent (always)
-.br
-spbef\	\	\	space before
-.br
-spaft\	\	\	space after
-.br
-gobsym\	\	\	Print symbols which follow a
-.br
-\	\	\	\	keyword but which do not
-.br
-\	\	\	\	affect layout. prints until
-.br
-\	\	\	\	terminators occur.
-.br
-\	\	\	\	(terminators are hard-coded in pptop,
-.br
-\	\	\	\	still needs changing)
-.br
-inbytab\	\	\	indent by tab.
-.br
-crafter\	\	\	force CR after keyword.
-.br
-upper\	\	\	prints keyword all uppercase
-.br
-lower\	\	\	prints keyword all lowercase
-.br
-capital\	\	\	capitalizes keyword: 1st letter
-.br
-\	\	\	\	uppercase, rest lowercase.
-.PP
-
-The option "dindonkey" requires some extra parameters, which are
-set by a second line for that keyword (the one with the square brackets), which is
-therefore only needed if the options contain "dinkdonkey" (contraction of
-de\-indent on assiociated keyword).
-.PP
-"dinkdonkey" deindents if any of the keywords specified by the extra options of the
-square-bracket line is found.
-.PP
-.SH Example
-
-The line
-
-else=crbefore,dindonkey,inbytab,upper
-.br
-[else]=if,then,else
-.PP
-
-Means:
-
-The keyword this is about is
-.I else
-, it's on the LEFT side of both equal signs.
-.PP
-
-When the ptop parser finds ELSE, the options tell it to do the following
-things:
-
-\- (crbefore) Don't allow other code on the line before
-.br
-\   the keyword. (ELSE alone on a line)
-.br
-\- (dindonkey) De\-indent on the keywords
-.br
-\	in square brackets line (if,then,else)
-.br
-\- (inbytab) indent by tab.
-.br
-\- (upper) uppercase the keyword (ELSE)
-.PP
-
-Try to play with the configfile until you find the effect you desire. The
-configurability and possibilities of ptop are quite large compared to shareware
-source beautifier found on e.g. SIMTEL.
-.PP
-
-.SH Acknowledgements
-
-The writer of the program, Michael van Canneyt, who also helped out explaining
-the format of ptop.cfg.
-.PP
-Questions/corrections can be mailed to fpc\[email protected]
-.PP
-Also thanks to the rest of the FPC development team.
-
-.SH SEE ALSO
-.IP "ptop binary"
-.BR ptop (1)
-.IP "Compiler"
-.BR  ppc386 (1)
-.IP "Other FPC utils"
-.BR  ppdep (1)
-.BR  ppudump (1)
-.BR  ppumove (1)
-.BR  h2pas (1)