diff --git a/docs/source/debugging.rst b/docs/source/debugging.rst index ffc271fd..d70ac51f 100644 --- a/docs/source/debugging.rst +++ b/docs/source/debugging.rst @@ -1,10 +1,8 @@ Debugging ========= -Run with the ``--log-level verbose`` CLI option to see more information in the output, -such as all ``yt-dlp`` logs. Run with ``--log-level debug`` to show all log messages, -often too much information for normal operation but useful when investigating a specific -problem. +Run with ``--log-level debug`` to show all log messages, often too much information for +normal operation but useful when investigating a specific problem. :ref:`ytdl-sub builds on yt-dlp `, which is in itself a complex tool. It performs an intricate and fragile task, web scraping, which in turn :ref:`is diff --git a/docs/source/guides/getting_started/quick_start.rst b/docs/source/guides/getting_started/quick_start.rst index 9c0402a9..5f8f4dd3 100644 --- a/docs/source/guides/getting_started/quick_start.rst +++ b/docs/source/guides/getting_started/quick_start.rst @@ -39,7 +39,7 @@ instructions to the letter. #. Preview what ``ytdl-sub`` would do for this subscription: - Run the :ref:`'sub' sub-command ` but with the ``max_downloads`` + Run the :ref:`'sub' sub-command ` but with the ``max_downloads`` setting from ``yt-dlp`` along with the ``--dry-run`` and ``--match`` options from ``ytdl-sub`` to minimize requests and prevent actual downloads. Be sure to update the ``--match="..."`` value with the subscription name:: diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 8f828858..2ed28fc2 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -19,14 +19,16 @@ example ``$ ytdl-sub --dry-run sub ...``: -h, --help show this help message and exit -v, --version show program's version number and exit -c CONFIGPATH, --config CONFIGPATH - path to the config yaml, uses ./config.yaml if not provided + path to the config yaml, uses config.yaml if not provided -d, --dry-run preview what a download would output, does not perform any video downloads or writes to output directories -l quiet|info|verbose|debug, --log-level quiet|info|verbose|debug - level of logs to print to console, defaults to info + level of logs to print to console, defaults to verbose -t TRANSACTIONPATH, --transaction-log TRANSACTIONPATH path to store the transaction log output of all files added, modified, deleted -st, --suppress-transaction-log do not output transaction logs to console or file + -nc, --suppress-colors + do not use colors in ytdl-sub output -m MATCH [MATCH ...], --match MATCH [MATCH ...] match subscription names to one or more substrings, and only run those subscriptions