Parsed command-line options in string form (converted by main). More...

#include <mdl_cli.h>

Data Fields
const char *	cfg
	–config path.
const char *	series
	–series URL.
const char *	page_url
	positional page URL (page mode).
const char *	out
	–out dir.
const char *	cache_dir
	–cache-dir: persistent per-host cache root.
const char *	attr
	–attr.
const char *	chapters
	–chapters.
const char *	from
	–from: first chapter NUMBER to fetch (not an index).
const char *	max
	–max.
const char *	seed
	–seed.
const char *	timeout
	–timeout.
const char *	format
	–format (cbz/cbt/cbt.gz/epub/jof/rabook).
const char *	pack
	–pack DIR: package an existing folder, no network.
const char *	contact
	–contact: operator identity for the User-Agent.
const char *	max_bytes
	–max-bytes: per-response size cap.
const char *	remove_series
	–remove: series URL/slug to drop from the library.
const char *	pick
	–pick N: download the Nth discovery hit (1-based).
const char *	proxy
	–proxy URL: HTTP/HTTPS proxy URL.
const char *	socks5
	–socks5 URL: SOCKS5 proxy URL.
const char *	cookie_file
	–cookie-file FILE: host composition input path.
const char *	ca_file
	–ca-file FILE: host composition CA input path.
const char *	verify_dir
	–verify [DIR]: directory to verify.
const char *	init_site_url
	–init-site URL: generate site descriptor template.
bool	browse
	–browse: list a site's latest-updates page.
bool	separate
	–separate: one archive per chapter (default: combine).
bool	update
	–update: fetch only chapters not already complete.
bool	list
	–list: list tracked series with coverage, then exit.
bool	update_all
	–update-all: incremental update of every tracked series.
bool	polite
	–polite: raise per-host delays.
bool	ignore_robots
	–ignore-robots: escape hatch (off by default).
bool	allow_private
	–allow-private: permit loopback/private/link-local peers.
bool	cross_host
	–cross-host: permit cross-host redirects.
bool	allow_incomplete
	–allow-incomplete: package a run with failed pages.
bool	progress
	–progress: terminal progress bar during downloads.
bool	refetch
	–refetch: bypass verified local page reuse.
bool	verify
	–verify: verify existing downloaded archives/files.
bool	help
	–help/-h: print usage and exit successfully.
bool	version
	–version: print version and exit successfully.
bool	bad
	An unrecognised argument was seen.

Detailed Description

Parsed command-line options in string form (converted by main).

Every value field is a borrowed pointer into argv; the boolean fields record bare flags.

Invariant: bad is set when an unrecognised argument was seen.

See also: mdl_cli_parse()

Since: 0.1.0

Definition at line 57 of file mdl_cli.h.

Field Documentation

◆ allow_incomplete

bool mdl_args_t::allow_incomplete

–allow-incomplete: package a run with failed pages.

Definition at line 91 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), and mdl_cli_run_opts().

◆ allow_private

bool mdl_args_t::allow_private

–allow-private: permit loopback/private/link-local peers.

Definition at line 89 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), internal_validate_network_args(), and mdl_cli_run_opts().

◆ attr

const char* mdl_args_t::attr

–attr.

Definition at line 63 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), internal_prepare_args(), internal_validate_network_args(), and priv_mdl_compose_dispatch().

◆ bad

bool mdl_args_t::bad

An unrecognised argument was seen.

Definition at line 97 of file mdl_cli.h.

Referenced by internal_parse_bool_flags(), internal_parse_positional_or_bad(), internal_parse_value_opt(), internal_parse_verify_opt(), and mdl_cli_validate().

◆ browse

bool mdl_args_t::browse

–browse: list a site's latest-updates page.

Definition at line 82 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), internal_resolve_mode(), and priv_mdl_compose_dispatch().

◆ ca_file

const char* mdl_args_t::ca_file

–ca-file FILE: host composition CA input path.

Definition at line 79 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), and internal_prepare_credentials().

◆ cache_dir

const char* mdl_args_t::cache_dir

–cache-dir: persistent per-host cache root.

Definition at line 62 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), internal_resolve_cache_path(), and priv_mdl_compose_build_run().

◆ cfg

const char* mdl_args_t::cfg

–config path.

Definition at line 58 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), internal_resolve_config_path(), internal_validate_mode_fields(), priv_mdl_compose_build_run(), and priv_mdl_compose_dispatch().

◆ chapters

const char* mdl_args_t::chapters

–chapters.

Definition at line 64 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_cli_parse_num_values(), and internal_parse_value_opt().

◆ contact

const char* mdl_args_t::contact

–contact: operator identity for the User-Agent.

Definition at line 71 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), and mdl_cli_run_opts().

◆ cookie_file

const char* mdl_args_t::cookie_file

–cookie-file FILE: host composition input path.

Definition at line 78 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), and internal_prepare_credentials().

◆ cross_host

bool mdl_args_t::cross_host

–cross-host: permit cross-host redirects.

Definition at line 90 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), and mdl_cli_run_opts().

◆ format

const char* mdl_args_t::format

–format (cbz/cbt/cbt.gz/epub/jof/rabook).

Definition at line 69 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), internal_prepare_run_policy(), and internal_validate_mode_fields().

◆ from

const char* mdl_args_t::from

–from: first chapter NUMBER to fetch (not an index).

Definition at line 65 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_cli_parse_chapter_pick(), and internal_parse_value_opt().

◆ help

bool mdl_args_t::help

–help/-h: print usage and exit successfully.

