mirror of https://github.com/NikitaIvanovV/ctpv.git synced 2024-11-27 23:13:07 +01:00

Image previews for lf file manager

Go to file

Nikita Ivanov 9828ba6535 Minor		2022-09-09 23:38:57 +05:00
deptable	Minor	2022-09-09 22:34:28 +05:00
doc	Minor	2022-09-09 23:38:57 +05:00
embed	Minor	2022-09-02 01:46:02 +05:00
quit	Minor	2022-08-02 22:17:56 +05:00
sh	Fix: image previews do not work in older kitty	2022-09-02 22:06:19 +05:00
src	Fix: disallow negative width	2022-09-02 01:47:18 +05:00
.gitignore	Minor: add quit/ctpvquit to .gitignore	2022-08-02 17:52:44 +05:00
ctpvclear	ctpvclear: add option to pass id as argument	2022-05-29 21:40:11 +05:00
LICENSE	Initial commit	2022-05-22 12:56:26 +05:00
Makefile	Minor: add more variables to customize utils	2022-09-03 01:40:48 +05:00
previews.h	Add support for presentation files	2022-07-31 17:13:13 +05:00
README.md	Use ctpvquit instead of cmd on-quit	2022-08-02 03:04:51 +05:00
version.h	Add version	2022-07-26 00:38:46 +05:00

README.md

ctpv

Terminal previewer

ctpv is a previewer utility for terminals.

It supports previews for source code, archives, PDF files, images and videos (see Previews).

Image previews are powered by one of these:

ctpv is a remake of an awesome program named stpv written in C. stpv worked perfectly for me, except it was kinda sluggish because it was written in POSIX shell. ctpv is an attempt to make a faster version of stpv and add some new features.

Originally it was made for lf file manager but I believe that it can be easily integrated into other programs as well (either via configuration file like in lf or a simple wrapper script).

Dependencies

Libraries

libcrypto
libmagic

Previews

Previewing each file type requires specific programs. If a program is not found on the system, ctpv will try to use another one. Only one program is required for each file type. For example, you only need either elinks, lynx or w3m installed on your system to view HTML files.

File types	Programs
any	`exiftool` `cat`
archive	`atool`
diff	`colordiff` `delta` `diff-so-fancy`
directory	`ls`
font	`fontimage`
gpg-encrypted	`gpg`
html	`elinks` `lynx` `w3m`
image	`ueberzug` `chafa`
json	`jq`
markdown	`mdcat`
office	`libreoffice`
pdf	`pdftoppm`
text	`bat` `cat` `highlight` `source-highlight`
torrent	`transmission-show`
video	`ffmpegthumbnailer`

Installation

Manual

git clone https://github.com/NikitaIvanovV/ctpv
cd ctpv
sudo make install

Uninstall with sudo make uninstall

AUR

If you are an Arch Linux user, you can install ctpv-git AUR package.

yay -S ctpv-git

Integration

lf file manager

Add these lines to your lf config (usually located at ~/.config/lf/lfrc).

set previewer ctpv
set cleaner ctpvclear
&ctpv -s $id
&ctpvquit $id

Documentation

Full documentation on command line options, configuration and how to define custom previews can be found here: https://nikitaivanovv.github.io/ctpv/