dany/pdfio
1
0
Fork 0
mirror of https://github.com/michaelrsweet/pdfio.git synced 2024-12-27 05:48:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rename as PDFio for consistency.

Browse Source 
Add PDFio logo image.

Move documentation to "doc" subdirectory.
This commit is contained in:
Michael R Sweet 2021-05-30 07:10:44 -04:00
parent 8bc538cc91
commit 246c2e4b41
No known key found for this signature in database
GPG Key ID: 999559A027815955
21 changed files with 35 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Makefile
View File

@ -1,5 +1,5 @@
# #
# Makefile for pdfio. # Makefile for PDFio.
# #
# Copyright © 2021 by Michael R Sweet. # Copyright © 2021 by Michael R Sweet.
# #
@ -92,12 +92,13 @@ install: $(TARGETS)
ln -sf libpdfio.1.dylib $(DESTDIR)$(prefix)/lib/libpdfio.dylib; \ ln -sf libpdfio.1.dylib $(DESTDIR)$(prefix)/lib/libpdfio.dylib; \
fi fi
-mkdir -p $(DESTDIR)$(prefix)/lib/pkgconfig -mkdir -p $(DESTDIR)$(prefix)/lib/pkgconfig
echo '"prefix="$(prefix)"' >>$(DESTDIR)$(prefix)/lib/pkgconfig/pdfio.pc echo 'prefix="$(prefix)"' >$(DESTDIR)$(prefix)/lib/pkgconfig/pdfio.pc
cat pdfio.pc.in >$(DESTDIR)$(prefix)/lib/pkgconfig/pdfio.pc echo 'Version: $(VERSION)' >>$(DESTDIR)$(prefix)/lib/pkgconfig/pdfio.pc
cat pdfio.pc.in >>$(DESTDIR)$(prefix)/lib/pkgconfig/pdfio.pc
-mkdir -p $(DESTDIR)$(prefix)/share/doc/pdfio -mkdir -p $(DESTDIR)$(prefix)/share/doc/pdfio
cp pdfio.html LICENSE NOTICE $(DESTDIR)$(prefix)/share/doc/pdfio cp doc/pdfio.html doc/pdfio-512.png LICENSE NOTICE $(DESTDIR)$(prefix)/share/doc/pdfio
-mkdir -p $(DESTDIR)$(prefix)/share/man/man3 -mkdir -p $(DESTDIR)$(prefix)/share/man/man3
cp pdfio.3 LICENSE NOTICE $(DESTDIR)$(prefix)/share/man/man3 cp doc/pdfio.3 $(DESTDIR)$(prefix)/share/man/man3
install-shared: install-shared:
if test `uname` = Darwin; then \ if test `uname` = Darwin; then \
@ -141,7 +142,8 @@ DOCFLAGS = \
--copyright "Copyright (c) 2021 by Michael R Sweet" \ --copyright "Copyright (c) 2021 by Michael R Sweet" \
--docversion $(VERSION) --docversion $(VERSION)
.PHONY: doc
doc: doc:
codedoc $(DOCFLAGS) --title "pdfio Programming Manual v$(VERSION)" pdfio.h $(LIBOBJS:.o=.c) --body pdfio.md pdfio.xml >pdfio.html codedoc $(DOCFLAGS) --title "PDFio Programming Manual v$(VERSION)" pdfio.h $(LIBOBJS:.o=.c) --body doc/pdfio.md --coverimage doc/pdfio-512.png pdfio.xml >doc/pdfio.html
codedoc $(DOCFLAGS) --title "pdf read/write library" --man pdfio --section 3 --body pdfio.md pdfio.xml >pdfio.3 codedoc $(DOCFLAGS) --title "pdf read/write library" --man pdfio --section 3 --body doc/pdfio.md pdfio.xml >doc/pdfio.3
rm -f pdfio.xml rm -f pdfio.xml

2
NOTICE
View File

@ -1,4 +1,4 @@
pdfio - PDF Read/Write Library PDFio - PDF Read/Write Library
Copyright © 2021 by Michael R Sweet. Copyright © 2021 by Michael R Sweet.

BIN
doc/pdfio-512.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

6
pdfio.3 → doc/pdfio.3
View File

