mirror of
https://github.com/michaelrsweet/pdfio.git
synced 2025-10-07 19:24:42 +02:00
Update docos.
This commit is contained in:
73
doc/pdfio.3
73
doc/pdfio.3
@@ -1,4 +1,4 @@
|
||||
.TH pdfio 3 "pdf read/write library" "2025-09-30" "pdf read/write library"
|
||||
.TH pdfio 3 "pdf read/write library" "2025-10-05" "pdf read/write library"
|
||||
.SH NAME
|
||||
pdfio \- pdf read/write library
|
||||
.SH Introduction
|
||||
@@ -3999,8 +3999,31 @@ This function creates a new PDF file. The "filename" argument specifies the
|
||||
name of the PDF file to create.
|
||||
.PP
|
||||
The "version" argument specifies the PDF version number for the file or
|
||||
\fBNULL\fR for the default ("2.0"). The value "PCLm-1.0" can be specified to
|
||||
produce the PCLm subset of PDF.
|
||||
\fBNULL\fR for the default ("2.0"). The following values are recognized:
|
||||
.PP
|
||||
.IP \(bu 5
|
||||
"1.3", "1.4", "1.5", "1.6", "1.7", "2.0": Generic PDF files of the
|
||||
specified versions.
|
||||
.IP \(bu 5
|
||||
"PCLm-1.0": The PCLm (raster) subset of PDF supported by some printers.
|
||||
.IP \(bu 5
|
||||
"PDF/A-1a": PDF/A-1a:2005
|
||||
.IP \(bu 5
|
||||
"PDF/A-1b": PDF/A-1b:2005
|
||||
.IP \(bu 5
|
||||
"PDF/A-2a": PDF/A-2a:2011
|
||||
.IP \(bu 5
|
||||
"PDF/A-2b": PDF/A-2b:2011
|
||||
.IP \(bu 5
|
||||
"PDF/A-2u": PDF/A-2u:2011
|
||||
.IP \(bu 5
|
||||
"PDF/A-3a": PDF/A-3a:2012
|
||||
.IP \(bu 5
|
||||
"PDF/A-3b": PDF/A-3b:2012
|
||||
.IP \(bu 5
|
||||
"PDF/A-3u": PDF/A-3u:2012
|
||||
.IP \(bu 5
|
||||
"PDF/A-4": PDF/A-4:2020
|
||||
.PP
|
||||
The "media_box" and "crop_box" arguments specify the default MediaBox and
|
||||
CropBox for pages in the PDF file - if \fBNULL\fR then a default "Universal" size
|
||||
@@ -4083,6 +4106,9 @@ specifies the font nane:
|
||||
Aside from "Symbol" and "Zapf-Dingbats", Base fonts use the Windows CP1252
|
||||
(ISO-8859-1 with additional characters such as the Euro symbol) subset of
|
||||
Unicode.
|
||||
.PP
|
||||
.IP 5
|
||||
Note: This function cannot be used when producing PDF/A files.
|
||||
.SS pdfioFileCreateFontObjFromData
|
||||
Add a font in memory to a PDF file.
|
||||
.PP
|
||||
@@ -4166,8 +4192,12 @@ the image is encoded in the corresponding device color space. The
|
||||
"interpolate" parameter specifies whether to interpolate when scaling the
|
||||
image on the page.
|
||||
.PP
|
||||
.IP 5
|
||||
Note: When creating an image object with alpha, a second image object is
|
||||
created to hold the "soft mask" data for the primary image.
|
||||
.IP 5
|
||||
created to hold the "soft mask" data for the primary image. PDF/A-1
|
||||
.IP 5
|
||||
files do not support alpha-based transparency.
|
||||
.SS pdfioFileCreateImageObjFromFile
|
||||
Add an image object to a PDF file from a file.
|
||||
.PP
|
||||
@@ -4185,11 +4215,9 @@ the "interpolate" parameter specifies whether to interpolate when scaling the
|
||||
image on the page.
|
||||
.PP
|
||||
.IP 5
|
||||
Note: Currently PNG support is limited to grayscale, RGB, or indexed files
|
||||
Note: PNG files containing transparency cannot be used when producing
|
||||
.IP 5
|
||||
without interlacing or alpha. Transparency (masking) based on color/index
|
||||
.IP 5
|
||||
is supported.
|
||||
PDF/A files.
|
||||
.SS pdfioFileCreateNameObj
|
||||
Create a new object in a PDF file containing a name.
|
||||
.PP
|
||||
@@ -4257,9 +4285,32 @@ written:
|
||||
.fi
|
||||
|
||||
The "version" argument specifies the PDF version number for the file or
|
||||
\fBNULL\fR for the default ("2.0"). Unlike \fIpdfioFileCreate\fR and
|
||||
\fIpdfioFileCreateTemporary\fR, it is generally not safe to pass the
|
||||
"PCLm-1.0" version string.
|
||||
\fBNULL\fR for the default ("2.0"). The following values are recognized:
|
||||
.PP
|
||||
.IP \(bu 5
|
||||
"1.3", "1.4", "1.5", "1.6", "1.7", "2.0": Generic PDF files of the
|
||||
specified versions.
|
||||
.IP \(bu 5
|
||||
"PDF/A-1a": PDF/A-1a:2005
|
||||
.IP \(bu 5
|
||||
"PDF/A-1b": PDF/A-1b:2005
|
||||
.IP \(bu 5
|
||||
"PDF/A-2a": PDF/A-2a:2011
|
||||
.IP \(bu 5
|
||||
"PDF/A-2b": PDF/A-2b:2011
|
||||
.IP \(bu 5
|
||||
"PDF/A-2u": PDF/A-2u:2011
|
||||
.IP \(bu 5
|
||||
"PDF/A-3a": PDF/A-3a:2012
|
||||
.IP \(bu 5
|
||||
"PDF/A-3b": PDF/A-3b:2012
|
||||
.IP \(bu 5
|
||||
"PDF/A-3u": PDF/A-3u:2012
|
||||
.IP \(bu 5
|
||||
"PDF/A-4": PDF/A-4:2020
|
||||
.PP
|
||||
Unlike \fIpdfioFileCreate\fR and \fIpdfioFileCreateTemporary\fR, it is
|
||||
generally not safe to pass the "PCLm-1.0" version string.
|
||||
.PP
|
||||
The "media_box" and "crop_box" arguments specify the default MediaBox and
|
||||
CropBox for pages in the PDF file - if \fBNULL\fR then a default "Universal" size
|
||||
|
105
doc/pdfio.html
105
doc/pdfio.html
@@ -4222,10 +4222,33 @@ profile using the "cond_id" value.
|
||||
name of the PDF file to create.<br>
|
||||
<br>
|
||||
The "version" argument specifies the PDF version number for the file or
|
||||
<code>NULL</code> for the default ("2.0"). The value "PCLm-1.0" can be specified to
|
||||
produce the PCLm subset of PDF.<br>
|
||||
<br>
|
||||
The "media_box" and "crop_box" arguments specify the default MediaBox and
|
||||
<code>NULL</code> for the default ("2.0"). The following values are recognized:
|
||||
|
||||
</p><ul>
|
||||
<li>"1.3", "1.4", "1.5", "1.6", "1.7", "2.0": Generic PDF files of the
|
||||
specified versions.
|
||||
</li>
|
||||
<li>"PCLm-1.0": The PCLm (raster) subset of PDF supported by some printers.
|
||||
</li>
|
||||
<li>"PDF/A-1a": PDF/A-1a:2005
|
||||
</li>
|
||||
<li>"PDF/A-1b": PDF/A-1b:2005
|
||||
</li>
|
||||
<li>"PDF/A-2a": PDF/A-2a:2011
|
||||
</li>
|
||||
<li>"PDF/A-2b": PDF/A-2b:2011
|
||||
</li>
|
||||
<li>"PDF/A-2u": PDF/A-2u:2011
|
||||
</li>
|
||||
<li>"PDF/A-3a": PDF/A-3a:2012
|
||||
</li>
|
||||
<li>"PDF/A-3b": PDF/A-3b:2012
|
||||
</li>
|
||||
<li>"PDF/A-3u": PDF/A-3u:2012
|
||||
</li>
|
||||
<li>"PDF/A-4": PDF/A-4:2020</li>
|
||||
</ul>
|
||||
<p class="discussion">The "media_box" and "crop_box" arguments specify the default MediaBox and
|
||||
CropBox for pages in the PDF file - if <code>NULL</code> then a default "Universal" size
|
||||
of 8.27x11in (the intersection of US Letter and ISO A4) is used.<br>
|
||||
<br>
|
||||
@@ -4312,7 +4335,10 @@ specifies the font nane:
|
||||
</ul>
|
||||
<p class="discussion">Aside from "Symbol" and "Zapf-Dingbats", Base fonts use the Windows CP1252
|
||||
(ISO-8859-1 with additional characters such as the Euro symbol) subset of
|
||||
Unicode.</p>
|
||||
Unicode.<br>
|
||||
<br>
|
||||
</p><blockquote>
|
||||
Note: This function cannot be used when producing PDF/A files.</blockquote>
|
||||
<h3 class="function"><span class="info"> PDFio v1.6 </span><a id="pdfioFileCreateFontObjFromData">pdfioFileCreateFontObjFromData</a></h3>
|
||||
<p class="description">Add a font in memory to a PDF file.</p>
|
||||
<p class="code">
|
||||
@@ -4428,8 +4454,10 @@ the image is encoded in the corresponding device color space. The
|
||||
"interpolate" parameter specifies whether to interpolate when scaling the
|
||||
image on the page.<br>
|
||||
<br>
|
||||
</p><blockquote>
|
||||
Note: When creating an image object with alpha, a second image object is
|
||||
created to hold the "soft mask" data for the primary image.</p>
|
||||
created to hold the "soft mask" data for the primary image. PDF/A-1
|
||||
files do not support alpha-based transparency.</blockquote>
|
||||
<h3 class="function"><a id="pdfioFileCreateImageObjFromFile">pdfioFileCreateImageObjFromFile</a></h3>
|
||||
<p class="description">Add an image object to a PDF file from a file.</p>
|
||||
<p class="code">
|
||||
@@ -4452,9 +4480,8 @@ the "interpolate" parameter specifies whether to interpolate when scal
|
||||
image on the page.<br>
|
||||
<br>
|
||||
</p><blockquote>
|
||||
Note: Currently PNG support is limited to grayscale, RGB, or indexed files
|
||||
without interlacing or alpha. Transparency (masking) based on color/index
|
||||
is supported.</blockquote>
|
||||
Note: PNG files containing transparency cannot be used when producing
|
||||
PDF/A files.</blockquote>
|
||||
<h3 class="function"><span class="info"> PDFio v1.4 </span><a id="pdfioFileCreateNameObj">pdfioFileCreateNameObj</a></h3>
|
||||
<p class="description">Create a new object in a PDF file containing a name.</p>
|
||||
<p class="code">
|
||||
@@ -4542,9 +4569,32 @@ output_cb(void *output_cbdata, const void *buffer, size_t bytes)
|
||||
</pre>
|
||||
|
||||
The "version" argument specifies the PDF version number for the file or
|
||||
<code>NULL</code> for the default ("2.0"). Unlike <a href="#pdfioFileCreate"><code>pdfioFileCreate</code></a> and
|
||||
<a href="#pdfioFileCreateTemporary"><code>pdfioFileCreateTemporary</code></a>, it is generally not safe to pass the
|
||||
"PCLm-1.0" version string.<br>
|
||||
<code>NULL</code> for the default ("2.0"). The following values are recognized:
|
||||
|
||||
</p><ul>
|
||||
<li>"1.3", "1.4", "1.5", "1.6", "1.7", "2.0": Generic PDF files of the
|
||||
specified versions.
|
||||
</li>
|
||||
<li>"PDF/A-1a": PDF/A-1a:2005
|
||||
</li>
|
||||
<li>"PDF/A-1b": PDF/A-1b:2005
|
||||
</li>
|
||||
<li>"PDF/A-2a": PDF/A-2a:2011
|
||||
</li>
|
||||
<li>"PDF/A-2b": PDF/A-2b:2011
|
||||
</li>
|
||||
<li>"PDF/A-2u": PDF/A-2u:2011
|
||||
</li>
|
||||
<li>"PDF/A-3a": PDF/A-3a:2012
|
||||
</li>
|
||||
<li>"PDF/A-3b": PDF/A-3b:2012
|
||||
</li>
|
||||
<li>"PDF/A-3u": PDF/A-3u:2012
|
||||
</li>
|
||||
<li>"PDF/A-4": PDF/A-4:2020</li>
|
||||
</ul>
|
||||
<p class="discussion">Unlike <a href="#pdfioFileCreate"><code>pdfioFileCreate</code></a> and <a href="#pdfioFileCreateTemporary"><code>pdfioFileCreateTemporary</code></a>, it is
|
||||
generally not safe to pass the "PCLm-1.0" version string.<br>
|
||||
<br>
|
||||
The "media_box" and "crop_box" arguments specify the default MediaBox and
|
||||
CropBox for pages in the PDF file - if <code>NULL</code> then a default "Universal" size
|
||||
@@ -4632,10 +4682,33 @@ temporary directory. The temporary file is stored in the string "buffer&qu
|
||||
will have a ".pdf" extension.<br>
|
||||
<br>
|
||||
The "version" argument specifies the PDF version number for the file or
|
||||
<code>NULL</code> for the default ("2.0"). The value "PCLm-1.0" can be specified to
|
||||
produce the PCLm subset of PDF.<br>
|
||||
<br>
|
||||
The "media_box" and "crop_box" arguments specify the default MediaBox and
|
||||
<code>NULL</code> for the default ("2.0"). The following values are recognized:
|
||||
|
||||
</p><ul>
|
||||
<li>"1.3", "1.4", "1.5", "1.6", "1.7", "2.0": Generic PDF files of the
|
||||
specified versions.
|
||||
</li>
|
||||
<li>"PCLm-1.0": The PCLm (raster) subset of PDF supported by some printers.
|
||||
</li>
|
||||
<li>"PDF/A-1a": PDF/A-1a:2005
|
||||
</li>
|
||||
<li>"PDF/A-1b": PDF/A-1b:2005
|
||||
</li>
|
||||
<li>"PDF/A-2a": PDF/A-2a:2011
|
||||
</li>
|
||||
<li>"PDF/A-2b": PDF/A-2b:2011
|
||||
</li>
|
||||
<li>"PDF/A-2u": PDF/A-2u:2011
|
||||
</li>
|
||||
<li>"PDF/A-3a": PDF/A-3a:2012
|
||||
</li>
|
||||
<li>"PDF/A-3b": PDF/A-3b:2012
|
||||
</li>
|
||||
<li>"PDF/A-3u": PDF/A-3u:2012
|
||||
</li>
|
||||
<li>"PDF/A-4": PDF/A-4:2020</li>
|
||||
</ul>
|
||||
<p class="discussion">The "media_box" and "crop_box" arguments specify the default MediaBox and
|
||||
CropBox for pages in the PDF file - if <code>NULL</code> then a default "Universal" size
|
||||
of 8.27x11in (the intersection of US Letter and ISO A4) is used.<br>
|
||||
<br>
|
||||
|
Reference in New Issue
Block a user