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