Index of values

Add artifact markers to any un-marked part of the content stream.

Indent bookmarks in each file by one and add a title bookmark pointing to the first page.

add_bookmarks verify input pdf adds bookmarks from the bookmark file give.

Add page labels.

Add a rectangle to the given pages.

Call add_texts linewidth outline fast fontname font bates batespad colour position linespacing fontsize underneath text pages orientation relative_to_cropbox midline_adjust topline filename pdf.

True if all pages are "upright" i.e no rotation and (0,0)-based.

True if all pages are "upright" i.e no rotation.

Append page content.

attach_file keepversion topage pdf filename attaches the file in filename to the pdf, optionally to a page (rather than document-level).

Make all fills on certain pages black.

Make all lines on certain pages black.

Make all text on certain pages black.

Make a blank document given x and y page dimensions in points and a number of pages

The same, but give a Pdfpaper.t paper size.

Set bookmarks to be open to the given level.

calculate_position ignore_d w (xmin, ymin, xmax, ymax) orientation pos calculates the absolute position of text given its width, bounding box, orientation and position.

center_to_fit : pagesizes pdf range moves content to the centre of the page without scaling it.

Alter bookmark destinations given a hash table of (old page reference number, new page reference number) pairings

Change the media box and other known boxes by a function which takes xmin, xmax, ymin, ymax as input.

When a page is transformed, its patterns must be too.

Chop pages in the given range into pieces.

Chop a page in the given range horizontally or vertically.

Calling circle x y r builds a path representing a circle at (x, y) with radius r.

Return the list of cmaps from a font file (used for PDF/UA verification).

Collate outputs of get_char with like font

Build a colour operation for filling with the given colour.

Build a colour operation for filing with the given colour

Standard CSS Colours, names in lowercase.

combine_pages fast under over scaletofit swap equalize combines the page content of two PDFs, page-by-page.

Copy the annotations on a given set of pages

Copy one box to another in the given pages.

Copy a font

copy_id keepversion copyfrom copyto copies the ID, if any, from copyfrom to copyto.

Create XMP metadata from scratch

Make a blank PDF/UA-1 PDF given a title, paper size, and number of pages.

Make a blank PDF/UA-2 PDF given a title, paper size, and number of pages.

crop_pdf xywhlist pdf range sets the cropbox on the given pages.

Get the time now

Print info when processing image

Decompresses all streams in a PDF document, assuming it isn't encrypted.

When this is set, any untagged material is tagged as an artifact.

Remove images from a PDF, optionally adding crossed boxes.

Calling draw struct_tree fast underneath filename bates batespad range pdf drawops draws on top of all the pages in the range.

A dummy time value

Dump attached files to a given directory.

Embed missing fonts

Build a fontpack from a TrueType font and list of codepoints, embedding its fonts in the document

Encode a string using a given encoding.

Raise SoftError with the given string.

Expands the date "now" to the date now.

Extract a font file to disk.

Extract images.

Extract page text for a given page.

Extract structure tree to JSON

Extract page text for given page range.

Find an object from an objspec.

Return the font width table for a given (id, font, fontsize) combination.

Build a fontpack for a Standard 14 font

Return the annotations as a simple old-style (pagenumber, content) list.

Get annotations as JSON

Get bookmarks in JSON format.

Look up a unicode codepoint in a font page.

Get dictionary entries in JSON format

Given a PDF, returns a function which can lookup a given dictionary entry from the /Info dictionary, returning it as a UTF8 string

Extract metadata to a Pdfio.bytes

Get XMP information for a given key.

Call the command line tools with the contents of Sys.argv

Call the command line tools with a specialised argv of our own

Clip a page to one of its boxes, or the media box if that box is not present.

True if a given page in a PDF has a given box

Flip the given pages horizontally

Report image resolutions.

Report image resolution data in JSON format

List images in JSON format

Imposition.

Invert a range, given the maximum page number and the range.

Same as process_pages, but iterate rather than map.

Return the width and height of a JPEG2000 stream

Return the width and height of a JPEG

Return font list in JSON format

Convert a single PDF object to CPDFJSON format.

Return page info for selected pages in JSON format.

The factor by which the radius of a circle is multiplied to find the length of the bezier control lines when approximating quarter arcs to make circles.

List the annotations to standard output in a given encoding.

List attached files.

list_bookmarks encoding range pdf output lists the bookmarks to the given output in the format specified in cpdfmanual.pdf.

Return font list.

List spot colours to Standard Output.

Load substitute Standard 14 font

Same as process_pages but return the list of outputs of the map function.

Mark PDF as PDF/UA-1 compliant.

Mark PDF as PDF/UA-2 compliant.