Definition at line 95 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), and internal_resolve_mode().

◆ ignore_robots

bool mdl_args_t::ignore_robots

–ignore-robots: escape hatch (off by default).

Definition at line 88 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), internal_prepare_args(), and mdl_cli_run_opts().

◆ init_site_url

const char* mdl_args_t::init_site_url

–init-site URL: generate site descriptor template.

Definition at line 81 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), internal_resolve_mode(), and priv_mdl_compose_dispatch().

◆ list

bool mdl_args_t::list

–list: list tracked series with coverage, then exit.

Definition at line 85 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), and internal_resolve_mode().

◆ max

const char* mdl_args_t::max

–max.

Definition at line 66 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_cli_parse_num_values(), and internal_parse_value_opt().

◆ max_bytes

const char* mdl_args_t::max_bytes

–max-bytes: per-response size cap.

Definition at line 72 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_cli_parse_num_values(), internal_cli_validate_num_ranges(), internal_parse_value_opt(), and mdl_cli_run_opts().

◆ out

const char* mdl_args_t::out

–out dir.

Definition at line 61 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), internal_prepare_args(), internal_resolve_cache_path(), internal_resolve_descriptor_path(), internal_resolve_output_path(), internal_resolve_verify_path(), internal_validate_mode_fields(), priv_mdl_compose_build_run(), and priv_mdl_compose_dispatch().

◆ pack

const char* mdl_args_t::pack

–pack DIR: package an existing folder, no network.

Definition at line 70 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), internal_resolve_mode(), internal_resolve_pack_path(), and priv_mdl_compose_dispatch().

◆ page_url

const char* mdl_args_t::page_url

positional page URL (page mode).

Definition at line 60 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_positional_or_bad(), internal_resolve_mode(), internal_validate_mode_fields(), and priv_mdl_compose_dispatch().

◆ pick

const char* mdl_args_t::pick

–pick N: download the Nth discovery hit (1-based).

Definition at line 75 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_cli_allowed_args(), internal_cli_parse_chapter_pick(), internal_cli_validate_num_ranges(), internal_parse_value_opt(), and priv_mdl_compose_dispatch().

◆ polite

bool mdl_args_t::polite

–polite: raise per-host delays.

Definition at line 87 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), and mdl_cli_run_opts().

◆ progress

bool mdl_args_t::progress

–progress: terminal progress bar during downloads.

Definition at line 92 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), and mdl_cli_run_opts().

◆ proxy

const char* mdl_args_t::proxy

–proxy URL: HTTP/HTTPS proxy URL.

Definition at line 76 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), internal_validate_network_args(), and mdl_cli_run_opts().

◆ refetch

bool mdl_args_t::refetch

–refetch: bypass verified local page reuse.

Definition at line 93 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), and mdl_cli_run_opts().

◆ remove_series

const char* mdl_args_t::remove_series

–remove: series URL/slug to drop from the library.

Definition at line 73 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), internal_resolve_mode(), and priv_mdl_compose_dispatch().

◆ seed

const char* mdl_args_t::seed

–seed.

Definition at line 67 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_cli_parse_num_values(), and internal_parse_value_opt().

◆ separate

bool mdl_args_t::separate

–separate: one archive per chapter (default: combine).

Definition at line 83 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), and priv_mdl_compose_build_run().

◆ series

const char* mdl_args_t::series

–series URL.

Definition at line 59 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), internal_resolve_mode(), and priv_mdl_compose_build_run().

◆ socks5

const char* mdl_args_t::socks5

–socks5 URL: SOCKS5 proxy URL.

Definition at line 77 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_value_opt(), internal_validate_network_args(), and mdl_cli_run_opts().

◆ timeout

const char* mdl_args_t::timeout

–timeout.

Definition at line 68 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_cli_parse_num_values(), and internal_parse_value_opt().

◆ update

bool mdl_args_t::update

–update: fetch only chapters not already complete.

Definition at line 84 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), and priv_mdl_compose_build_run().

◆ update_all

bool mdl_args_t::update_all

–update-all: incremental update of every tracked series.

Definition at line 86 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), and internal_resolve_mode().

◆ verify

bool mdl_args_t::verify

–verify: verify existing downloaded archives/files.

Definition at line 94 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_verify_opt(), and internal_resolve_mode().

◆ verify_dir

const char* mdl_args_t::verify_dir

–verify [DIR]: directory to verify.

Definition at line 80 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_verify_opt(), internal_resolve_verify_path(), internal_validate_mode_fields(), and priv_mdl_compose_dispatch().

◆ version

bool mdl_args_t::version

–version: print version and exit successfully.

Definition at line 96 of file mdl_cli.h.

Referenced by internal_args_mask(), internal_parse_bool_flags(), and internal_resolve_mode().

The documentation for this struct was generated from the following file:

apps/host/mdl/inc/mdl_cli.h

Data Fields

Detailed Description

Field Documentation

◆ allow_incomplete

◆ allow_private

◆ attr

◆ bad

◆ browse

◆ ca_file

◆ cache_dir

◆ cfg

◆ chapters

◆ contact

◆ cookie_file

◆ cross_host

◆ format

◆ from

◆ help

◆ ignore_robots

◆ init_site_url

◆ list

◆ max

◆ max_bytes

◆ out

◆ pack

◆ page_url

◆ pick

◆ polite

◆ progress

◆ proxy

◆ refetch

◆ remove_series

◆ seed

◆ separate

◆ series

◆ socks5

◆ timeout

◆ update

◆ update_all

◆ verify

◆ verify_dir

◆ version