Skip to content

Commit

Permalink
docs: improve ytfzf(1)
Browse files Browse the repository at this point in the history
  • Loading branch information
Euro20179 committed Dec 7, 2022
1 parent 5df207c commit 260bd66
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
25 changes: 14 additions & 11 deletions docs/man/ytfzf.1
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ This can also be set in the config file with
.BR \-u ", " \-\-url\-handler=handler
The function/program to use as a url handler.
This can also be set in the config file by adding
.BR load_url_handler "<handler>" .
.BR load_url_handler " <handler>" .
.TP
.BI \-I " option"
Instead of playing the selected videos,
Expand Down Expand Up @@ -210,7 +210,7 @@ Options:
This can also be changed in the config file with
.BR fzf_preview_side .
.TP
.BR \-\-thumb\-viewer=program
.BR \-T ", " \-\-thumb\-viewer=program
Use program for displaying thumbnails.
.br
Built-in programs:
Expand Down Expand Up @@ -242,7 +242,8 @@ Uses swayimg to render an image.
Additional viewers can be put into $YTFZF_THUMBNAIL_VIEWERS_DIR.
.RE
This can also be changed in the config file by adding
.BR load_thumbnail_viewer "<viewer>" .
.br
.BR load_thumbnail_viewer " <viewer>" .
.TP
.BR \-D ", " \-\-external\-menu
Use an external menu instead of fzf.
Expand All @@ -253,7 +254,7 @@ This can also be set in the config file with
.BR \-i ", " \-\-interface=interface
Use a custom interface script, which would be in $YTFZF_CUSTOM_INTERFACES_DIR.
This can also be set in the config file by adding
.BR load_interface "<interface>" .
.BR load_interface " <interface>" .
.TP
.BR \-\-sort
Sorts videos (after scraping) by upload date.
Expand Down Expand Up @@ -541,7 +542,7 @@ The type of results to get.
.IR all
.RE
.TP
.BI \-T ", " \-\-thumbnail\-quality= quality
.BI \-\-thumbnail\-quality= quality
Select the quality of the thumbnails.
Available options:
.RS
Expand Down Expand Up @@ -686,17 +687,17 @@ See \fBytfzf\fR(5) for more information.
.PP
There are a few types of addons,
.br
.B interfaces (\-\-interface)
.B interfaces (\-i, \-\-interface)
.br
.B scrapers (\-c)
.B scrapers (\-c, \-\-scrape)
.br
.B sort-names (\-\-sort\-name)
.br
.B thumbnail-viewers (\-\-thumb\-viewer)
.B thumbnail-viewers (\-T, \-\-thumb\-viewer)
.br
.B url-handlers (\-\-url_handler)
.B url-handlers (\-u, \-\-url_handler)
.br
.B extensions (\-\-ext)
.B extensions (\-e, \-\-ext)

.PP
To install an addon, place the addon in
Expand Down Expand Up @@ -818,6 +819,8 @@ The subscriptions file.
Each instance of ytfzf has its own directory in $cache_dir.
.br
The structure of $cache_dir looks like this: (<> represents a placeholder, ? means optional)
.br
If an addon scraper is used, it may use undocumented files.
.RS
.EX
$cache_dir
Expand All @@ -831,7 +834,7 @@ $cache_dir
| | | \-\- curl_config
| | | \-\- <scrape>.html
| | | \-\- <scrape>.json
| | | \-\- <scrape>.json.final
| | | \-\- <scrape>.json.final?
| | | \-\- menu_keypress
| | | \-\- all-ids.list
| | | \-\- downloaded-ids.list
Expand Down
2 changes: 1 addition & 1 deletion ytfzf
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# versioning system:
# major.minor.bugs
YTFZF_VERSION="2.5.3.rc-3"
YTFZF_VERSION="2.5.3.rc-4"

# Scraping: query -> video json
# User Interface: video json -> user selection -> ID
Expand Down

0 comments on commit 260bd66

Please sign in to comment.