OCR-D CLI

\n\n\n

\nUsage: ocrd-pagetopdf [worker|server] [OPTIONS]\n\n  Convert text and layout annotations from PAGE to PDF format (overlaying original image with text layer and polygon outlines)\n\n  > Converts all pages of the document to PDF\n\n  > For each page, open and deserialize PAGE input file and its\n  > respective image. Then extract a derived image of the (cropped,\n  > deskewed, binarized...) page, with features depending on\n  > ``image_feature_selector`` (a comma-separated list of required image\n  > features, cf. :py:func:`ocrd.workspace.Workspace.image_from_page`)\n  > and ``image_feature_filter`` (a comma-separated list of forbidden\n  > image features).\n\n  > Next, generate a temporary PAGE output file for that very image\n  > (adapting all coordinates if necessary). If ``negative2zero`` is\n  > set, validate and repair invalid or inconsistent coordinates.\n\n  > Convert the PAGE/image pair with PRImA PageToPdf, applying\n  > - ``textequiv_level`` (i.e. `-text-source`) to retrieve a text layer, if set;\n  > - ``outlines`` to draw boundary polygons, if set;\n  > - ``font`` accordingly.\n\n  > Copy the resulting PDF file to the output file group and reference\n  > it in the METS.\n\n  > Finally, if ``multipage`` is set, then concatenate all generated\n  > files to a multi-page PDF file, setting ``pagelabels`` accordingly,\n  > as well as PDF metadata and bookmarks. Reference it with\n  > ``multipage`` as ID in the output file group, too. If\n  > ``multipage_only`` is also set, then remove the single-page PDF\n  > files afterwards.\n\nSubcommands:\n    worker      Start a processing worker rather than do local processing\n    server      Start a processor server rather than do local processing\n\nOptions for processing:\n  -m, --mets URL-PATH             URL or file path of METS to process [./mets.xml]\n  -w, --working-dir PATH          Working directory of local workspace [dirname(URL-PATH)]\n  -I, --input-file-grp USE        File group(s) used as input\n  -O, --output-file-grp USE       File group(s) used as output\n  -g, --page-id ID                Physical page ID(s) to process instead of full document []\n  --overwrite                     Remove existing output pages/images\n                                  (with \"--page-id\", remove only those).\n                                  Short-hand for OCRD_EXISTING_OUTPUT=OVERWRITE\n  --debug                         Abort on any errors with full stack trace.\n                                  Short-hand for OCRD_MISSING_OUTPUT=ABORT\n  --profile                       Enable profiling\n  --profile-file PROF-PATH        Write cProfile stats to PROF-PATH. Implies \"--profile\"\n  -p, --parameter JSON-PATH       Parameters, either verbatim JSON string\n                                  or JSON file path\n  -P, --param-override KEY VAL    Override a single JSON object key-value pair,\n                                  taking precedence over --parameter\n  -U, --mets-server-url URL       URL of a METS Server for parallel incremental access to METS\n                                  If URL starts with http:// start an HTTP server there,\n                                  otherwise URL is a path to an on-demand-created unix socket\n  -l, --log-level [OFF|ERROR|WARN|INFO|DEBUG|TRACE]\n                                  Override log level globally [INFO]\n  --log-filename LOG-PATH         File to redirect stderr logging to (overriding ocrd_logging.conf).\n\nOptions for information:\n  -C, --show-resource RESNAME     Dump the content of processor resource RESNAME\n  -L, --list-resources            List names of processor resources\n  -J, --dump-json                 Dump tool description as JSON\n  -D, --dump-module-dir           Show the 'module' resource location path for this processor\n  -h, --help                      Show this message\n  -V, --version                   Show version\n\nParameters:\n   \"image_feature_selector\" [string - \"\"]\n    comma-separated list of required image features (e.g.\n    binarized,despeckled,cropped,deskewed,rotated-90)\n   \"image_feature_filter\" [string - \"\"]\n    comma-separated list of forbidden image features (e.g.\n    binarized,despeckled,cropped,deskewed,rotated-90)\n   \"font\" [string - \"\"]\n    Font file to be used in PDF file. If unset, AletheiaSans.ttf is used.\n    (Make sure to pick a font which covers all glyphs!)\n   \"outlines\" [string - \"\"]\n    What segment hierarchy to draw coordinate outlines for. If unset, no\n    outlines are drawn.\n    Possible values: [\"\", \"region\", \"line\", \"word\", \"glyph\"]\n   \"textequiv_level\" [string - \"\"]\n    What segment hierarchy level to render text output from. If unset, no\n    text is rendered.\n    Possible values: [\"\", \"region\", \"line\", \"word\", \"glyph\"]\n   \"negative2zero\" [boolean - false]\n    Repair invalid or inconsistent coordinates before trying to convert.\n   \"ext\" [string - \".pdf\"]\n    Output filename extension\n   \"multipage\" [string - \"\"]\n    Merge all PDFs into one multipage file. The value is used as METS\n    file ID and file basename for the PDF.\n   \"multipage_only\" [boolean - false]\n    When producing a `multipage`, do not add single-page files into the\n    output fileGrp (but use a temporary directory for them).\n   \"pagelabel\" [string - \"pageId\"]\n    Parameter for 'multipage': Set the labels used as page outlines.\n\n    - 'pageId': physical page ID,\n\n    - 'pagenumber': use consecutive numbers,\n\n    - 'pagelabel': use '@ORDERLABEL - @LABEL',\n\n    - 'basename': use the name of the input file,\n\n    - 'local_filename': use the href relative path of the input file,\n\n    - 'url': use the href URL of the input file,\n\n    - 'ID': use the file ID of the input file\n    Possible values: [\"pagenumber\", \"pagelabel\", \"pageId\", \"basename\",\n    \"basename_without_extension\", \"local_filename\", \"ID\", \"url\"]\n   \"script-args\" [string - \"\"]\n    Extra arguments to PageToPdf (see https://github.com/PRImA-Research-\n    Lab/prima-page-to-pdf)\n

\n\n

\n\n### ocrd-altotopdf\n\n

OCR-D CLI

\n\n\n

\nUsage: ocrd-altotopdf [worker|server] [OPTIONS]\n\n  Convert text and layout annotations from ALTO to PDF format (overlaying original image with text layer and polygon outlines)\n\n  > Converts all pages of the document to PDF\n\n  > For each page, find the ALTO input file in the first fileGrp,\n  > together with the image input file in the second fileGrp.\n\n  > Then convert ALTO to PAGE with PRImA PageConverter in a temporary\n  > location.\n\n  > Next convert the PAGE/image pair with PRImA PageToPdf in a temporary location,\n  > applying\n  > - ``textequiv_level`` (i.e. `-text-source`) to retrieve a text layer, if set;\n  > - ``outlines`` to draw boundary polygons, if set;\n  > - ``font`` accordingly;\n  > - ``negative2zero`` (i.e. `-neg-coords toZero`) to repair negative coordintes.\n\n  > Copy to the resulting PDF file to the output file group and\n  > reference it in the METS.\n\n  > Finally, if ``multipage`` is set, then concatenate all generated\n  > files to a multi-page PDF file, setting ``pagelabels`` accordingly,\n  > as well as PDF metadata and bookmarks. Reference it with\n  > ``multipage`` as ID in the output fileGrp, too. If\n  > ``multipage_only`` is also set, then remove the single-page PDF\n  > files afterwards.\n\nSubcommands:\n    worker      Start a processing worker rather than do local processing\n    server      Start a processor server rather than do local processing\n\nOptions for processing:\n  -m, --mets URL-PATH             URL or file path of METS to process [./mets.xml]\n  -w, --working-dir PATH          Working directory of local workspace [dirname(URL-PATH)]\n  -I, --input-file-grp USE        File group(s) used as input\n  -O, --output-file-grp USE       File group(s) used as output\n  -g, --page-id ID                Physical page ID(s) to process instead of full document []\n  --overwrite                     Remove existing output pages/images\n                                  (with \"--page-id\", remove only those).\n                                  Short-hand for OCRD_EXISTING_OUTPUT=OVERWRITE\n  --debug                         Abort on any errors with full stack trace.\n                                  Short-hand for OCRD_MISSING_OUTPUT=ABORT\n  --profile                       Enable profiling\n  --profile-file PROF-PATH        Write cProfile stats to PROF-PATH. Implies \"--profile\"\n  -p, --parameter JSON-PATH       Parameters, either verbatim JSON string\n                                  or JSON file path\n  -P, --param-override KEY VAL    Override a single JSON object key-value pair,\n                                  taking precedence over --parameter\n  -U, --mets-server-url URL       URL of a METS Server for parallel incremental access to METS\n                                  If URL starts with http:// start an HTTP server there,\n                                  otherwise URL is a path to an on-demand-created unix socket\n  -l, --log-level [OFF|ERROR|WARN|INFO|DEBUG|TRACE]\n                                  Override log level globally [INFO]\n  --log-filename LOG-PATH         File to redirect stderr logging to (overriding ocrd_logging.conf).\n\nOptions for information:\n  -C, --show-resource RESNAME     Dump the content of processor resource RESNAME\n  -L, --list-resources            List names of processor resources\n  -J, --dump-json                 Dump tool description as JSON\n  -D, --dump-module-dir           Show the 'module' resource location path for this processor\n  -h, --help                      Show this message\n  -V, --version                   Show version\n\nParameters:\n   \"font\" [string - \"\"]\n    Font file to be used in PDF file. If unset, AletheiaSans.ttf is used.\n    (Make sure to pick a font which covers all glyphs!)\n   \"outlines\" [string - \"\"]\n    What segment hierarchy to draw coordinate outlines for. If unset, no\n    outlines are drawn.\n    Possible values: [\"\", \"region\", \"line\", \"word\", \"glyph\"]\n   \"textequiv_level\" [string - \"\"]\n    What segment hierarchy level to render text output from. If unset, no\n    text is rendered.\n    Possible values: [\"\", \"region\", \"line\", \"word\", \"glyph\"]\n   \"negative2zero\" [boolean - false]\n    Repair invalid or inconsistent coordinates before trying to convert.\n   \"ext\" [string - \".pdf\"]\n    Output filename extension\n   \"multipage\" [string - \"\"]\n    Merge all PDFs into one multipage file. The value is used as METS\n    file ID and file basename for the PDF.\n   \"multipage_only\" [boolean - false]\n    When producing a `multipage`, do not add single-page files into the\n    output fileGrp (but use a temporary directory for them).\n   \"pagelabel\" [string - \"pageId\"]\n    Parameter for 'multipage': Set the labels used as page outlines.\n\n    - 'pageId': physical page ID,\n\n    - 'pagenumber': use consecutive numbers,\n\n    - 'pagelabel': use '@ORDERLABEL - @LABEL',\n\n    - 'basename': use the name of the input file,\n\n    - 'local_filename': use the href relative path of the input file,\n\n    - 'url': use the href URL of the input file,\n\n    - 'ID': use the file ID of the input file\n    Possible values: [\"pagenumber\", \"pagelabel\", \"pageId\", \"basename\",\n    \"basename_without_extension\", \"local_filename\", \"ID\", \"url\"]\n   \"script-args\" [string - \"\"]\n    Extra arguments to PageToPdf (see https://github.com/PRImA-Research-\n    Lab/prima-page-to-pdf)\n

\n\n

\n\n\n## FAQ\n\n- `Illegal reflective access by com.itextpdf.text.io.ByteBufferRandomAccessSource$1 to method java.nio.DirectByteBuffer.cleaner()`\n If that appears, try installing OpenJDK 8.\n\n- `java.lang.NullPointerException` \n If that appears, try (a little workaround) and set negative coordinates to zero:\n \n ocrd-pagetopdf -I PAGE-FILGRP -O PDF-FILEGRP ... -P negative2zero true\n\n- Some letters are illegible?\n Please note that the standard displayed font ([AletheiaSans.ttf](https://github.com/PRImA-Research-Lab/prima-aletheia-web/raw/master/war/aletheiasans-webfont.ttf)) does not support all Unicode glyphs. In case yours are missing, set a (monospace) Unicode font yourself:\n \n ocrd-pagetopdf -I PAGE-FILGRP -O PDF-FILEGRP ... -P font /usr/share/fonts/truetype/ubuntu/UbuntuMono-R.ttf\n \n Fonts can also be referenced by file name if they are installed as [processor resources](https://ocr-d.de/en/spec/cli#processor-resources). A number of options have been preconfigured, cf. `ocrd resmgr list-available -e ocrd-pagetopdf`.\n\n- The multipage file's page labels can be configured, e.g. consecutively via `pagelabel=pagenumber` or from `@ORDERLABEL` and `@LABEL` via `pagelabel=pagelabel`:\n \n ocrd-pagetopdf -I PAGE-FILGRP -O PDF-FILEGRP ... -P pagelabel pagelabel\n\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",4374338685,"orgData",{"_86":87,"_88":89,"_90":91,"_92":29,"_93":94,"_95":94,"_96":94,"_97":98,"_99":100,"_101":102,"_103":94,"_104":94,"_105":17},"id","8a3ad25cf3ec4f51a581d0798c88a85e","uuid","8a3ad25c-f3ec-4f51-a581-d0798c88a85e","type","organization","orgname","full_name","","location","company","profile_url","http://ocr-d.de","date_joined","2018-04-05T15:12:40.04219Z","gravatar_url","https://www.gravatar.com/avatar/5adbc7a3e901e82871d91421004b520b?s=80&r=g&d=mm","gravatar_email","badge","is_active","recentTags",[108],{"_109":40,"_110":111,"_112":113,"_114":115,"_86":116,"_117":118,"_46":133,"_134":135,"_136":137,"_138":52,"_53":139,"_140":141,"_142":124,"_143":133,"_144":62,"_145":17},"content_type","creator",17223019,"digest","sha256:cd0026a29b3588b189ba36d04dd5086c1c087579269f9471a92f45a2dae70c6f","full_size",684118063,783245703,"images",[119],{"_120":121,"_112":113,"_122":94,"_123":124,"_125":126,"_127":128,"_129":94,"_130":-5,"_131":115,"_59":62,"_132":-5},"architecture","amd64","features","last_pulled","2026-09-25T22:09:25.541608025Z","last_pushed","2025-10-30T14:10:17.908102372Z","os","linux","os_features","os_version","size","variant","2025-10-30T14:10:18.418484Z","last_updater",257751,"last_updater_username","kbai","media_type","latest","repository",25514989,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":157,"_164":165,"_153":174,"_175":11},{"_36":158,"_38":159,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":160,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":161,"_75":11,"_76":163,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":162},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_166":60,"_167":-5,"_168":-5,"_169":170},"count","next","previous","results",[171],{"_109":40,"_110":111,"_112":113,"_114":115,"_86":116,"_117":172,"_46":133,"_134":135,"_136":137,"_138":52,"_53":139,"_140":141,"_142":124,"_143":133,"_144":62,"_145":17},[173],{"_120":121,"_112":113,"_122":94,"_123":124,"_125":126,"_127":128,"_129":94,"_130":-5,"_131":115,"_59":62,"_132":-5},[],"canDeleteTags","actionData","errors"]

ocrd/pagetopdf

Tags for ocrd/pagetopdf