extern/ctpv
1
0
Fork 0
mirror of https://github.com/NikitaIvanovV/ctpv.git synced 2025-02-21 12:51:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: add info about ~/.cache/ctpv dir

Browse Source
This commit is contained in:
Nikita Ivanov 2022-07-27 17:57:45 +05:00
parent 972efd368c
commit a649d23ff8
No known key found for this signature in database
GPG Key ID: 6E656AC5B97B5133
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/ctpv.1
View File

@ -1,6 +1,6 @@
'\" t '\" t
.ds op \&.\|.\|.\& .ds op \&.\|.\|.\&
.ds ue \(:Uberzug .ds ub \(:Uberzug
. .
.de Op .de Op
.RI [ "\\$1" "]\\$2" .RI [ "\\$1" "]\\$2"
@ -14,14 +14,11 @@
\&\fB\\$1\fP \fI\\$2\fP\\$3 \&\fB\\$1\fP \fI\\$2\fP\\$3
.. ..
. .
.
.TH CTPV 1 "July 2022" Linux "User Manuals" .TH CTPV 1 "July 2022" Linux "User Manuals"
. .
.
.SH NAME .SH NAME
ctpv \- terminal previewer ctpv \- terminal previewer
. .
.
.SH SYNOPSIS .SH SYNOPSIS
. .
.SY ctpv .SY ctpv
@ -47,7 +44,6 @@ ctpv \- terminal previewer
.I id .I id
.YS .YS
. .
.
.SH DESCRIPTION .SH DESCRIPTION
. .
.B ctpv .B ctpv
@ -153,7 +149,7 @@ cmd on-quit $ctpv -e $id
.SS Image previews .SS Image previews
. .
Image previews are enabled by either installing Image previews are enabled by either installing
.I \*(ue .I \*(ub
or or
.I Chafa .I Chafa
(as seen in (as seen in
@ -166,7 +162,7 @@ terminal.
When possible, When possible,
.B ctpv .B ctpv
will prefer will prefer
.I \*(ue .I \*(ub
over others image preview methods. You can override this over others image preview methods. You can override this
behavior by using behavior by using
.B forcekitty .B forcekitty
@ -209,7 +205,6 @@ attempts to run another appropriate preview and so on.
If the script exists with 0 or a any other status, both standard output If the script exists with 0 or a any other status, both standard output
and standard error are printed. and standard error are printed.
. .
.
.SH OPTIONS .SH OPTIONS
. .
.TP .TP
@ -238,7 +233,6 @@ command to server with ID
Kill server with ID Kill server with ID
.IR id . .IR id .
. .
.
.SH CONFIGURATION .SH CONFIGURATION
. .
.B ctpv .B ctpv
@ -455,17 +449,28 @@ to use it for generating previews.
. .
.TP .TP
.I $XDG_CONFIG_HOME/ctpv/config .I $XDG_CONFIG_HOME/ctpv/config
Configuration file. If Configuration file.
If
.I $XDG_CONFIG_HOME .I $XDG_CONFIG_HOME
is not set, defaults to is not set, defaults to
.IR \(ti/.config . .IR \(ti/.config .
. .
.TP
.I $XDG_CACHE_HOME/ctpv
Directory to store cached image previews.
It takes some time to generate an image preview for some file types,
such as videos or PDF files, this is why the generated images are
stored in the directory to be shown if the same file is previewed
again.
If
.I $XDG_CACHE_HOME
is not set, defaults to
.IR \(ti/.cache .
. .
.SH SEE ALSO .SH SEE ALSO
. .
.BR lf (1) .BR lf (1)
. .
.
.SH AUTHOR .SH AUTHOR
. .
Written by Nikita Ivanov. Written by Nikita Ivanov.