[DOCS] usage: Stale CLI options help output (#1311)

* docs(quick): Stale Sphinx ref link target name

Not sure how I missed this in my local testing, but this should have been a part a
previous PR.

Refs #1304

* docs(usage): Stale CLI options help output

From [merged PR
feedback](https://github.com/jmbannon/ytdl-sub/pull/1305#discussion_r2304503286).

Refs #1305
This commit is contained in:
Ross Patterson 2025-08-29 10:08:07 -07:00 committed by GitHub
parent ccdad4d4cd
commit 746370ef9a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 7 additions and 7 deletions

View file

@ -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 <introduction:motivation>`, which is in itself a complex
tool. It performs an intricate and fragile task, web scraping, which in turn :ref:`is

View file

@ -39,7 +39,7 @@ instructions to the letter.
#. Preview what ``ytdl-sub`` would do for this subscription:
Run the :ref:`'sub' sub-command <usage:sub options>` but with the ``max_downloads``
Run the :ref:`'sub' sub-command <usage:subscriptions options>` 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::

View file

@ -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