@ -1,9 +1,9 @@
.TH pdfio 3 "pdf read/write library" "2021-05-29" "pdf read/write library" .TH pdfio 3 "pdf read/write library" "2021-05-30" "pdf read/write library"
.SH NAME .SH NAME
pdfio \- pdf read/write library pdfio \- pdf read/write library
.SH Introduction .SH Introduction
.PP .PP
pdfio is a simple C library for reading and writing PDF files. The primary goals of pdfio are: PDFio is a simple C library for reading and writing PDF files. The primary goals of pdfio are:
.IP \(bu 5 .IP \(bu 5
.PP .PP
Read any PDF file with or without encryption or linearization Read any PDF file with or without encryption or linearization
@ -26,7 +26,7 @@ Provide access to objects used for each page
.PP .PP
pdfio is PDFio is
.I not .I not
concerned with rendering or viewing a PDF file, although a PDF RIP or viewer could be written using it. concerned with rendering or viewing a PDF file, although a PDF RIP or viewer could be written using it.

9
pdfio.html → doc/pdfio.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en-US"> <html lang="en-US">
<head> <head>
<title>pdfio Programming Manual v0.1</title> <title>PDFio Programming Manual v0.1</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8"> <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<meta name="generator" content="codedoc v3.7"> <meta name="generator" content="codedoc v3.7">
<meta name="author" content="Michael R Sweet"> <meta name="author" content="Michael R Sweet">
@ -244,7 +244,8 @@ span.string {
</head> </head>
<body> <body>
<div class="header"> <div class="header">
<h1 class="title">pdfio Programming Manual v0.1</h1> <p><img class="title" src="pdfio-512.png"></p>
<h1 class="title">PDFio Programming Manual v0.1</h1>
<p>Michael R Sweet</p> <p>Michael R Sweet</p>
<p>Copyright © 2021 by Michael R Sweet</p> <p>Copyright © 2021 by Michael R Sweet</p>
</div> </div>
@ -414,7 +415,7 @@ span.string {
</div> </div>
<div class="body"> <div class="body">
<h2 class="title" id="introduction">Introduction</h2> <h2 class="title" id="introduction">Introduction</h2>
<p>pdfio is a simple C library for reading and writing PDF files. The primary goals of pdfio are:</p> <p>PDFio is a simple C library for reading and writing PDF files. The primary goals of pdfio are:</p>
<ul> <ul>
<li><p>Read any PDF file with or without encryption or linearization</p> <li><p>Read any PDF file with or without encryption or linearization</p>
</li> </li>
@ -427,7 +428,7 @@ span.string {
<li><p>Provide access to objects used for each page</p> <li><p>Provide access to objects used for each page</p>
</li> </li>
</ul> </ul>
<p>pdfio is <em>not</em> concerned with rendering or viewing a PDF file, although a PDF RIP or viewer could be written using it.</p> <p>PDFio is <em>not</em> concerned with rendering or viewing a PDF file, although a PDF RIP or viewer could be written using it.</p>
<h2 class="title"><a id="FUNCTIONS">Functions</a></h2> <h2 class="title"><a id="FUNCTIONS">Functions</a></h2>
<h3 class="function"><a id="pdfioArrayAppendArray">pdfioArrayAppendArray</a></h3> <h3 class="function"><a id="pdfioArrayAppendArray">pdfioArrayAppendArray</a></h3>
<p class="description">Add an array value to an array.</p> <p class="description">Add an array value to an array.</p>

4
pdfio.md → doc/pdfio.md
View File

@ -1,7 +1,7 @@
Introduction Introduction
============ ============
pdfio is a simple C library for reading and writing PDF files. The primary PDFio is a simple C library for reading and writing PDF files. The primary
goals of pdfio are: goals of pdfio are:
- Read any PDF file with or without encryption or linearization - Read any PDF file with or without encryption or linearization
@ -11,5 +11,5 @@ goals of pdfio are:
that are missing from a PDF that are missing from a PDF
- Provide access to objects used for each page - Provide access to objects used for each page
pdfio is *not* concerned with rendering or viewing a PDF file, although a PDF PDFio is *not* concerned with rendering or viewing a PDF file, although a PDF
RIP or viewer could be written using it. RIP or viewer could be written using it.

2
pdfio-array.c
View File

@ -1,5 +1,5 @@
// //
// PDF array functions for pdfio. // PDF array functions for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //

2
pdfio-content.c
View File

@ -1,5 +1,5 @@
// //
// Content helper functions for pdfio. // Content helper functions for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //

2
pdfio-content.h
View File

@ -1,5 +1,5 @@
// //
// Public content header file for pdfio. // Public content header file for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //

2
pdfio-dict.c
View File

@ -1,5 +1,5 @@
// //
// PDF dictionary functions for pdfio. // PDF dictionary functions for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //

2
pdfio-file.c
View File

@ -1,5 +1,5 @@
// //
// PDF file functions for pdfio. // PDF file functions for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //

4
pdfio-object.c
View File

@ -1,5 +1,5 @@
// //
// PDF object functions for pdfio. // PDF object functions for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //
@ -155,7 +155,7 @@ pdfioObjCreateStream(
if (filter != PDFIO_FILTER_NONE && filter != PDFIO_FILTER_FLATE) if (filter != PDFIO_FILTER_NONE && filter != PDFIO_FILTER_FLATE)
{ {
_pdfioFileError(obj->pdf, "Unsupported filter value for pdfioObjCreateStream."); _pdfioFileError(obj->pdf, "Unsupported filter value for PDFioObjCreateStream.");
return (NULL); return (NULL);
} }

2
pdfio-page.c
View File

@ -1,5 +1,5 @@
// //
// PDF page functions for pdfio. // PDF page functions for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //

2
pdfio-private.h
View File

@ -1,5 +1,5 @@
// //
// Private header file for pdfio. // Private header file for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //

2
pdfio-stream.c
View File

@ -1,5 +1,5 @@
// //
// PDF stream functions for pdfio. // PDF stream functions for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //

2
pdfio-string.c
View File

@ -1,5 +1,5 @@
// //
// PDF dictionary functions for pdfio. // PDF dictionary functions for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //

2
pdfio-token.c
View File

@ -1,5 +1,5 @@
// //
// PDF token parsing functions for pdfio. // PDF token parsing functions for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //

2
pdfio-value.c
View File

@ -1,5 +1,5 @@
// //
// PDF value functions for pdfio. // PDF value functions for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //

2
pdfio.h
View File

@ -1,5 +1,5 @@
// //
// Public header file for pdfio. // Public header file for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //

1
pdfio.pc.in
View File

@ -1,6 +1,5 @@
Name: pdfio Name: pdfio
Description: PDF read/write library Description: PDF read/write library
Version: 1.0
URL: https://www.msweet.org/pdfio URL: https://www.msweet.org/pdfio
Requires.private: zlib >= 1.0 Requires.private: zlib >= 1.0
Libs: -L${prefix}/lib -lpdfio Libs: -L${prefix}/lib -lpdfio

2
testpdfio.c
View File

@ -1,5 +1,5 @@
// //
// Test program for pdfio. // Test program for PDFio.
// //
// Copyright © 2021 by Michael R Sweet. // Copyright © 2021 by Michael R Sweet.
// //