Beginning v2.4 documentation

This commit is contained in:
John Whitington 2021-05-20 16:53:35 +01:00
parent dfe6b6bb3e
commit 3436c57daf
2 changed files with 49 additions and 22 deletions

View File

@ -1536,6 +1536,9 @@ and specs =
("-idir", ("-idir",
Arg.String set_input_dir, Arg.String set_input_dir,
" Add a directory of files"); " Add a directory of files");
("-pw",
Arg.String setdashpassword,
" Supply a password explicitly -pw=<password>");
("-stdin", ("-stdin",
Arg.Unit setstdin, Arg.Unit setstdin,
" Read input from standard input"); " Read input from standard input");
@ -2146,6 +2149,9 @@ and specs =
("-gs-quiet", ("-gs-quiet",
Arg.Unit setgsquiet, Arg.Unit setgsquiet,
" Make gs go into quiet mode"); " Make gs go into quiet mode");
("-gs-malformed-force",
Arg.Unit whingemalformed,
" See manual for usage.");
("-im", ("-im",
Arg.String setimpath, Arg.String setimpath,
" Path to imagemagick executable"); " Path to imagemagick executable");
@ -2161,23 +2167,48 @@ and specs =
("-dedup-perpage", ("-dedup-perpage",
Arg.Unit set_dedup_per_page, Arg.Unit set_dedup_per_page,
" Deduplicate extracted images per page only"); " Deduplicate extracted images per page only");
("-squeeze", Arg.Unit setsqueeze, " Squeeze"); ("-squeeze",
("-squeeze-log-to", Arg.String setsqueezelogto, " Squeeze log location"); Arg.Unit setsqueeze,
("-squeeze-no-pagedata", Arg.Unit setsqueezepagedata, " Don't recompress pages"); " Squeeze");
("-squeeze-no-recompress", Arg.Unit setsqueezerecompress, " Don't recompress streams"); ("-squeeze-log-to",
(* Just for error reporting *) Arg.String setsqueezelogto,
("-gs-malformed-force", Arg.Unit whingemalformed, ""); " Squeeze log location");
(* These items are not documented yet, but will be soon *) ("-squeeze-no-pagedata",
("-output-json", Arg.Unit (setop OutputJSON), ""); Arg.Unit setsqueezepagedata,
("-output-json-parse-content-streams", Arg.Unit setjsonparsecontentstreams, ""); " Don't recompress pages");
("-output-json-no-stream-data", Arg.Unit setjsonnostreamdata, ""); ("-squeeze-no-recompress",
("-ocg-coalesce-on-name", Arg.Unit (setop OCGCoalesce), ""); Arg.Unit setsqueezerecompress,
("-ocg-list", Arg.Unit (setop OCGList), ""); " Don't recompress streams");
("-ocg-rename", Arg.Unit (setop OCGRename), ""); ("-output-json",
("-ocg-rename-from", Arg.String setocgrenamefrom, ""); Arg.Unit (setop OutputJSON),
("-ocg-rename-to", Arg.String setocgrenameto, ""); " Export PDF file as JSON data");
("-ocg-order-all", Arg.Unit (setop OCGOrderAll), ""); ("-output-json-parse-content-streams",
("-stamp-as-xobject", Arg.String setstampasxobject, ""); Arg.Unit setjsonparsecontentstreams,
" Parse content streams");
("-output-json-no-stream-data",
Arg.Unit setjsonnostreamdata,
" Skip stream data for brevity");
("-ocg-list",
Arg.Unit (setop OCGList),
" List optional content groups");
("-ocg-rename",
Arg.Unit (setop OCGRename),
" Rename optional content group");
("-ocg-rename-from",
Arg.String setocgrenamefrom,
" Rename from (with -ocg-rename)");
("-ocg-rename-to",
Arg.String setocgrenameto,
" Rename to (with -ocg-rename)");
("-ocg-order-all",
Arg.Unit (setop OCGOrderAll),
" Repair /Order so all OCGs listed ");
("-ocg-coalesce-on-name",
Arg.Unit (setop OCGCoalesce),
" Coalesce OCGs with like name");
("-stamp-as-xobject",
Arg.String setstampasxobject,
"Stamp a file as a form xobject in another");
(* These items are undocumented *) (* These items are undocumented *)
("-remove-unused-resources", Arg.Unit (setop RemoveUnusedResources), ""); ("-remove-unused-resources", Arg.Unit (setop RemoveUnusedResources), "");
("-stay-on-error", Arg.Unit setstayonerror, ""); ("-stay-on-error", Arg.Unit setstayonerror, "");
@ -2195,7 +2226,6 @@ and specs =
("-fix-prince", Arg.Unit (setop RemoveUnusedResources), ""); ("-fix-prince", Arg.Unit (setop RemoveUnusedResources), "");
("-extract-text", Arg.Unit (setop ExtractText), ""); ("-extract-text", Arg.Unit (setop ExtractText), "");
("-extract-text-font-size", Arg.Float setextracttextfontsize, ""); ("-extract-text-font-size", Arg.Float setextracttextfontsize, "");
("-pw", Arg.String setdashpassword, "");
] ]
and usage_msg = and usage_msg =

View File

@ -1,6 +1,3 @@
%a. Suggest adding the section numbers to the titles of bookmarks in the outline of the User Manual to more closely mimic the table of contents. The table of contents is primarily an artifact for the printed version and not particularly convenient for the reader of the PDF version.
%Document -pw
%Document -prepend-content, -postpend-content
\documentclass{book} \documentclass{book}
\usepackage{palatino} \usepackage{palatino}
\usepackage{microtype} \usepackage{microtype}
@ -37,7 +34,7 @@ Command Line Toolkit}
\vspace{12mm} \vspace{12mm}
{\Huge User Manual}\\ {\Huge User Manual}\\
Version 2.4 (? 2020) Version 2.4 (June 2021)
\vspace{25mm} \vspace{25mm}