mirror of
https://github.com/NikitaIvanovV/ctpv.git
synced 2024-12-01 00:43:08 +01:00
109 lines
2.4 KiB
Markdown
109 lines
2.4 KiB
Markdown
# ctpv
|
|
|
|
Terminal previewer
|
|
|
|
|
|
|
|
----
|
|
|
|
ctpv is a previewer utility for terminals.
|
|
|
|
It supports previews for source code, archives, PDF files, images
|
|
and videos (see [Previews](#previews)).
|
|
|
|
Image previews are powered by one of these:
|
|
|
|
* [Überzug](https://github.com/seebye/ueberzug)
|
|
* [Kitty terminal](https://github.com/kovidgoyal/kitty)
|
|
* [Chafa](https://github.com/hpjansson/chafa)
|
|
|
|
ctpv is a remake of an awesome program named
|
|
[stpv](https://github.com/Naheel-Azawy/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](https://github.com/gokcehan/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.
|
|
|
|
<!-- This table is auto generated! -->
|
|
<!--TABLESTART-->
|
|
| File types | Programs |
|
|
| ---- | ---- |
|
|
| any | `exiftool` `cat` |
|
|
| archive | `atool` |
|
|
| diff | `colordiff` `delta` `diff-so-fancy` |
|
|
| directory | `ls` |
|
|
| html | `elinks` `lynx` `w3m` |
|
|
| image | `ueberzug` `chafa` |
|
|
| json | `jq` |
|
|
| markdown | `mdcat` |
|
|
| odt | `libreoffice` |
|
|
| pdf | `pdftoppm` |
|
|
| text | `bat` `cat` `highlight` `source-highlight` |
|
|
| torrent | `transmission-show` |
|
|
| video | `ffmpegthumbnailer` |
|
|
|
|
<!--TABLEEND-->
|
|
|
|
## Installation
|
|
|
|
### Manual
|
|
|
|
```sh
|
|
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`](https://aur.archlinux.org/packages/ctpv-git) AUR package.
|
|
|
|
```sh
|
|
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
|
|
cmd on-quit $ctpv -e $id
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Full documentation on command line options,
|
|
configuration and how to define custom previews
|
|
can be found here: https://nikitaivanovv.github.io/ctpv/
|