Selaa lähdekoodia

+ Some updates to man pages and new pages

michael 21 vuotta sitten
vanhempi
commit
18ddd050d0

+ 73 - 0
install/man/man1/bin2obj.1

@@ -0,0 +1,73 @@
+.TH bin2obj 1 "12 November 2004" "Free Pascal" "Binary to include file converter"
+.SH NAME 
+bin2obj \- The Free Pascal binary to pascal include file converter.
+
+.SH SYNOPSIS
+
+.B bin2obj [-aeouUz] -c constname infile
+
+.SH DESCRIPTION
+
+.B bin2obj
+reads a binary file and converts it to a pascal typed constant declaration. 
+The constant is an array of bytes (zero based), in which each byte has the
+value of the byte at the offset
+.I index
+in the file. (index is the index in the array).
+
+.SH USAGE
+
+.B bin2obj
+accepts a filenames of a binary file, and needs the name of a constant
+(use the 
+.B \-c
+option). The output goes to standard output by default. If no unitname is
+given, the output will be in the form of code which can be written to an
+include file. 
+
+.SH OPTIONS
+bin2obj has a small number of options to control its behaviour:
+
+.TP
+.B \-a
+Write ASCII data instead of bytes. The constant array will be an array of 
+char instead of an array of bytes. The bytes will be written as ASCII
+constants.
+.TP
+.B \-e key
+If this option is given, the data will be encrypted with 
+.I key
+which is a string of 8 characters long.
+.TP
+.B \-h
+emit a small helptext.
+.TP
+.B \-o filename
+By default, the output goes to standard output (the screen). If this option is given, 
+.B bin2obj
+will write the output to a file with name
+.I filename
+instead. This option is mandatory if the
+.B \-U
+option is specified.
+.TP
+.B \-u [unitname]
+This option tells
+.B bin2obj
+to generate a unit. By default the output is just the declaration of the
+constant. If the unitname is not specified, 
+.B bin2obj
+tries to determine it from the input filename.
+.TP
+.B \-U [unitname]
+The same as the
+.B -u
+option, only bin2obj will also call the compiler and compile the unit.
+.TP
+.B \-z
+Compress the data before creating the unit. zlib compression is used.
+
+.SH SEE ALSO
+.IP 
+.BR  ppc386 (1)
+.BR  data2inc (1)

+ 44 - 1
install/man/man1/fpcmake.1

@@ -4,7 +4,7 @@ fpcmake \- The Free Pascal makefile constructor program.
 
 .SH SYNOPSIS
 
-.B fpcmake [filename [filename [filename]]]
+.B fpcmake [-Ttarget] [-pwhrqv] [filename [filename [filename]]]
 
 .SH DESCRIPTION
 
@@ -41,6 +41,49 @@ for a description of the format of the
 .I Makefile.fpc
 file.
 
+.SH OPTIONS
+fpcmake has a small number of options to control it's behaviour:
+
+.TP
+.B \-h
+Emit a short help text describing the use of
+.B fpcmake
+.TP
+.B \-p
+If this option is given, a package description file is generated as well as
+a makefile.
+.TP
+.B \-q
+Tells 
+.B fpcmake
+to be more quiet, i.e. emit less messages.
+.TP
+.B \-r
+If this option is given, 
+.B fpcmake
+will recursively scan subdirectories for 
+.B makefile.fpc
+files and generate makefiles for them.
+.TP
+.B \-T
+Specifies the targets for which 
+.B fpcmake 
+should generate makefiles. This can be a comma-separated list of target
+systems, or the special identifier
+.I all
+which indicates that a makefile should be generated for all supported
+platforms.
+.TP
+.B \-v
+This option instructs
+.B fpcmake
+to be more verbose.
+.TP
+.B \-w
+This is the standard option and tells
+.B fpcmake
+to generate a makefile.
+
 .SH SEE ALSO
 .IP 
 .BR  fpcmake (5)

+ 30 - 5
install/man/man1/fpdoc.1

@@ -7,7 +7,8 @@ fpdoc \- The FPC Pascal unit documentation generator.
 \fBfpdoc\fP --input=inputcommand [--output=output] [--format=fmt] 
 [--descr=descriptionfile] [--show-private] [--hide-protected]
 [--lang=language] [--content=contentfile] [--import=importfile]
