neulab/tldr huggingface dataset:
get dbmaxmatches gets the max number of matches stored in database per ticket
set dbpurgeage <SECONDS> sets the max age in <SECONDS> that history of bans will be kept
get dbpurgeage gets the max age in seconds that history of bans will be kept
JAIL CONTROL
add <JAIL> <BACKEND> creates <JAIL> using <BACKEND>
start <JAIL> starts the jail <JAIL>
stop <JAIL> stops the jail <JAIL>. The jail is removed
status <JAIL> [FLAVOR] gets the current status of <JAIL>, with optional flavor or extended info
JAIL CONFIGURATION
set <JAIL> idle on|off sets the idle state of <JAIL>
set <JAIL> ignoreself true|false allows the ignoring of own IP addresses
set <JAIL> addignoreip <IP> adds <IP> to the ignore list of <JAIL>
set <JAIL> delignoreip <IP> removes <IP> from the ignore list of <JAIL>
set <JAIL> ignorecommand <VALUE> sets ignorecommand of <JAIL>
set <JAIL> ignorecache <VALUE> sets ignorecache of <JAIL>
set <JAIL> addlogpath <FILE> ['tail'] adds <FILE> to the monitoring list of <JAIL>, optionally starting at the 'tail' of the file (default 'head').
set <JAIL> dellogpath <FILE> removes <FILE> from the monitoring list of <JAIL>
set <JAIL> logencoding <ENCODING> sets the <ENCODING> of the log files for <JAIL>
set <JAIL> addjournalmatch <MATCH> adds <MATCH> to the journal filter of <JAIL>
set <JAIL> deljournalmatch <MATCH> removes <MATCH> from the journal filter of <JAIL>
set <JAIL> addfailregex <REGEX> adds the regular expression <REGEX> which must match failures for <JAIL>
set <JAIL> delfailregex <INDEX> removes the regular expression at <INDEX> for failregex
set <JAIL> addignoreregex <REGEX> adds the regular expression <REGEX> which should match pattern to exclude for <JAIL>
set <JAIL> delignoreregex <INDEX> removes the regular expression at <INDEX> for ignoreregex
set <JAIL> findtime <TIME> sets the number of seconds <TIME> for which the filter will look back for <JAIL>
set <JAIL> bantime <TIME> sets the number of seconds <TIME> a host will be banned for <JAIL>
set <JAIL> datepattern <PATTERN> sets the <PATTERN> used to match date/times for <JAIL>
set <JAIL> usedns <VALUE> sets the usedns mode for <JAIL>
set <JAIL> attempt <IP> [<failure1> ... <failureN>] manually notify about <IP> failure
set <JAIL> banip <IP> ... <IP> manually Ban <IP> for <JAIL>
set <JAIL> unbanip [--report-absent] <IP> ... <IP> manually Unban <IP> in <JAIL>
set <JAIL> maxretry <RETRY> sets the number of failures <RETRY> before banning the host for <JAIL>
set <JAIL> maxmatches <INT> sets the max number of matches stored in memory per ticket in <JAIL>
set <JAIL> maxlines <LINES> sets the number of <LINES> to buffer for regex search for <JAIL>
set <JAIL> addaction <ACT>[ <PYTHONFILE> <JSONKWARGS>] adds a new action named <ACT> for <JAIL>. Optionally for a Python based action, a <PYTHONFILE> and <JSONKWARGS> can be specified, else will be a Command Action
set <JAIL> delaction <ACT> removes the action <ACT> from <JAIL>
COMMAND ACTION CONFIGURATION
set <JAIL> action <ACT> actionstart <CMD> sets the start command <CMD> of the action <ACT> for <JAIL>
set <JAIL> action <ACT> actionstop <CMD> sets the stop command <CMD> of the action <ACT> for <JAIL>
set <JAIL> action <ACT> actioncheck <CMD> sets the check command <CMD> of the action <ACT> for <JAIL>
set <JAIL> action <ACT> actionban <CMD> sets the ban command <CMD> of the action <ACT> for <JAIL>
set <JAIL> action <ACT> actionunban <CMD> sets the unban command <CMD> of the action <ACT> for <JAIL>
set <JAIL> action <ACT> timeout <TIMEOUT> sets <TIMEOUT> as the command timeout in seconds for the action <ACT> for <JAIL>
GENERAL ACTION CONFIGURATION
set <JAIL> action <ACT> <PROPERTY> <VALUE> sets the <VALUE> of <PROPERTY> for the action <ACT> for <JAIL>
set <JAIL> action <ACT> <METHOD>[ <JSONKWARGS>] calls the <METHOD> with <JSONKWARGS> for the action <ACT> for <JAIL>
JAIL INFORMATION
get <JAIL> banned return banned IPs of <JAIL>
get <JAIL> banned <IP> ... <IP>] return 1 if IP is banned in <JAIL> otherwise 0, or a list of 1/0 for multiple IPs
get <JAIL> logpath gets the list of the monitored files for <JAIL>
get <JAIL> logencoding gets the encoding of the log files for <JAIL>
get <JAIL> journalmatch gets the journal filter match for <JAIL>
get <JAIL> ignoreself gets the current value of the ignoring the own IP addresses
get <JAIL> ignoreip gets the list of ignored IP addresses for <JAIL>
get <JAIL> ignorecommand gets ignorecommand of <JAIL>
get <JAIL> failregex gets the list of regular expressions which matches the failures for <JAIL>
get <JAIL> ignoreregex gets the list of regular expressions which matches patterns to ignore for <JAIL>
get <JAIL> findtime gets the time for which the filter will look back for failures for <JAIL>
get <JAIL> bantime gets the time a host is banned for <JAIL>
get <JAIL> datepattern gets the patern used to match date/times for <JAIL>
get <JAIL> usedns gets the usedns setting for <JAIL>
get <JAIL> banip [<SEP>|--with-time] gets the list of of banned IP addresses for <JAIL>. Optionally the separator character ('<SEP>', default is space) or the option '--with-time' (printing the times of ban) may be specified. The IPs are ordered by end of ban.
get <JAIL> maxretry gets the number of failures allowed for <JAIL>
get <JAIL> maxmatches gets the max number of matches stored in memory per ticket in <JAIL>
get <JAIL> maxlines gets the number of lines to buffer for <JAIL>
get <JAIL> actions gets a list of actions for <JAIL>
COMMAND ACTION INFORMATION
get <JAIL> action <ACT> actionstart gets the start command for the action <ACT> for <JAIL>
get <JAIL> action <ACT> actionstop gets the stop command for the action <ACT> for <JAIL>
get <JAIL> action <ACT> actioncheck gets the check command for the action <ACT> for <JAIL>
get <JAIL> action <ACT> actionban gets the ban command for the action <ACT> for <JAIL>
get <JAIL> action <ACT> actionunban gets the unban command for the action <ACT> for <JAIL>
get <JAIL> action <ACT> timeout gets the command timeout in seconds for the action <ACT> for <JAIL>
GENERAL ACTION INFORMATION
get <JAIL> actionproperties <ACT> gets a list of properties for the action <ACT> for <JAIL>
get <JAIL> actionmethods <ACT> gets a list of methods for the action <ACT> for <JAIL>
get <JAIL> action <ACT> <PROPERTY> gets the value of <PROPERTY> for the action <ACT> for <JAIL>
/etc/fail2ban/*
Report bugs to https://github.com/fail2ban/fail2ban/issues
fail2ban-server(1) jail.conf(5)
IP(8)                                 Linux                                IP(8)
ip - show / manipulate routing, network devices, interfaces and tunnels
ip [ OPTIONS ] OBJECT { COMMAND | help }
ip [ -force ] -batch filename
OBJECT := { link | address | addrlabel | route | rule | neigh | ntable | tunnel | tuntap | maddress | mroute | mrule | monitor | xfrm | netns | l2tp | tcp_metrics | token | macsec | vrf | mptcp | ioam }
OPTIONS := { -V[ersion] | -h[uman-readable] | -s[tatistics] | -d[etails] | -r[esolve] | -iec | -f[amily] { inet | inet6 | link } | -4 | -6 | -B | -0 | -l[oops] { maximum-addr-flush-attempts } | -o[neline] | -rc[vbuf] [size] | -t[imestamp] | -ts[hort] | -n[etns] name | -N[umeric] | -a[ll] | -c[olor] | -br[ief] | -j[son] | -p[retty] }
-V, -Version Print the version of the ip utility and exit.
-h, -human, -human-readable output statistics with human readable values followed by suffix.
-b, -batch <FILENAME> Read commands from provided file or standard input and invoke them.  First failure will cause termination of ip.
-force Don't terminate ip on errors in batch mode.  If there were any errors during execution of the commands, the application return code will be non zero.
-s, -stats, -statistics Output more information. If the option appears twice or more, the amount of information increases.  As a rule, the information is statistics or some time values.
-d, -details Output more detailed information.
-l, -loops <COUNT> Specify maximum number of loops the 'ip address flush' logic will attempt before giving up. The default is 10.  Zero (0) means loop until all addresses are removed.
-f, -family <FAMILY> Specifies the protocol family to use. The protocol family identifier can be one of inet, inet6, bridge, mpls or link.  If this option is not present, the protocol family is guessed from other arguments. If the rest of the command line does not give enough information to guess the family, ip falls back to the default one, usually inet or any.  link is a special family identifier meaning that no networking protocol is involved.
-4     shortcut for -family inet.
-6     shortcut for -family inet6.
-B     shortcut for -family bridge.
-M     shortcut for -family mpls.
-0     shortcut for -family link.
-o, -oneline output each record on a single line, replacing line feeds with the '\' character. This is convenient when you want to count records with wc(1) or to grep(1) the output.
-r, -resolve use the system's name resolver to print DNS names instead of host addresses.
-n, -netns <NETNS> switches ip to the specified network namespace NETNS.  Actually it just simplifies executing of:
ip netns exec NETNS ip [ OPTIONS ] OBJECT { COMMAND | help }
ip -n[etns] NETNS [ OPTIONS ] OBJECT { COMMAND | help }
-N, -Numeric Print the number of protocol, scope, dsfield, etc directly instead of converting it to human readable name.
-a, -all executes specified command over all objects, it depends if command supports this option.
-c[color][={always|auto|never} Configure color output. If parameter is omitted or always, color output is enabled regardless of stdout state. If parameter is auto, stdout is checked to be a terminal before enabling color output. If parameter is never, color output is disabled. If specified multiple times, the last one takes precedence. This flag is ignored if -json is also given.
Used color palette can be influenced by COLORFGBG environment variable (see ENVIRONMENT).
-t, -timestamp display current time when using monitor option.
-ts, -tshort Like -timestamp, but use shorter format.
-rc, -rcvbuf<SIZE> Set the netlink socket receive buffer size, defaults to 1MB.
-iec   print human readable rates in IEC units (e.g. 1Ki = 1024).
-br, -brief Print only basic information in a tabular format for better readability. This option is currently only supported by ip addr show , ip link show & ip neigh show commands.
-j, -json Output results in JavaScript Object Notation (JSON).
-p, -pretty The default JSON format is compact and more efficient to parse but hard for most users to read.  This flag adds indentation for readability.
IP - COMMAND SYNTAX OBJECT address - protocol (IP or IPv6) address on a device.
addrlabel - label configuration for protocol address selection.
ioam   - manage IOAM namespaces and IOAM schemas.
l2tp   - tunnel ethernet over IP (L2TPv3).
link   - network device.
maddress - multicast address.
monitor - watch for netlink messages.
mptcp  - manage MPTCP path manager.
mroute - multicast routing cache entry.
mrule  - rule in multicast routing policy database.
neighbour - manage ARP or NDISC cache entries.
netns  - manage network namespaces.
ntable - manage the neighbor cache's operation.
route  - routing table entry.
rule   - rule in routing policy database.
tcp_metrics/tcpmetrics - manage TCP Metrics
token  - manage tokenized interface identifiers.
tunnel - tunnel over IP.
tuntap - manage TUN/TAP devices.
vrf    - manage virtual routing and forwarding devices.
xfrm   - manage IPSec policies.
The names of all objects may be written in full or abbreviated form, for example address can be abbreviated as addr or just a.
COMMAND Specifies the action to perform on the object.  The set of possible actions depends on the object type.  As a rule, it is possible to add, delete and show (or list ) objects, but some objects do not allow all of these operations or have some additional commands. The help command is available for all objects. It prints out a list of available commands and argument syntax conventions.
If no command is given, some default command is assumed.  Usually it is list or, if the objects of this class cannot be listed, help.
COLORFGBG If set, it's value is used for detection whether background is dark or light and use contrast colors for it.
COLORFGBG environment variable usually contains either two or three values separated by semicolons; we want the last value in either case.  If this value is 0-6 or 8, chose colors suitable for dark background:
COLORFGBG=";0" ip -c a
Exit status is 0 if command was successful, and 1 if there is a syntax error.  If an error was reported by the kernel exit status is 2.
ip addr Shows addresses assigned to all network interfaces.
ip neigh Shows the current neighbour table in kernel.
ip link set x up Bring up interface x.
ip link set x down Bring down interface x.
ip route Show table routes.
ip was written by Alexey N. Kuznetsov and added in Linux 2.2.
ip-address(8), ip-addrlabel(8), ip-ioam(8), ip-l2tp(8), ip-link(8), ip- maddress(8), ip-monitor(8), ip-mptcp(8), ip-mroute(8), ip-neighbour(8), ip-netns(8), ip-ntable(8), ip-route(8), ip-rule(8), ip-tcp_metrics(8), ip-token(8), ip-tunnel(8), ip-vrf(8), ip-xfrm(8) IP Command reference ip-cref.ps
Report any bugs to the Network Developers mailing list <netdev@vger.kernel.org> where the development and maintenance is primarily done.  You do not have to be subscribed to the list to send a message there.
MKFS(8)                       System Administration                      MKFS(8)
mkfs - build a Linux filesystem
mkfs [options] [-t type] [fs-options] device [size]
This mkfs frontend is deprecated in favour of filesystem specific mkfs.<type> utils.
mkfs is used to build a Linux filesystem on a device, usually a hard disk partition. The device argument is either the device name (e.g., /dev/hda1, /dev/sdb2), or a regular file that shall contain the filesystem. The size argument is the number of blocks to be used for the filesystem.
The exit status returned by mkfs is 0 on success and 1 on failure.
In actuality, mkfs is simply a front-end for the various filesystem builders (mkfs.fstype) available under Linux. The filesystem-specific builder is searched for via your PATH environment setting only. Please see the filesystem-specific builder manual pages for further details.
-t, --type type Specify the type of filesystem to be built. If not specified, the default filesystem type (currently ext2) is used.
fs-options Filesystem-specific options to be passed to the real filesystem builder.
-V, --verbose Produce verbose output, including all filesystem-specific commands that are executed. Specifying this option more than once inhibits execution of any filesystem-specific commands. This is really only useful for testing.
-V, --version Display version information and exit. (Option -V will display version information only when it is the only parameter, otherwise it will work as --verbose.)
All generic options must precede and not be combined with filesystem-specific options. Some filesystem-specific programs do not automatically detect the device size and require the size parameter to be specified.
David Engel <david@ods.com>, Fred N. van Kempen <waltje@uwalt.nl.mugnet.org>, Ron Sommeling <sommel@sci.kun.nl>.
The manual page was shamelessly adapted from Remy Cardâ€™s version for the ext2 filesystem.
fs(5), badblocks(8), fsck(8), mkdosfs(8), mke2fs(8), mkfs.bfs(8), mkfs.ext2(8), mkfs.ext3(8), mkfs.ext4(8), mkfs.minix(8), mkfs.msdos(8), mkfs.vfat(8), mkfs.xfs(8)
The mkfs command is part of the util-linux package which can be downloaded from Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/>.
CHSH(1)                           User Commands                          CHSH(1)
chsh - change your login shell
chsh [-s shell] [-l] [-h] [-v] [username]
chsh is used to change your login shell. If a shell is not given on the command line, chsh prompts for one.
chsh supports non-local entries (kerberos, LDAP, etc.) if linked with libuser, otherwise use ypchsh(1), lchsh(1) or any other implementation for non-local entries.
-s, --shell shell Specify your login shell.
-l, --list-shells Print the list of shells listed in /etc/shells and exit.
-v, --version Display version information and exit.
chsh will accept the full pathname of any executable file on the system.
The default behavior for non-root users is to accept only shells listed in the /etc/shells file, and issue a warning for root user. It can also be configured at compile-time to only issue a warning for all users.
Returns 0 if operation was successful, 1 if operation failed or command syntax was not valid.
Salvatore Valente <svalente@mit.edu>
login(1), login.defs(5), passwd(5), shells(5)
The chsh command is part of the util-linux package which can be downloaded from Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/>.
EBOOK-CONVERT(1)                     calibre                    EBOOK-CONVERT(1)
ebook-convert - ebook-convert
ebook-convert input_file output_file [options]
Convert an e-book from one format to another.
input_file is the input and output_file is the output. Both must be specified as the first two arguments to the command.
The output e-book format is guessed from the file extension of output_file. output_file can also be of the special format .EXT where EXT is the output file extension. In this case, the name of the output file is derived from the name of the input file. Note that the filenames must not start with a hyphen. Finally, if output_file has no extension, then it is treated as a folder and an "open e-book" (OEB) consisting of HTML files is written to that folder. These files are the files that would normally have been passed to the output plugin.
After specifying the input and output file you can customize the conversion by specifying various options. The available options depend on the input and output file types. To get help on them specify the input and output file and then use the -h option.
For full documentation of the conversion system see conversion
Whenever you pass arguments to ebook-convert that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"
The options and default values for the options change depending on both the input and output formats, so you should always check with:
ebook-convert myfile.input_format myfile.output_format -h
Below are the options that are common to all conversion, followed by the options specific to every input and output format.
• Look and Feel
• Heuristic Processing
• Search and Replace
• Structure Detection
• Table of Contents
• Metadata
• Debug
• AZW4 Input Options
• CHM Input Options
• Comic Input Options
• DJVU Input Options
• DOCX Input Options
• EPUB Input Options
• FB2 Input Options
• HTLZ Input Options
• HTML Input Options
• LIT Input Options
• LRF Input Options
• MOBI Input Options
• ODT Input Options
• PDB Input Options
• PDF Input Options
• PML Input Options
• RB Input Options
• RTF Input Options
• Recipe Input Options
• SNB Input Options
• TCR Input Options
• TXT Input Options
• AZW3 Output Options
• DOCX Output Options
• EPUB Output Options
• FB2 Output Options
• HTML Output Options
• HTMLZ Output Options
• LIT Output Options
• LRF Output Options
• MOBI Output Options
• OEB Output Options
• PDB Output Options
• PDF Output Options
• PML Output Options
• RB Output Options
• RTF Output Options
• SNB Output Options
• TCR Output Options
• TXT Output Options
• TXTZ Output Options
--help, -h show this help message and exit
--input-profile Specify the input profile. The input profile gives the conversion system information on how to interpret various information in the input document. For example resolution dependent lengths (i.e. lengths in pixels). Choices are: cybookg3, cybook_opus, default, hanlinv3, hanlinv5, illiad, irexdr1000, irexdr800, kindle, msreader, mobipocket, nook, sony, sony300, sony900
--list-recipes List builtin recipe names. You can create an e-book from a builtin recipe like this: ebook-convert "Recipe Name.recipe" output.epub
--output-profile Specify the output profile. The output profile tells the conversion system how to optimize the created document for the specified device (such as by resizing images for the device screen size). In some cases, an output profile can be used to optimize the output for a particular device, but this is rarely necessary. Choices are:cybookg3, cybook_opus, default, generic_eink, generic_eink_hd, generic_eink_large, hanlinv3, hanlinv5, illiad, ipad, ipad3, irexdr1000, irexdr800, jetbook5, kindle, kindle_dx, kindle_fire, kindle_oasis, kindle_pw, kindle_pw3, kindle_voyage, kobo, msreader, mobipocket, nook, nook_color, nook_hd_plus, pocketbook_inkpad3, pocketbook_lux, pocketbook_hd, pocketbook_900, pocketbook_pro_912, galaxy, sony, sony300, sony900, sony-landscape, sonyt3, tablet
--version show program's version number and exit
Options to control the look and feel of the output
--asciiize Transliterate Unicode characters to an ASCII representation. Use with care because this will replace Unicode characters with ASCII. For instance it will replace "Pelé" with "Pele". Also, note that in cases where there are multiple representations of a character (characters shared by Chinese and Japanese for instance) the representation based on the current calibre interface language will be used.
--base-font-size The base font size in pts. All font sizes in the produced book will be rescaled based on this size. By choosing a larger size you can make the fonts in the output bigger and vice versa. By default, when the value is zero, the base font size is chosen based on the output profile you chose.
--change-justification Change text justification. A value of "left" converts all justified text in the source to left aligned (i.e. unjustified) text. A value of "justify" converts all unjustified text to justified. A value of "original" (the default) does not change justification in the source file. Note that only some output formats support justification.
--disable-font-rescaling Disable all rescaling of font sizes.
--embed-all-fonts Embed every font that is referenced in the input document but not already embedded. This will search your system for the fonts, and if found, they will be embedded. Embedding will only work if the format you are converting to supports embedded fonts, such as EPUB, AZW3, DOCX or PDF. Please ensure that you have the proper license for embedding the fonts used in this document.
--embed-font-family Embed the specified font family into the book. This specifies the "base" font used for the book. If the input document specifies its own fonts, they may override this base font. You can use the filter style information option to remove fonts from the input document. Note that font embedding only works with some output formats, principally EPUB, AZW3 and DOCX.
--expand-css By default, calibre will use the shorthand form for various CSS properties such as margin, padding, border, etc. This option will cause it to use the full expanded form instead. Note that CSS is always expanded when generating EPUB files with the output profile set to one of the Nook profiles as the Nook cannot handle shorthand CSS.
--extra-css Either the path to a CSS stylesheet or raw CSS. This CSS will be appended to the style rules from the source file, so it can be used to override those rules.
--filter-css A comma separated list of CSS properties that will be removed from all CSS style rules. This is useful if the presence of some style information prevents it from being overridden on your device. For example: font-family,color,margin-left,margin-right
--font-size-mapping Mapping from CSS font names to font sizes in pts. An example setting is 12,12,14,16,18,20,22,24. These are the mappings for the sizes xx-small to xx-large, with the final size being for huge fonts. The font rescaling algorithm uses these sizes to intelligently rescale fonts. The default is to use a mapping based on the output profile you chose.
--insert-blank-line Insert a blank line between paragraphs. Will not work if the source file does not use paragraphs (<p> or <div> tags).
--insert-blank-line-size Set the height of the inserted blank lines (in em). The height of the lines between paragraphs will be twice the value set here.
--keep-ligatures Preserve ligatures present in the input document. A ligature is a special rendering of a pair of characters like ff, fi, fl et cetera. Most readers do not have support for ligatures in their default fonts, so they are unlikely to render correctly. By default, calibre will turn a ligature into the corresponding pair of normal characters. This option will preserve them instead.
--line-height The line height in pts. Controls spacing between consecutive lines of text. Only applies to elements that do not define their own line height. In most cases, the minimum line height option is more useful. By default no line height manipulation is performed.
--linearize-tables Some badly designed documents use tables to control the layout of text on the page. When converted these documents often have text that runs off the page and other artifacts. This option will extract the content from the tables and present it in a linear fashion.
--margin-bottom Set the bottom margin in pts. Default is 5.0. Setting this to less than zero will cause no margin to be set (the margin setting in the original document will be preserved). Note: Page oriented formats such as PDF and DOCX have their own margin settings that take precedence.
--margin-left Set the left margin in pts. Default is 5.0. Setting this to less than zero will cause no margin to be set (the margin setting in the original document will be preserved). Note: Page oriented formats such as PDF and DOCX have their own margin settings that take precedence.
--margin-right Set the right margin in pts. Default is 5.0. Setting this to less than zero will cause no margin to be set (the margin setting in the original document will be preserved). Note: Page oriented formats such as PDF and DOCX have their own margin settings that take precedence.
--margin-top Set the top margin in pts. Default is 5.0. Setting this to less than zero will cause no margin to be set (the margin setting in the original document will be preserved). Note: Page oriented formats such as PDF and DOCX have their own margin settings that take precedence.
--minimum-line-height The minimum line height, as a percentage of the element's calculated font size. calibre will ensure that every element has a line height of at least this setting, irrespective of what the input document specifies. Set to zero to disable. Default is 120%. Use this setting in preference to the direct line height specification, unless you know what you are doing. For example, you can achieve "double spaced" text by setting this to 240.
--remove-paragraph-spacing Remove spacing between paragraphs. Also sets an indent on paragraphs of 1.5em. Spacing removal will not work if the source file does not use paragraphs (<p> or <div> tags).
--remove-paragraph-spacing-indent-size When calibre removes blank lines between paragraphs, it automatically sets a paragraph indent, to ensure that paragraphs can be easily distinguished. This option controls the width of that indent (in em). If you set this value negative, then the indent specified in the input document is used, that is, calibre does not change the indentation.
--smarten-punctuation Convert plain quotes, dashes and ellipsis to their typographically correct equivalents. For details, see https://daringfireball.net/projects/smartypants.
--subset-embedded-fonts Subset all embedded fonts. Every embedded font is reduced to contain only the glyphs used in this document. This decreases the size of the font files. Useful if you are embedding a particularly large font with lots of unused glyphs.
--transform-css-rules Path to a file containing rules to transform the CSS styles in this book. The easiest way to create such a file is to use the wizard for creating rules in the calibre GUI. Access it in the "Look & feel->Transform styles" section of the conversion dialog. Once you create the rules, you can use the "Export" button to save them to a file.
--transform-html-rules Path to a file containing rules to transform the HTML in this book. The easiest way to create such a file is to use the wizard for creating rules in the calibre GUI. Access it in the "Look & feel->Transform HTML" section of the conversion dialog. Once you create the rules, you can use the "Export" button to save them to a file.
--unsmarten-punctuation Convert fancy quotes, dashes and ellipsis to their plain equivalents.
Modify the document text and structure using common patterns. Disabled by default. Use --enable-heuristics to enable.  Individual actions can be disabled with the --disable-* options.
--disable-dehyphenate Analyze hyphenated words throughout the document.  The document itself is used as a dictionary to determine whether hyphens should be retained or removed.
--disable-delete-blank-paragraphs Remove empty paragraphs from the document when they exist between every other paragraph
--disable-fix-indents Turn indentation created from multiple non-breaking space entities into CSS indents.
--disable-format-scene-breaks Left aligned scene break markers are center aligned. Replace soft scene breaks that use multiple blank lines with horizontal rules.
--disable-italicize-common-cases Look for common words and patterns that denote italics and italicize them.
--disable-markup-chapter-headings Detect unformatted chapter headings and sub headings. Change them to h2 and h3 tags.  This setting will not create a TOC, but can be used in conjunction with structure detection to create one.
--disable-renumber-headings Looks for occurrences of sequential <h1> or <h2> tags. The tags are renumbered to prevent splitting in the middle of chapter headings.
--disable-unwrap-lines Unwrap lines using punctuation and other formatting clues.
--enable-heuristics Enable heuristic processing. This option must be set for any heuristic processing to take place.
--html-unwrap-factor Scale used to determine the length at which a line should be unwrapped. Valid values are a decimal between 0 and 1. The default is 0.4, just below the median line length.  If only a few lines in the document require unwrapping this value should be reduced
--replace-scene-breaks Replace scene breaks with the specified text. By default, the text from the input document is used.
Modify the document text and structure using user defined patterns.
--search-replace Path to a file containing search and replace regular expressions. The file must contain alternating lines of regular expression followed by replacement pattern (which can be an empty line). The regular expression must be in the Python regex syntax and the file must be UTF-8 encoded.
--sr1-replace Replacement to replace the text found with sr1-search.
--sr1-search Search pattern (regular expression) to be replaced with sr1-replace.
--sr2-replace Replacement to replace the text found with sr2-search.
--sr2-search Search pattern (regular expression) to be replaced with sr2-replace.
--sr3-replace Replacement to replace the text found with sr3-search.
--sr3-search Search pattern (regular expression) to be replaced with sr3-replace.
Control auto-detection of document structure.
--chapter An XPath expression to detect chapter titles. The default is to consider <h1> or <h2> tags that contain the words "chapter", "book", "section", "prologue", "epilogue" or "part" as chapter titles as well as any tags that have class="chapter". The expression used must evaluate to a list of elements. To disable chapter detection, use the expression "/". See the XPath Tutorial in the calibre User Manual for further help on using this feature.
--chapter-mark Specify how to mark detected chapters. A value of "pagebreak" will insert page breaks before chapters. A value of "rule" will insert a line before chapters. A value of "none" will disable chapter marking and a value of "both" will use both page breaks and lines to mark chapters.
--disable-remove-fake-margins Some documents specify page margins by specifying a left and right margin on each individual paragraph. calibre will try to detect and remove these margins. Sometimes, this can cause the removal of margins that should not have been removed. In this case you can disable the removal.
--insert-metadata Insert the book metadata at the start of the book. This is useful if your e-book reader does not support displaying/searching metadata directly.
--page-breaks-before An XPath expression. Page breaks are inserted before the specified elements. To disable use the expression: /
--prefer-metadata-cover Use the cover detected from the source file in preference to the specified cover.
--remove-first-image Remove the first image from the input e-book. Useful if the input document has a cover image that is not identified as a cover. In this case, if you set a cover in calibre, the output document will end up with two cover images if you do not specify this option.
--start-reading-at An XPath expression to detect the location in the document at which to start reading. Some e-book reading programs (most prominently the Kindle) use this location as the position at which to open the book. See the XPath tutorial in the calibre User Manual for further help using this feature.
Control the automatic generation of a Table of Contents. By default, if the source file has a Table of Contents, it will be used in preference to the automatically generated one.
--duplicate-links-in-toc When creating a TOC from links in the input document, allow duplicate entries, i.e. allow more than one entry with the same text, provided that they point to a different location.
--level1-toc XPath expression that specifies all tags that should be added to the Table of Contents at level one. If this is specified, it takes precedence over other forms of auto-detection. See the XPath Tutorial in the calibre User Manual for examples.
--level2-toc XPath expression that specifies all tags that should be added to the Table of Contents at level two. Each entry is added under the previous level one entry. See the XPath Tutorial in the calibre User Manual for examples.
--level3-toc XPath expression that specifies all tags that should be added to the Table of Contents at level three. Each entry is added under the previous level two entry. See the XPath Tutorial in the calibre User Manual for examples.
--max-toc-links Maximum number of links to insert into the TOC. Set to 0 to disable. Default is: 50. Links are only added to the TOC if less than the threshold number of chapters were detected.
--no-chapters-in-toc Don't add auto-detected chapters to the Table of Contents.
--toc-filter Remove entries from the Table of Contents whose titles match the specified regular expression. Matching entries and all their children are removed.
--toc-threshold If fewer than this number of chapters is detected, then links are added to the Table of Contents. Default: 6
--use-auto-toc Normally, if the source file already has a Table of Contents, it is used in preference to the auto-generated one. With this option, the auto-generated one is always used.
Options to set metadata in the output
--author-sort String to be used when sorting by author.
--authors Set the authors. Multiple authors should be separated by ampersands.
--book-producer Set the book producer.
--comments Set the e-book description.
--cover Set the cover to the specified file or URL
--isbn Set the ISBN of the book.
--language Set the language.
--pubdate Set the publication date (assumed to be in the local timezone, unless the timezone is explicitly specified)
--publisher Set the e-book publisher.
--rating Set the rating. Should be a number between 1 and 5.
--read-metadata-from-opf, --from-opf, -m Read metadata from the specified OPF file. Metadata read from this file will override any metadata in the source file.
--series Set the series this e-book belongs to.
--series-index Set the index of the book in this series.
--tags Set the tags for the book. Should be a comma separated list.
--timestamp Set the book timestamp (no longer used anywhere)
--title Set the title.
--title-sort The version of the title to be used for sorting.
Options to help with debugging the conversion
--debug-pipeline, -d Save the output from different stages of the conversion pipeline to the specified folder. Useful if you are unsure at which stage of the conversion process a bug is occurring.
--verbose, -v Level of verbosity. Specify multiple times for greater verbosity. Specifying it twice will result in full verbosity, once medium verbosity and zero times least verbosity.
AZW4 INPUT OPTIONS --input-encoding Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
--input-encoding Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
--colors Reduce the number of colors used in the image. This works only if you choose the PNG output format. It is useful to reduce file sizes. Set to zero to turn off. Maximum value is 256. It is off by default.
--comic-image-size Specify the image size as widthxheight pixels. Normally, an image size is automatically calculated from the output profile, this option overrides it.
--despeckle Enable Despeckle. Reduces speckle noise. May greatly increase processing time.
--disable-trim Disable trimming of comic pages. For some comics, trimming might remove content as well as borders.
--dont-add-comic-pages-to-toc When converting a CBC do not add links to each page to the TOC. Note this only applies if the TOC has more than one section
--dont-grayscale Do not convert the image to grayscale (black and white)
--dont-normalize Disable normalize (improve contrast) color range for pictures. Default: False
--dont-sharpen Disable sharpening.
--keep-aspect-ratio Maintain picture aspect ratio. Default is to fill the screen.
--landscape Don't split landscape images into two portrait images
--no-process Apply no processing to the image
--no-sort Don't sort the files found in the comic alphabetically by name. Instead use the order they were added to the comic.
--output-format The format that images in the created e-book are converted to. You can experiment to see which format gives you optimal size and look on your device.
--right2left Used for right-to-left publications like manga. Causes landscape pages to be split into portrait pages from right to left.
--wide Keep aspect ratio and scale image using screen height as image width for viewing in landscape mode.
--docx-inline-subsup Render superscripts and subscripts so that they do not affect the line height.
--docx-no-cover Normally, if a large image is present at the start of the document that looks like a cover, it will be removed from the document and used as the cover for created e-book. This option turns off that behavior.
--docx-no-pagebreaks-between-notes Do not insert a page break after every endnote.
FB2 INPUT OPTIONS --input-encoding Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
--no-inline-fb2-toc Do not insert a Table of Contents at the beginning of the book.
--breadth-first Traverse links in HTML files breadth first. Normally, they are traversed depth first.
--dont-package Normally this input plugin re-arranges all the input files into a standard folder hierarchy. Only use this option if you know what you are doing as it can result in various nasty side effects in the rest of the conversion pipeline.
--max-levels Maximum levels of recursion when following links in HTML files. Must be non-negative. 0 implies that no links in the root HTML file are followed. Default is 5.
--new-pdf-engine Use the new PDF conversion engine. Currently not operational.
--no-images Do not extract images from the document
--unwrap-factor Scale used to determine the length at which a line should be unwrapped. Valid values are a decimal between 0 and 1. The default is 0.45, just below the median line length.
--ignore-wmf Ignore WMF images instead of replacing them with a placeholder image.
--dont-download-recipe Do not download latest version of builtin recipes from the calibre server
--lrf  Optimize fetching for subsequent conversion to LRF.
--password Password for sites that require a login to access content.
--test Useful for recipe development. Forces max_articles_per_feed to 2 and downloads at most 2 feeds. You can change the number of feeds and articles by supplying optional arguments. For example: --test 3 1 will download at most 3 feeds and only 1 article per feed.
--username Username for sites that require a login to access content.
--formatting-type Formatting used within the document. * auto: Automatically decide which formatting processor to use * plain: No formatting * heuristic: Use heuristics to determine chapter headings, italics, etc. * textile: Use the TexTile markup language * markdown: Use the Markdown markup language To learn more about markdown see https://daringfireball.net/projects/markdown/
--markdown-extensions Enable extensions to markdown syntax. Extensions are formatting that is not part of the standard markdown format. The extensions enabled by default: footnotes, tables, toc. To learn more about markdown extensions, see https://python-markdown.github.io/extensions/ This should be a comma separated list of extensions to enable: * abbr: Abbreviations * admonition: Support admonitions * attr_list: Add attribute to HTML tags * codehilite: Add code highlighting via Pygments * def_list: Definition lists * extra: Enables various common extensions * fenced_code: Alternative code block syntax * footnotes: Footnotes * legacy_attrs: Use legacy element attributes * legacy_em: Use legacy underscore handling for connected words * meta: Metadata in the document * nl2br: Treat newlines as hard breaks * sane_lists: Do not allow mixing list types * smarty: Use markdown's internal smartypants parser * tables: Support tables * toc: Generate a table of contents * wikilinks: Wiki style links
--paragraph-type Paragraph structure to assume. The value of "off" is useful for formatted documents such as Markdown or Textile. Choices are: * auto: Try to auto detect paragraph type * block: Treat a blank line as a paragraph break * single: Assume every line is a paragraph * print:  Assume every line starting with 2+ spaces or a tab starts a paragraph * unformatted: Most lines have hard line breaks, few/no blank lines or indents * off: Don't modify the paragraph structure
--preserve-spaces Normally extra spaces are condensed into a single space. With this option all spaces will be displayed.
--txt-in-remove-indents Normally extra space at the beginning of lines is retained. With this option they will be removed.
AZW3 OUTPUT OPTIONS --dont-compress Disable compression of the file contents.
--extract-to Extract the contents of the generated AZW3 file to the specified folder. The contents of the folder are first deleted, so be careful.
--mobi-toc-at-start When adding the Table of Contents to the book, add it at the start of the book instead of the end. Not recommended.
--no-inline-toc Don't add Table of Contents to the book. Useful if the book has its own table of contents.
--prefer-author-sort When present, use author sort field as author.
--pretty-print If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
--share-not-sync Enable sharing of book content via Facebook etc.  on the Kindle. WARNING: Using this feature means that  the book will not auto sync its last read position  on multiple devices. Complain to Amazon.
--toc-title Title for any generated in-line table of contents.
--docx-custom-page-size Custom size of the document. Use the form widthxheight EG. 123x321 to specify the width and height (in pts). This overrides any specified page-size.
--docx-no-cover Do not insert the book cover as an image at the start of the document. If you use this option, the book cover will be discarded.
--docx-no-toc Do not insert the table of contents as a page at the start of the document.
--docx-page-margin-bottom The size of the bottom page margin, in pts. Default is 72pt. Overrides the common bottom page margin setting, unless set to zero.
--docx-page-margin-left The size of the left page margin, in pts. Default is 72pt. Overrides the common left page margin setting.
--docx-page-margin-right The size of the right page margin, in pts. Default is 72pt. Overrides the common right page margin setting, unless set to zero.
--docx-page-margin-top The size of the top page margin, in pts. Default is 72pt. Overrides the common top page margin setting, unless set to zero.
--docx-page-size The size of the page. Default is letter. Choices are ['a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6', 'b0', 'b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'legal', 'letter']
--extract-to Extract the contents of the generated DOCX file to the specified folder. The contents of the folder are first deleted, so be careful.
--preserve-cover-aspect-ratio Preserve the aspect ratio of the cover image instead of stretching it out to cover the entire page.
--dont-split-on-page-breaks Turn off splitting at page breaks. Normally, input files are automatically split at every page break into two files. This gives an output e-book that can be parsed faster and with less resources. However, splitting is slow and if your source file contains a very large number of page breaks, you should turn off splitting on page breaks.
--epub-flatten This option is needed only if you intend to use the EPUB with FBReaderJ. It will flatten the file system inside the EPUB, putting all files into the top level.
--epub-inline-toc Insert an inline Table of Contents that will appear as part of the main book content.
--epub-toc-at-end Put the inserted inline Table of Contents at the end of the book instead of the start.
--epub-version The version of the EPUB file to generate. EPUB 2 is the most widely compatible, only use EPUB 3 if you know you actually need it.
--extract-to Extract the contents of the generated EPUB file to the specified folder. The contents of the folder are first deleted, so be careful.
--flow-size Split all HTML files larger than this size (in KB). This is necessary as most EPUB readers cannot handle large file sizes. The default of 260KB is the size required for Adobe Digital Editions. Set to 0 to disable size based splitting.
--no-default-epub-cover Normally, if the input file has no cover and you don't specify one, a default cover is generated with the title, authors, etc. This option disables the generation of this cover.
--no-svg-cover Do not use SVG for the book cover. Use this option if your EPUB is going to be used on a device that does not support SVG, like the iPhone or the JetBook Lite. Without this option, such devices will display the cover as a blank page.
--preserve-cover-aspect-ratio When using an SVG cover, this option will cause the cover to scale to cover the available screen area, but still preserve its aspect ratio (ratio of width to height). That means there may be white borders at the sides or top and bottom of the image, but the image will never be distorted. Without this option the image may be slightly distorted, but there will be no borders.