Commandline options are grouped by
General, Actions, Programs, Configs and Styles.
Some Actions are single actions,
exiting after executing, ignoring other Actions.
Others are sequential actions.
See Actions.
Many options are related to only a specific Action.
Unrelated options are just ignored.
Configs and Styles options are mostly the same
as Config Options.
You have to format commandline strings,
following the rules specified there
(according to Value Functions).
Note
For [LINE] options,
it may not be easy to actually supply multiple values.
For example, an option in a configuration file becomes like this in bash:
opt= aaa
bbb
--opt $'aaa\\nbbb'
.. option:: -i, --input INPUT
input rsrc (URL or file path). it can be specified multiple times
.. option:: -f, --file FILE
file to read inputs. only one file
default=rsrcs.txt
.. option:: -h, --help
show this help message and exit
.. option:: -v, --verbose
print out more detailed log messages
.. option:: -q, --quiet
supress non-critical log messages
.. option:: -V, --version
print version and exit
.. option:: --userdir USERDIR
specify user configuration directory
.. option:: --nouserdir
disable user configuration (intended for testing)
.. option:: -1, --download
download by downloader
.. option:: -2, --extract
extract by extractor
.. option:: -3, --convert
convert by converter
.. option:: -4, --view
open a pdf viewer if configured
.. option:: -a, --appcheck
print application settings after command line evaluation, and exit
.. option:: -b, --browser
open first extracted html (efile) in browser, and exit
.. option:: -c, --check
print matched rsrc settings, and exit (so you have to supply rsrc some way)
.. option:: --toc
create toc htmls and a toc rsrc list file. conflicts with '--input'.
.. option:: --inspect
parse downloaded htmls (dfiles), and do arbitrary things user specified
.. option:: --printout {0,1,2,3,all}
print filenames the program's actions would create (0=rsrc, 1=dfiles, 2=efiles 3=pdfname, all=0<tab>1<tab>2)
choices=0, 1, 2, 3, all
.. option:: --urllib
set downloader to urllib (default)
.. option:: --headless
set downloader to one of headless browser engines (see --browser-engine)
.. option:: --lxml
set extractor to lxml (default, and currently the only option)
.. option:: --prince
set converter to princexml
.. option:: --weasyprint
set converter to weasyprint
.. option:: --cnvpath CNVPATH
specify converter executable path. also need to set converter itself
.. option:: --css2 CSS2
specify css files, for converter commandline css option
.. option:: --cnvopts CNVOPTS
specify additional converter commandline options
.. option:: --user-agent USER_AGENT
set http request user-agent (only for urllib)
.. option:: --timeout TIMEOUT
set http request timeout (only for urllib)
.. option:: --interval INTERVAL
interval for each download
.. option:: --browser-engine {selenium-chrome,selenium-firefox}
specify the browser engine when 'headless' (default: selenium-firefox)
choices=selenium-chrome, selenium-firefox
.. option:: --selenium-chrome-path SELENIUM_CHROME_PATH
specify the path of chromedriver for selenium
.. option:: --selenium-firefox-path SELENIUM_FIREFOX_PATH
specify the path of geckodriver for selenium
.. option:: --encoding ENCODING
specify encoding candidates for file opening when extract (f: comma)
.. option:: --encoding-errors { (choices...) }
specify encoding error handler (default: strict)
choices=strict, ignore, replace, xmlcharrefreplace, backslashreplace, namereplace, surrogateescape, surrogatepass
.. option:: --parts-download
download components (images etc.) before PDF conversion (default: True)
.. option:: --no-parts-download
not download components before PDF conversion
.. option:: --force-download
force '--download' and '--parts-download' even if the file already exists
.. option:: --guess GUESS
if there is no matched option, use this XPath for content selection (f: line)
.. option:: --full-image FULL_IMAGE
pixel size to add special class attributes to images (default: 200)
.. option:: --add-binary-extensions ADD_BINARY_EXTENSIONS
add or subtract to-skip-binaries-extension list (f: plus_binaries)
.. option:: --add-clean-tags ADD_CLEAN_TAGS
add or subtract to-delete-tag list (f: plus)
.. option:: --add-clean-attrs ADD_CLEAN_ATTRS
add or subtract to-delete-attribute list (f: plus)
.. option:: --elements-to-keep-attrs ELEMENTS_TO_KEEP_ATTRS
specify elements (XPath) in which you want to keep attributes (default: <math>, <svg> and some mathjax tags) (f: line)
.. option:: --styles-to-retain STYLES_TO_RETAIN
specify particular inline styles you want to retain (all other styles are removed). if only the property is provided (no values after ':'), then all values are retained as is. ';' before each line end is optional. (default: "content:;", "display: none;", "text-decoration-line: line-through;", "text-decoration: line-through;") (f: line)
.. option:: --clean {both,head,body,none}
specify how to clean html (both, head, body, none) (default: both)
choices=both, head, body, none
.. option:: --ftype {html,prose,nonprose,python}
specify file type
choices=html, prose, nonprose, python
.. option:: --textwidth TEXTWIDTH
width (character numbers) for rendering non-prose text
.. option:: --textindent TEXTINDENT
line continuation marker for rendering non-prose text
.. option:: --trimdirs TRIMDIRS
if no sign, remove leading directories from local text name in PDF TOC. if minus sign, remove leading directories to reduce path segments to that abs number. (default: 3)
.. option:: --raw
use input paths as is (no filename transformation)
.. option:: --pdfname PDFNAME
specify pdf file name
.. option:: --precmd1 PRECMD1
run arbitrary commands before download action
.. option:: --postcmd1 POSTCMD1
run arbitrary commands after download action
.. option:: --precmd2 PRECMD2
run arbitrary commands before extract action
.. option:: --postcmd2 POSTCMD2
run arbitrary commands after extract action
.. option:: --precmd3 PRECMD3
run arbitrary commands before convert action
.. option:: --postcmd3 POSTCMD3
run arbitrary commands after convert action
.. option:: --viewcmd VIEWCMD
commandline string to open the pdf viewer (f: cmds)
.. option:: --pre-each-cmd1 PRE_EACH_CMD1
run arbitrary commands before each download
.. option:: --post-each-cmd1 POST_EACH_CMD1
run arbitrary commands after each download
.. option:: --pre-each-cmd2 PRE_EACH_CMD2
run arbitrary commands before each extract
.. option:: --post-each-cmd2 POST_EACH_CMD2
run arbitrary commands after each extract
.. option:: --download-dir DOWNLOAD_DIR
specify root directory for download and extract (default: '_htmls')
.. option:: --keep-html
do not extract, keep html as is, just component download to make complete local version html
.. option:: --overwrite-html
do not create new 'efile' (overwrite 'dfile')
.. option:: --orientation {portrait,landscape}
portrait (default) or landscape, determine which size data to use
choices=portrait, landscape
.. option:: --portrait-size PORTRAIT_SIZE
portrait size for css, e.g. '90mm 118mm'
.. option:: --landscape-size LANDSCAPE_SIZE
landscape size for css, e.g. '118mm 90mm'
.. option:: --toc-depth TOC_DEPTH
specify depth of table of contents
.. option:: --font-family FONT_FAMILY
main font for css, e.g. '"DejaVu Sans", sans-serif'
.. option:: --font-mono FONT_MONO
monospace font for css
.. option:: --font-serif FONT_SERIF
serif font for css (not used by sample)
.. option:: --font-sans FONT_SANS
sans font for css (not used by sample)
.. option:: --font-size FONT_SIZE
main font size for css, e.g. '9px'
.. option:: --font-size-mono FONT_SIZE_MONO
monospace font size for css
.. option:: --font-scale FONT_SCALE
number like 1.5 to scale base font sizes (default: 1.0)
.. option:: --line-height LINE_HEIGHT
adjust line height (default: 1.3)