-[--package=packagename] [--html-search=searchpage]
+[--package=packagename] [--html-search=searchpage] [--ostarget=target]
+[--cpu-target=target] [--latex-extension=ext] [--latex-highlight]
 
 .SH Description
 
@@ -16,13 +17,15 @@ scans a Free Pascal unit source file and generates documentation for it.
 The documentation can be in various formats (currently HTML and LaTeX)
 It can read various description files which contain the description for the 
 various symbols found in the unit file.
+
 .SH Usage
 
 You can invoke 
 .B fpdoc
-with as the only required argument the 'input' argument. It should at least
-contain the name of the unit file for which documentation should be
-generated. 
+with as the only required argument the 'input' and 'package' arguments. 
+It should at least contain the name of the unit file for which 
+documentation should be generated and the name of the package to which the
+unit belongs.
 
 .SH Options
 
@@ -117,6 +120,13 @@ French.
 Dutch.
 .RE
 .TP
+.BI \-\-latex\-extension=ext
+Sets the extension to use for the LaTeX file to
+.I ext
+the default is 
+.BI .tex
+(with . (dot) included).
+.TP
 .BI \-\-latex\-highlight
 Switches on an internam latex syntax highlighter. This is not yet
 implemented. By default, syntax highlighting is provided by the syntax
@@ -133,15 +143,30 @@ filename for the tex file. For all other formats,
 .B name
 is interpreted as
 the directory where all documentation files will be written. The directory
-will be created if it does not yet exist.
+will be created if it does not yet exist. Standard this equals the package
+name.
+.TP
+.BI \-\-package=packagename 
+Specifies the package name. All units will be documented as part of 
+.I packagename
+, which is also the default output filename or directory. Only documentation
+nodes inside a package node with this name will be considered when
+documenting.
 .TP
 .BI \-\-show\-private 
 By default, no documentation is generated for private methods or fields.
 This option causes 
 .B fpdoc
 to generate documentation for these methods as well.
+.TP
+.BI \-\-warn\-no\-node 
+If this option is specified, 
+.B fpdoc
+will emit a warning if it does not find a description node for an identifier
+it is documenting.
 
 .SH SEE ALSO
 .IP 
 .BR  ppc386 (1)
 .BR  latex (1)
+.BR  makeskel (1)

+ 144 - 0
install/man/man1/makeskel.1