Mark a PDF as begin entirely artifacts (may be used after running remove_struct_tree.

Report missing fonts

Return missing fonts

name_of_spec encoding marks pdf splitlevel spec n filename startpage endpage expands a bookmark specifiation filename.

Convert a single CPDFJSON object to a PDF object

Coalesce same-named OCGs resulting from merge.

Return list of OCG names.

Print OCG list to Standard Output.

Make sure every OCG is in the /Order.

Rename an OCG.

Read a CPDFJSON PDF from an input.

Output to standard output general information about a PDF.

Print page info (Mediabox etc) to standard output.

Output to standard output information from any XMP metadata stream in a PDF.

Put blank pages after the given page numbers

Put blank pages before the given page numbers

Pad to a multiple of n pages

Parse the given TrueType font file.

parse_bookmark_file verify pdf input parses the bookmark file in input.

Read a coordinate from a string

Read a list of coordinates from a string

Parse a (valid) page specification to a page range

Same, but without a PDF.

Read a single rectangles from a string.

Read a list of rectangles from a string.

Read a single number from a string

presentation range t d horizontal inward direction effect_duration pdf adds a presentation on the pages in range.

Print a dictionary entry.

Print a font table to Standard Output.

Print font list to stdout

Print metadate to stdout

Print all the objects from a given PDF to Standard Output.

Print the structure tree to standard output, graphically.

Reprocess images.

Given a function from page number and page to page, a document, and a list of page numbers to apply it to, apply the function to all those pages.

Read a non-interlaced, non-alpha, non-palette PNG for inclusion in a PDF file.

Compresses all streams in the PDF document which are uncompressed, using /FlateDecode, leaving out metadata.

Calling rectangle x y w h builds a path representing a rectangle with top left (x, y), width w and height h.

Change a page's media box so its minimum x and y are 0, making other operations simpler to think about.

Very basic redaction - the removal of whole pages, optionally trimming the structure tree to remove any content there.

Remove all text from the given pages

Remove the annotations on given pages.

Remove any art box from the given pages.

Remove attached files.

Remove any bleed box from the given pages.

Remove clipping.

Remove any cropping from the given pages.

Remove a dictionary entry.

Remove fonts from a document.

Remove any PDF/UA-* marker

Remove the metadata from a file

remove_obj pdf objspec removes the object described by the object specification.

Remove a structure tree entirely from a file, including unmarking marked content.

Remove any trim box from the given pages.

Remove characters which might not make good filenames from a UTF8 string.

Remove text added by Cpdfaddtext from the given pages.

Replace a dictionary entry.

replace_obj pdf objspec obj replace the object at objspec (which must exist) with obj.

remove_stream pdf objspec filename replaces the stream at objspec with the contents of filename.

Reapply an edited JSON structure tree to its PDF.

Calling restrict_angle s a restricts an angle a to one of those at s, 2s, 3s... returning the chosen one.

Set the role map.

Rotate the contents by the given angle on the given pages.

Change rotation to a given value 0, 90, 180, 270 on given pages.

Rotate clockwise by 0, 90, 180, 270 on given pages.

Scale the contents of a page by a given factor centred around a given point in a given range.

Scale a PDF in sx, sy in the given pages.

scale_to_fit_pdf fast position input_scale x y op pdf range scales a page to fit the page size given by (x, y) and by the input_scale (e.g 1.0 = scale to fit, 0.9 = scale to fit leaving a border etc.).

setBox boxname x y w h pdf range sets the given box on the given pages.

Set annotations from JSON.

set_mediabox xywhlist pdf range sets the media box on the given pages.

set_metadata keepversion filename pdf sets the XML metadata of a PDF to the contents of filename.

Set the metadata date

The same, but the content comes from bytes.

Set the non full screen page mode to the given name (sans slash) e.g UseThumbs

Set the open action.

Set the page layout to the given name (sans slash) e.g SinglePage

Set the page mode to the given name (sans slash) e.g UseThumbs

set_pdf_info (key, value, version) sets the entry key in the /Info directory, updating the PDF minor version to version.

Set the PDF version number

set_pdf_info (key, value, version) sets the entry key in the /ViewerPreferences directory, updating the PDF minor version to version.

Shift a PDF's boxes in x and y (in pts) in the given pages.

Shift a PDF in x and y (in pts) in the given pages.

Show the page boxes for debug.

show_composition filesize json pdf prints the composition of a document to Standard Output.

show_composition_json_blob filesize json pdf returns the composition of a document in JSON format.

Total size in bytes of all attached files.

Squeeze a PDF

stamp relative_to_cropbox position topline midline fast scale_to_fit isover range over pdf stamps the first page of over over each page of the PDF.

Stamp a PDF as an xobject in another.

stretch fast pagesizes pdf range stretches content to fit the given page size without regard to aspect ratio.

Strftime.

Return a string for the given range.

Produce a debug string of a position

Parse PDF/UA-1 and PDF/UA-2 to the subformat type.

Return JSON results of a matterhorn test ("" = all tests

Print matterhorn test results ("" = all tests)

Make all lines in the PDF at least a certain thickness.

Print a tree to a buffer.

Write a PDF in CPDFJSON format.

Print a tree to a string.

Debug printing

Add trim marks.

The legacy twoup operation does the same, but scales the new sides down so that the media box is unchanged.

The legacy twoup_stack operation puts two logical pages on each physical page, rotating them 90 degrees to do so.

Typeset a text file as a PDF.

typeset process_struct_tree lmargin rmargin tmargin bmargin papersize pdf contents builds a list of pages of typset content.

Typeset a table of contents and prepend to the document.

The unicode data.

The source, compressed.

Modify the rotation of the page and its contents to leave the rotation at 0 with the page effectively unaltered.

Is a page specification, in theory, valid? This is the most we can find out without supplying a PDF, and thus knowing how many pages there are in it.

Flip the given pages vertically

Calculate the widths of a string given a font width table, and list of char codes