diff options
| author | Wojciech Siewierski <wojciech.siewierski@onet.pl> | 2019-08-05 23:13:05 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-08-05 23:13:05 +0200 |
| commit | 8bf92113d4fc7f40e1861a7e65114da0ce3d599a (patch) | |
| tree | c4b9a815e9811146d12cf529d8b6cde5cb97b121 | |
| parent | 3ffc3a8583bb2525249eb321645d42b910161501 (diff) | |
| parent | 977254aafa784bc855510dca81f80f5d148da666 (diff) | |
Merge pull request #1657 from toonn/readme-dependencies
Improve the Dependencies section of the README
| -rw-r--r-- | README.md | 32 |
1 files changed, 21 insertions, 11 deletions
@@ -73,26 +73,36 @@ Dependencies and (optionally) wide-unicode support * A pager (`less` by default) -Optional: +### Optional dependencies -* The `file` program for determining file types -* The Python module `chardet`, in case of encoding detection problems +For general usage: + +* `file` for determining file types +* `chardet` (Python package) for improved encoding detection of text files * `sudo` to use the "run as root" feature -* `w3m` for the `w3mimgdisplay` program to preview images -* `python-bidi` for correct display of RTL file names (Hebrew, Arabic) +* `python-bidi` to display right-to-left file names correctly (Hebrew, Arabic) -Optional, for enhanced file previews (with `scope.sh`): +For enhanced file previews (with `scope.sh`): * `img2txt` (from `caca-utils`) for ASCII-art image previews +* `w3mimgdisplay`, `ueberzug`, `kitty`, `terminology` or `urxvt` for image + previews +* `convert` (from `imagemagick`) to auto-rotate images and for SVG previews +* `ffmpegthumbnailer` for video thumbnails * `highlight` or `pygmentize` for syntax highlighting of code -* `atool`, `bsdtar` and/or `unrar` for previews of archives -* `lynx`, `w3m` or `elinks` for previews of html pages -* `pdftotext` or `mutool` for `pdf` previews +* `atool`, `bsdtar`, `unrar` and/or `7z` to preview archives +* `bsdtar`, `tar`, `unrar` and/or `unzip` to preview archives as their first + image +* `lynx`, `w3m` or `elinks` to preview html pages +* `pdftotext` or `mutool` for textual `pdf` previews, `pdftoppm` to preview as + image +* `djvutxt` for textual DjVu previews, `ddjvu` to preview as image +* `calibre` or `epub-thumbnailer` for image previews of ebooks * `transmission-show` for viewing BitTorrent information * `mediainfo` or `exiftool` for viewing information about media files * `odt2txt` for OpenDocument text files (`odt`, `ods`, `odp` and `sxw`) -* `chardet` (Python package) for improved encoding detection of text files - +* `python` or `jq` for JSON files +* `fontimage` for font previews Installing ---------- |