Commit cfaaea6f055b6b6e70cebda10d14f0e6b598fcb8
1 parent
ed6fe012
Doc: reorganize front section
Showing
1 changed file
with
45 additions
and
57 deletions
manual/index.rst
| @@ -6,68 +6,28 @@ QPDF version |release| | @@ -6,68 +6,28 @@ QPDF version |release| | ||
| 6 | :maxdepth: 2 | 6 | :maxdepth: 2 |
| 7 | :caption: Contents: | 7 | :caption: Contents: |
| 8 | 8 | ||
| 9 | -.. _acknowledgments: | ||
| 10 | - | ||
| 11 | -General Information | ||
| 12 | -=================== | ||
| 13 | - | ||
| 14 | -QPDF is a program that does structural, content-preserving | ||
| 15 | -transformations on PDF files. QPDF's website is located at | ||
| 16 | -https://qpdf.sourceforge.io/. QPDF's source code is hosted on github at | ||
| 17 | -https://github.com/qpdf/qpdf. | ||
| 18 | - | ||
| 19 | -QPDF is licensed under `the Apache License, Version | ||
| 20 | -2.0 <http://www.apache.org/licenses/LICENSE-2.0>`__ (the "License"). | ||
| 21 | -Unless required by applicable law or agreed to in writing, software | ||
| 22 | -distributed under the License is distributed on an "AS IS" BASIS, | ||
| 23 | -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| 24 | -See the License for the specific language governing permissions and | ||
| 25 | -limitations under the License. | ||
| 26 | - | ||
| 27 | -Versions of qpdf prior to version 7 were released under the terms of | ||
| 28 | -`the Artistic License, version | ||
| 29 | -2.0 <https://opensource.org/licenses/Artistic-2.0>`__. At your option, | ||
| 30 | -you may continue to consider qpdf to be licensed under those terms. The | ||
| 31 | -Apache License 2.0 permits everything that the Artistic License 2.0 | ||
| 32 | -permits but is slightly less restrictive. Allowing the Artistic License | ||
| 33 | -to continue being used is primary to help people who may have to get | ||
| 34 | -specific approval to use qpdf in their products. | ||
| 35 | - | ||
| 36 | -QPDF is intentionally released with a permissive license. However, if | ||
| 37 | -there is some reason that the licensing terms don't work for your | ||
| 38 | -requirements, please feel free to contact the copyright holder to make | ||
| 39 | -other arrangements. | ||
| 40 | - | ||
| 41 | -QPDF was originally created in 2001 and modified periodically between | ||
| 42 | -2001 and 2005 during my employment at `Apex | ||
| 43 | -CoVantage <http://www.apexcovantage.com>`__. Upon my departure from | ||
| 44 | -Apex, the company graciously allowed me to take ownership of the | ||
| 45 | -software and continue maintaining as an open source project, a decision | ||
| 46 | -for which I am very grateful. I have made considerable enhancements to | ||
| 47 | -it since that time. I feel fortunate to have worked for people who would | ||
| 48 | -make such a decision. This work would not have been possible without | ||
| 49 | -their support. | ||
| 50 | - | ||
| 51 | .. _ref.overview: | 9 | .. _ref.overview: |
| 52 | 10 | ||
| 53 | What is QPDF? | 11 | What is QPDF? |
| 54 | ============= | 12 | ============= |
| 55 | 13 | ||
| 56 | -QPDF is a program that does structural, content-preserving | ||
| 57 | -transformations on PDF files. It could have been called something like | ||
| 58 | -*pdf-to-pdf*. It also provides many useful capabilities to developers of | ||
| 59 | -PDF-producing software or for people who just want to look at the | ||
| 60 | -innards of a PDF file to learn more about how they work. | ||
| 61 | - | ||
| 62 | -With QPDF, it is possible to copy objects from one PDF file into another | ||
| 63 | -and to manipulate the list of pages in a PDF file. This makes it | ||
| 64 | -possible to merge and split PDF files. The QPDF library also makes it | ||
| 65 | -possible for you to create PDF files from scratch. In this mode, you are | ||
| 66 | -responsible for supplying all the contents of the file, while the QPDF | ||
| 67 | -library takes care off all the syntactical representation of the | ||
| 68 | -objects, creation of cross references tables and, if you use them, | ||
| 69 | -object streams, encryption, linearization, and other syntactic details. | ||
| 70 | -You are still responsible for generating PDF content on your own. | 14 | +QPDF is a program and C++ library for structural, content-preserving |
| 15 | +transformations on PDF files. QPDF's website is located at | ||
| 16 | +https://qpdf.sourceforge.io/. QPDF's source code is hosted on github | ||
| 17 | +at https://github.com/qpdf/qpdf. | ||
| 18 | + | ||
| 19 | +QPDF provides many useful capabilities to developers of PDF-producing | ||
| 20 | +software or for people who just want to look at the innards of a PDF | ||
| 21 | +file to learn more about how they work. With QPDF, it is possible to | ||
| 22 | +copy objects from one PDF file into another and to manipulate the list | ||
| 23 | +of pages in a PDF file. This makes it possible to merge and split PDF | ||
| 24 | +files. The QPDF library also makes it possible for you to create PDF | ||
| 25 | +files from scratch. In this mode, you are responsible for supplying | ||
| 26 | +all the contents of the file, while the QPDF library takes care of all | ||
| 27 | +the syntactical representation of the objects, creation of cross | ||
| 28 | +references tables and, if you use them, object streams, encryption, | ||
| 29 | +linearization, and other syntactic details. You are still responsible | ||
| 30 | +for generating PDF content on your own. | ||
| 71 | 31 | ||
| 72 | QPDF has been designed with very few external dependencies, and it is | 32 | QPDF has been designed with very few external dependencies, and it is |
| 73 | intentionally very lightweight. QPDF is *not* a PDF content creation | 33 | intentionally very lightweight. QPDF is *not* a PDF content creation |
| @@ -80,6 +40,19 @@ creation can't handle. For example, many programs generate simple PDF | @@ -80,6 +40,19 @@ creation can't handle. For example, many programs generate simple PDF | ||
| 80 | files but can't password-protect them, web-optimize them, or perform | 40 | files but can't password-protect them, web-optimize them, or perform |
| 81 | other transformations of that type. | 41 | other transformations of that type. |
| 82 | 42 | ||
| 43 | +.. _ref.license: | ||
| 44 | + | ||
| 45 | +License | ||
| 46 | +======= | ||
| 47 | + | ||
| 48 | +QPDF is licensed under `the Apache License, Version 2.0 | ||
| 49 | +<http://www.apache.org/licenses/LICENSE-2.0>`__ (the "License"). | ||
| 50 | +Unless required by applicable law or agreed to in writing, software | ||
| 51 | +distributed under the License is distributed on an "AS IS" BASIS, | ||
| 52 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| 53 | +implied. See the License for the specific language governing | ||
| 54 | +permissions and limitations under the License. | ||
| 55 | + | ||
| 83 | .. _ref.installing: | 56 | .. _ref.installing: |
| 84 | 57 | ||
| 85 | Building and Installing QPDF | 58 | Building and Installing QPDF |
| @@ -6289,3 +6262,18 @@ available inside the library. In the unlikely event that you should run | @@ -6289,3 +6262,18 @@ available inside the library. In the unlikely event that you should run | ||
| 6289 | into trouble, please see the ChangeLog. See also | 6262 | into trouble, please see the ChangeLog. See also |
| 6290 | :ref:`ref.release-notes` for a complete list of the | 6263 | :ref:`ref.release-notes` for a complete list of the |
| 6291 | non-compatible API changes made in this version. | 6264 | non-compatible API changes made in this version. |
| 6265 | + | ||
| 6266 | +.. _acknowledgments: | ||
| 6267 | + | ||
| 6268 | +Acknowledgment | ||
| 6269 | +============== | ||
| 6270 | + | ||
| 6271 | +QPDF was originally created in 2001 and modified periodically between | ||
| 6272 | +2001 and 2005 during my employment at `Apex CoVantage | ||
| 6273 | +<http://www.apexcovantage.com>`__. Upon my departure from Apex, the | ||
| 6274 | +company graciously allowed me to take ownership of the software and | ||
| 6275 | +continue maintaining as an open source project, a decision for which I | ||
| 6276 | +am very grateful. I have made considerable enhancements to it since | ||
| 6277 | +that time. I feel fortunate to have worked for people who would make | ||
| 6278 | +such a decision. This work would not have been possible without their | ||
| 6279 | +support. |