@@ -0,0 +1,144 @@
+.TH makeskel 1 "11 November 2004" "Free Pascal" "FPC unit description file generator"
+.SH NAME
+makeskel \- generate description file for 
+.B fpdoc.
+
+.SH SYNOPSIS
+
+\fBmakeskel\fP [--descr=filename] [--disable-arguments] 
+[--disable-errors] [--disable-function-results] 
+[--disable-private] [--disable-protected] 
+[--disable-seealso] [--emit-class-separator] 
+[--help] [--lang=language] [--output=filename] 
+[--update]
+--package=name --input=cmdline
+
+.SH Description
+
+.B makeskel
+scans a Free Pascal unit source file and generates a skeleton description
+file for it. It generates nodes for all identifiers found in the interface
+section of the unit, although this behaviour can be adjusted with some
+options. It can also update an existing XML file, and then emits only nodes
+for identifiers for which no node exists yet.
+
+.SH Usage
+
+You can invoke 
+.B makeskel
+with as the only required arguments the 
+.B input
+and
+.B package
+arguments. It should at least contain the name of the unit file for which 
+documentation should be generated and the name of the package to which the
+unit belongs. The output of 
+.B makeskel 
+will go to standard output by default.
+
+.SH Options
+
+.B makeskel
+has many options, most of them optional, defaults will be used in most
+cases.
+
+.TP
+.BI \-\-descr=descfile
+This option must be used in conjunction with the 
+.I update 
+option. It specifies the name of a description file
+.B descfile
+which must be updated. Note that the file must contain valid XML, or the
+update will fail. This option can be specified more than once.
+.TP
+.BI \-\-disable-arguments
+If this option is specified, 
+.B makeskel
+will not emit nodes for the arguments of functions and procedures. By
+default, documentation nodes are emitted for functions and procedures as
+well.
+.TP
+.BI \-\-disable-errors
+By default, each documentation node will contain a 
+.I errors
+node as well (excep for identifiers where this has no use, such as function
+arguments). If this option is specified, no 
+.I errors
+node will be generated.
+.TP
+.BI \-\-disable-function-results
+By default, for functions, a 
+.I result
+node will be generated, to describe the result of the function. If this
+option is specified, no function result node will be generated.
+.TP
+.BI \-\-disable-private
+By default, documentation nodes are also generated for private fields or methods 
+of a class. if this option is specified, the generation of nodes for private
+fields or methods is skipped.
+.TP
+.B \-\-disable-protected
+By default, documentation nodes are also generated for protected fields or
+methods of a class. if this option is specified, the generation of nodes 
+for protected fields or methods is skipped.
+.TP
+.B \-\-emit-class-separator
+If this option is specified, a visible comment with the name of the class
+for which documentation nodes will follow, is inserted between the nodes
+of two classes, making navigation easier.
+.TP
+.BI \-\-help
+Emit a short help text and exit.
+.TP
+.BI \-\-input=cmd
+The input (source) file to process. Multiple input files can be specified.
+The command may contain valid compiler options, currently the 
+.I \-Fipath
+(search path) and
+.I \-dmacro
+(define macro) options are recognized. 
+.TP
+.BI \-\-lang=language
+Sets the language for the output file. This will mainly set the strings used
+for the headers in various parts of the documentation files (by default
+they're in english). Currently, valid options are
+.RS
+.TP
+.I de 
+German.
+.TP
+.I fr
+French.
+.TP
+.I nl
+Dutch.
+.RE
+.TP
+.BI \-\-output=filename 
+This option tells 
+.B makeskel
+where the output should go. If this option is not specified, the output is
+sent to standard output (the screen).
+.TP
+.BI \-\-package=packagename
+This option is required. It specifies the name of the package. All nodes
+will be generated inside a node with 
+.B name 
+attribute
+.I packagename.
+.TP
+.BI \-\-update
+Turns on update mode. In this mode, the output is a file which contains only
+the missing nodes to complete the documentation of the input files. The
+existing nodes must be specified with the
+.B descr
+argument. Note that the output file may 
+.I not
+be the same as the input (description) nodes; A separate file must be
+specified (or no file, in which case output goes to standard output.
+
+.SH SEE ALSO
+.IP 
+.BR  ppc386 (1)
+.BR  latex (1)
+.BR  fpdoc (1)

+ 74 - 0
install/man/man1/postw32.1

@@ -0,0 +1,74 @@
+.TH delp 1 "12 Dec 1999" "Free Pascal" "FPC Windows binary post\-processor"
+.SH NAME
+postw32 \- Free Pascal Windows 32\-bit executable post processor.
+
+.SH SYNOPSIS
+
+.B postw32 [-vh] [-m subsystem] [-i file] [-V version] [-s size]
+
+.SH DESCRIPTION
+
+.B postw32
+does some post-processing on a Windows 32 bit executable file or library.
+It can set the windows subsystem, stack size, and file version.
+
+.SH USAGE
+
+.B postw32
+needs at least 2 options. One is the input filename (option
+.B -i
+) and the other is one of the possible operations, with their arguments.
+
+.SH OPTIONS
+
+takes the following options at this time:
+.TP
+.B \-i file
+specifies the input file to process. This option is a short notation for the
+.B --input
+option.
+.TP
+.B \-h 
+Displays a short help message. This option is a short notation for the 
+.B --help
+option.
+.TP
+.B \-m subsystem
+Set the subsystem (the application type) to either 
+.i gui
+or
+.i console
+Note that a gui application which writes to the command-line will cause an
+error. This option is a short notation for the
+.B \-\-subsystem
+option.
+.TP
+.B \-s size
+Set the stack size to 
+.I size
+bytes. This option is a short notation for the
+.B \-\-stack 
+option.
+.TP
+.B \-v
+Be verbose about the operations that are performed. This option is a short
+notation for the
+.B \-\-verbose
+option.
+.TP
+.B \-V M.N
+Set the version of the file to 
+.I M.N
+, where 
+.I M
+and 
+.I N
+are 16 bit unsigned values. This option is a short notation for the
+.B \-\-version
+option.
+
+
+.SH SEE ALSO
+.IP 
+.BR  fpc (1)
+.BR  ppc386 (1)