Antenna House PDF API Antenna House, Inc.

Full text search


Table of Contents

  1. Chapter.1 Overview - Command-line
  2. Chapter.2 System Requirements
    1. 2–1 Windows
    2. 2–2 Linux
  3. Chapter.3 Installation Instructions
    1. 3–1 Windows Version
      1. 3–1–1 Installation Instructions
      2. 3–1–2 Uninstallation Instructions
      3. 3–1–3 Microsoft Visual C++ runtime library
      4. 3–1–4 Installation Folder Structure
      5. 3–1–5 What the Installer Sets on Your System
      6. 3–1–6 License File to be Installed
    2. 3–2 Linux Version
      1. 3–2–1 Installation Instructions
      2. 3–2–2 Uninstallation Instructions
      3. 3–2–3 Installation Folder Structure
      4. 3–2–4 License File to be Installed
  4. Chapter.4 License File
    1. 4–1 License File Specifications
      1. 4–1–1 Evaluation License:
      2. 4–1–2 Regular License:
    2. 4–2 Obtaining the License File
    3. 4–3 License File Location (Default Location)
    4. 4–4 License File Location (Arbitrary Location)
      1. 4–4–1 How to Specify the Location 1: Using Environment Variables
      2. 4–4–2 How to Specify the Location 2 (Windows version only): Location of dll File
    5. 4–5 Replacing License File
    6. 4–6 Maintenance Period and Command-line Behavior
      1. 4–6–1 Supplement 1: Maintenance Period and Version Upgrades
    7. 4–7 Handling of License Files When Installing the Maintenance Version
    8. 4–8 Checking License File Information
  5. Chapter.5 Handling Fonts
    1. 5–1 Getting Font information
    2. 5–2 Font Configuration File Settings
      1. 5–2–1 Example of [font-config.xml] (Windows version)
    3. 5–3 Creating Environment Variables
    4. 5–4 Supported Font Formats
    5. 5–5 Embedding Fonts
    6. 5–6 Merging Fonts
    7. 5–7 Font Limitations
    8. 5–8 Processing that Handles Fonts
  6. Chapter.6 Color Profiles
    1. 6–1 Searching for Color Profiles
    2. 6–2 Creating Environment Variables
    3. 6–3 Processing that Handles Color Profiles
  7. Chapter.7 PDF Files Available to be Processed
  8. Chapter.8 Limitations
    1. 8–1 PDF Versions
      1. 8–1–1 Versions Available to be Processed
      2. 8–1–2 PDF Version of Input / Output Files
    2. 8–2 Limit Size on Read / Write
    3. 8–3 Editing PDF/A and PDF/X
    4. 8–4 PDF Optimization
    5. 8–5 Font Limitations
    6. 8–6 Retaining Security Information
    7. 8–7 Using Multiple Threads
    8. 8–8 String Limitation in Command Prompt
  9. Chapter.9 Operation Specifications on Evaluation Version
  10. Chapter.10 How to Use the Command-line
    1. 10–1 Execution Method
      1. 10–1–1 Running on Windows Versions
      2. 10–1–2 Running on Linux Versions
  11. Chapter.11 Command-line Specifications
    1. 11–1 How to Specify Input and Output
      1. 11–1–1 Specifying Files
      2. 11–1–2 Specifying Folder
  12. Chapter.12 Type of Commands
  13. Chapter.13 Parameters for Commands
    1. 13–1 -getFileInfo : Getting PDF Information
      1. 13–1–1 Processing
      2. 13–1–2 Example of commands
      3. 13–1–3 Folder settings: applied
      4. 13–1–4 Parameters
      5. 13–1–5 Output content
    2. 13–2 -changeDocInfo: Document Property Settings
      1. 13–2–1 Processing
      2. 13–2–2 Example of commands
      3. 13–2–3 Folder settings: applied
      4. 13–2–4 Parameters
    3. 13–3 -changeViewInfo: Open Action Settings
      1. 13–3–1 Processing
      2. 13–3–2 Example of commands
      3. 13–3–3 Folder settings: applied
      4. 13–3–4 Parameters
    4. 13–4 -mergeFiles: Merging PDF files
      1. 13–4–1 Processing
      2. 13–4–2 Example of commands
      3. 13–4–3 Folder settings: not applied
      4. 13–4–4 Parameters
    5. 13–5 -getOutlineInfo: Getting Outline Information
      1. 13–5–1 Processing
      2. 13–5–2 Example of commands
      3. 13–5–3 Folder settings: applied
      4. 13–5–4 Parameters
      5. 13–5–5 Output content
    6. 13–6 -getAnnotInfo: Getting Annotation Information
      1. 13–6–1 Processing
      2. 13–6–2 Example of commands
      3. 13–6–3 Folder settings: applied
      4. 13–6–4 Parameters
      5. 13–6–5 Output content
    7. 13–7 -setPdfWatermark: Inserting PDF Watermark
      1. 13–7–1 Processing
      2. 13–7–2 Example of commands
      3. 13–7–3 Folder settings: applied
      4. 13–7–4 Parameters
    8. 13–8 -setImageWatermark: Inserting Image Watermark
      1. 13–8–1 Processing
      2. 13–8–2 Example of commands
      3. 13–8–3 Folder settings: applied
      4. 13–8–4 Parameters
    9. 13–9 -setTextWatermark: Inserting Text Watermark
      1. 13–9–1 Processing
      2. 13–9–2 Example of commands
      3. 13–9–3 Folder settings: applied
      4. 13–9–4 Parameters
    10. 13–10 -setColorWatermark: Inserting Color Watermark
      1. 13–10–1 Processing
      2. 13–10–2 Example of commands
      3. 13–10–3 Folder settings: applied
      4. 13–10–4 Parameters
    11. 13–11 -encrypt: PDF Security Settings
      1. 13–11–1 Processing
      2. 13–11–2 Example of commands
      3. 13–11–3 Folder settings: applied
      4. 13–11–4 Parameters
    12. 13–12 -decrypt: Removing PDF Security Settings
      1. 13–12–1 Processing
      2. 13–12–2 Example of commands
      3. 13–12–3 Folder settings: applied
      4. 13–12–4 Parameters
    13. 13–13 -optimize: Optimizing PDF Files
      1. 13–13–1 Processing
      2. 13–13–2 Example of commands
      3. 13–13–3 Folder settings: applied
      4. 13–13–4 Parameters
    14. 13–14 -addEmbeddedFile: File Attachment
      1. 13–14–1 Processing
      2. 13–14–2 Example of commands
      3. 13–14–3 Folder settings: applied
      4. 13–14–4 Parameters
    15. 13–15 -pageRotate: Page Rotation
      1. 13–15–1 Processing
      2. 13–15–2 Example of commands
      3. 13–15–3 Folder settings: not applied
      4. 13–15–4 Parameters
    16. 13–16 -pageDelete: Deleting Pages
      1. 13–16–1 Processing
      2. 13–16–2 Example of commands
      3. 13–16–3 Folder settings: not applied
      4. 13–16–4 Parameters
    17. 13–17 -writeText: Adding Text
      1. 13–17–1 Processing
      2. 13–17–2 Example of commands
      3. 13–17–3 Folder settings: applied
      4. 13–17–4 Parameters
    18. 13–18 -exportAnnotsToFDF: Exporting Annotations to FDF
      1. 13–18–1 Processing
      2. 13–18–2 Example of commands
      3. 13–18–3 Folder settings: applied
      4. 13–18–4 Parameters
    19. 13–19 -importAnnotsFromPDF: Importing Annotations from Other PDF
      1. 13–19–1 Processing
      2. 13–19–2 Example of commands
      3. 13–19–3 Folder settings: not applied
      4. 13–19–4 Parameters
    20. 13–20 -insertEmptyPage: Inserting Empty Pages
      1. 13–20–1 Processing
      2. 13–20–2 Example of commands
      3. 13–20–3 Folder settings: not applied
      4. 13–20–4 Parameters
    21. 13–21 -addPageNumber: Adding Page Number
      1. 13–21–1 Processing
      2. 13–21–2 Example of commands
      3. 13–21–3 Folder settings: applied
      4. 13–21–4 Parameters
    22. 13–22 -pageExtract: Extracting Pages
      1. 13–22–1 Processing
      2. 13–22–2 Example of commands
      3. 13–22–3 Folder settings: not applied
      4. 13–22–4 Parameters
    23. 13–23 -embedFonts: Embedding Fonts
      1. 13–23–1 Processing
      2. 13–23–2 Example of commands
      3. 13–23–3 Folder settings: applied
      4. 13–23–4 Parameters
    24. 13–24 -extractImage: Extracting Images
      1. 13–24–1 Processing
      2. 13–24–2 Example of commands
      3. 13–24–3 Folder settings: applied
      4. 13–24–4 Parameters
    25. 13–25 -extractText: Extracting Text
      1. 13–25–1 Processing
      2. 13–25–2 Example of commands
      3. 13–25–3 Folder settings: applied
      4. 13–25–4 Parameters
    26. 13–26 -imageToPdf: Converting Images to PDF
      1. 13–26–1 Processing
      2. 13–26–2 Example of commands
      3. 13–26–3 Folder settings: applied
      4. 13–26–4 Parameters
    27. 13–27 -extractEmbeddedFile: Extracting Attached Files
      1. 13–27–1 Processing
      2. 13–27–2 Example of commands
      3. 13–27–3 Folder settings: applied
      4. 13–27–4 Parameters
    28. 13–28 -importAnnotsFromFDF: Importing Annotations from FDF
      1. 13–28–1 Processing
      2. 13–28–2 Example of commands
      3. 13–28–3 Folder settings: not applied
      4. 13–28–4 Parameters
    29. 13–29 -fixedUpPDFA: PDF/A-1b, -2b Conversion
      1. 13–29–1 Processing
      2. 13–29–2 Example of commands
      3. 13–29–3 Folder settings: applied
      4. 13–29–4 Parameters
    30. 13–30 -validatePDFA: Validating PDF/A-1b, -2b
      1. 13–30–1 Processing
      2. 13–30–2 Example of commands
      3. 13–30–3 Folder settings: applied
      4. 13–30–4 Parameters
    31. 13–31 -dividePdf: Splitting a PDF File
      1. 13–31–1 Processing
      2. 13–31–2 Example of commands
      3. 13–31–3 Folder settings: not applied
      4. 13–31–4 Parameters
    32. 13–32 -linearize: Linearizing for Fast Web View
      1. 13–32–1 Processing
      2. 13–32–2 Example of commands
      3. 13–32–3 Folder settings: applied
      4. 13–32–4 Parameters
    33. 13–33 -lic: Getting License Information
      1. 13–33–1 Processing
      2. 13–33–2 Example of commands
      3. 13–33–3 Folder settings: not applied
      4. 13–33–4 Parameters
    34. 13–34 -h: Showing a List of Command Names
      1. 13–34–1 Processing
      2. 13–34–2 Example of commands
      3. 13–34–3 Folder settings: not applied
      4. 13–34–4 Parameters
    35. 13–35 -h -all: Showing All Commands and Meanings
      1. 13–35–1 Processing
      2. 13–35–2 Example of commands
      3. 13–35–3 Folder settings: not applied
      4. 13–35–4 Parameters
    36. 13–36 -h [command name]: Showing Specific Commands and Meanings
      1. 13–36–1 Processing
      2. 13–36–2 Example of commands
    37. 13–37 Output Content of Acquired Information
      1. 13–37–1 -getFileInfo: Getting PDF Information
      2. 13–37–2 -getOutlineInfo: Getting Outline information
      3. 13–37–3 -getAnnotInfo: Getting Annotation Information
      4. 13–37–4 Action Information / Destination Information
  14. Chapter.14 Command-line Supplement
    1. 14–1 Specifying Multiple Commands
      1. 14–1–1 Example of commands
    2. 14–2 Macro Text
      1. 14–2–1 #DATE() replacement example
      2. 14–2–2 Example of commands
    3. 14–3 Error Handling
      1. 14–3–1 Command-line Return Value
      2. 14–3–2 Error Details
      3. 14–3–3 PdfTk Error Code List
  15. Chapter.15 Upgrading
    1. 15–1 “Antenna House PDF API” version notation and definition of version upgrade
    2. 15–2 Version Upgrades During the Maintenance Period
    3. 15–3 Installing Multiple Versions
  16. Chapter.16 Frequently Asked Questions
    1. 16–1 Features and Programming
      1. 16–1–1 What type of font is applied when text is added using Antenna House PDF API to a PDF that does not have embedded fonts?
      2. 16–1–2 If I use Antenna House PDF API to add text to a PDF that does not have embedded fonts, will the font of the text originally in the PDF be maintained?
      3. 16–1–3 Can I specify the PDF version number of output files processed with Antenna House PDF API?
      4. 16–1–4 What happens to the PDF version of PDF files saved with encryption security?
      5. 16–1–5 Can I remove embedded font information from a PDF with embedded fonts?
      6. 16–1–6 Is there a limit to the file size of PDF files that can be edited using Antenna House PDF API?
      7. 16–1–7 I would like to know the contents of the error code that occurs when I run the Command-line.
      8. 16–1–8 I would like to know if there are any environment variables that can determine the execution results of the Command-line.
      9. 16–1–9 I would like to know where to output the Command-line error details.
    2. 16–2 Installation/Upgrade/License File
      1. 16–2–1 What do Antenna House PDF API versions and maintenance release mean?
      2. 16–2–2 Can I overwrite the maintenance release version (MR) of Antenna House PDF API? What happens to the files then?
      3. 16–2–3 When upgrading the version of "Antenna House PDF API", do I need to uninstall the old version?
      4. 16–2–4 A maintenance release version (MR) was released after installing the evaluation version. After that, I purchased the product, but what are the steps to upgrade?
      5. 16–2–5 I have purchased a license for the product version, so I would like to convert the evaluation version to the regular version. What should I do?
      6. 16–2–6 How can I check the information contained in the Antenna House PDF API license file?
      7. 16–2–7 How do I uninstall the Linux version?
      8. 16–2–8 When upgrading Antenna House PDF API, is it necessary to replace the license file (ptalic.dat)?
      9. 16–2–9 When updating Antenna House PDF API to a maintenance release version, is it necessary to replace the license file [ptalic.dat]?
      10. 16–2–10 I was using the regular version of Antenna House PDF API. When I installed a maintenance release version and started it up, a watermark of the evaluation version was output. Why?
      11. 16–2–11 When I migrated the version, an evaluation version message is output. Who should I contact to issue a new license?
      12. 16–2–12 [Windows version] Is it possible to operate Antenna House PDF API without installing VC++ runtime?
      13. 16–2–13 [Windows version] What happens if the VC++ runtime exists on the installation destination PC?
      14. 16–2–14 [Windows version] When upgrading after uninstalling the current version, the "Setup Failed" screen appears. It seems that if I close this error screen, the installation will continue and end normally, but is there any problem with this procedure?
  17. Chapter.17 Trademark/Copyright Information
    1. 17–1 Trademark
    2. 17–2 Third Party Library Copyright Information