mirror of
https://github.com/michaelrsweet/pdfio.git
synced 2025-08-29 15:22:06 +02:00
Update build docos.
This commit is contained in:
79
doc/pdfio.3
79
doc/pdfio.3
@@ -46,6 +46,10 @@ A C99 compiler such as Clang, GCC, or MS Visual C
|
||||
.PP
|
||||
A POSIX\-compliant make program
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
A POSIX\-compliant sh program
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
ZLIB (https://www.zlib.net) 1.0 or higher
|
||||
@@ -55,10 +59,11 @@ ZLIB (https://www.zlib.net) 1.0 or higher
|
||||
IDE files for Xcode (macOS/iOS) and Visual Studio (Windows) are also provided.
|
||||
.SS Installing pdfio
|
||||
.PP
|
||||
PDFio comes with a portable makefile that will work on any POSIX\-compliant system with ZLIB installed. To make it, run:
|
||||
PDFio comes with a configure script that creates a portable makefile that will work on any POSIX\-compliant system with ZLIB installed. To make it, run:
|
||||
.nf
|
||||
|
||||
make all
|
||||
\./configure
|
||||
make
|
||||
.fi
|
||||
.PP
|
||||
To test it, run:
|
||||
@@ -70,78 +75,28 @@ To test it, run:
|
||||
To install it, run:
|
||||
.nf
|
||||
|
||||
make install
|
||||
sudo make install
|
||||
.fi
|
||||
.PP
|
||||
If you want a shared library, run:
|
||||
.nf
|
||||
|
||||
make all\-shared
|
||||
make install\-shared
|
||||
\./configure \-\-enable\-shared
|
||||
make
|
||||
sudo make install
|
||||
.fi
|
||||
.PP
|
||||
The default installation location is "/usr/local". Pass the prefix variable to make to install it to another location:
|
||||
The default installation location is "/usr/local". Pass the \-\-prefix option to make to install it to another location:
|
||||
.nf
|
||||
|
||||
make install prefix=/some/other/directory
|
||||
\./configure \-\-prefix=/some/other/directory
|
||||
.fi
|
||||
.PP
|
||||
The makefile installs the pdfio header to "${prefix}/include", the library to "${prefix}/lib", the pkg\-config file to "${prefix}/lib/pkgconfig", the man page to "${prefix}/share/man/man3", and the documentation to "${prefix}/share/doc/pdfio".
|
||||
.PP
|
||||
The makefile supports the following variables that can be specified in the make command or as environment variables:
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
AR: the library archiver (default "ar")
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
ARFLAGS: options for the library archiver (default "cr")
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
CC: the C compiler (default "cc")
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
CFLAGS: options for the C compiler (default "")
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
CODESIGN_IDENTITY: the identity to use when code signing the shared library on macOS (default "Developer ID")
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
COMMONFLAGS: options for the C compiler and linker (typically architecture and optimization options, default is "\-Os \-g")
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
CPPFLAGS: options for the C preprocessor (default "")
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
DESTDIR and DSTROOT: specifies a root directory when installing (default is "", specify only one)
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
DSOFLAGS: options for the C compiler when linking the shared library (default "")
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
LDFLAGS: options for the C compiler when linking the test programs (default "")
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
LIBS: library options when linking the test programs (default "\-lz")
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
RANLIB: program that generates a table\-of\-contents in a library (default "ranlib")
|
||||
|
||||
.IP \(bu 5
|
||||
.PP
|
||||
prefix: specifies the installation directory (default "/usr/local")
|
||||
|
||||
Other configure options can be found using the \-\-help option:
|
||||
.nf
|
||||
|
||||
\./configure \-\-help
|
||||
.fi
|
||||
.SS Visual Studio Project
|
||||
.PP
|
||||
The Visual Studio solution ("pdfio.sln") is provided for Windows developers and generates both a static library and DLL.
|
||||
|
Reference in New Issue
Block a user