b3eab414dd
this should've been added ages ago back when `nsxiv` was first released. but even now, there's still plently of people who might be looking to migrate. so add a simple MIGRATION.md which covers some of the differences to be aware of when migrating. this does not cover patches and `config.h` since any conflicts in patches would be evident anyways. ref: https://codeberg.org/nsxiv/nsxiv/issues/369 ref: https://codeberg.org/nsxiv/nsxiv/issues/506 ref: https://codeberg.org/nsxiv/nsxiv/issues/420 Reviewed-on: https://codeberg.org/nsxiv/nsxiv/pulls/507 Reviewed-by: eylles <eylles@noreply.codeberg.org>
225 lines
7.9 KiB
Markdown
225 lines
7.9 KiB
Markdown
[](https://codeberg.org/nsxiv/nsxiv)
|
|
|
|
[](https://codeberg.org/nsxiv/nsxiv)
|
|
[](https://codeberg.org/nsxiv/nsxiv/tags)
|
|
[](https://codeberg.org/nsxiv/nsxiv/src/branch/master/LICENSE)
|
|
[](https://codeberg.org/nsxiv/nsxiv)
|
|
|
|
**Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer**
|
|
--------------------------------------------------------------------
|
|
|
|
nsxiv is a fork of the now-unmaintained [sxiv](https://github.com/xyb3rt/sxiv)
|
|
with the purpose of being a (mostly) drop-in replacement for sxiv, maintaining its
|
|
interface and adding simple, sensible features. nsxiv is free software licensed
|
|
under GPL-2.0-or-later and aims to be easy to modify and customize.
|
|
|
|
Please file a bug report if something does not work as documented or expected on
|
|
[Codeberg] after making sure you are using the latest release. If you're looking
|
|
to migrate from `sxiv`, see [MIGRATION]. Contributions are welcome, see
|
|
[CONTRIBUTING] to get started.
|
|
|
|
[Codeberg]: https://codeberg.org/nsxiv/nsxiv/issues/new
|
|
[CONTRIBUTING]: etc/CONTRIBUTING.md#contribution-guideline
|
|
[MIGRATION]: etc/MIGRATION.md
|
|
|
|
|
|
Features
|
|
--------
|
|
|
|
* Basic image operations like zooming, panning, rotating
|
|
* Basic support for animated/multi-frame images (**requires Imlib2 v1.8.0 or above**)
|
|
* Thumbnail mode: grid of selectable previews of all images
|
|
* Ability to cache thumbnails for fast re-loading
|
|
* Automatically refreshing modified images
|
|
* Customizable keyboard and mouse mappings via `config.h`
|
|
* Scriptability via `key-handler`
|
|
* Displaying image information in status bar via `image-info` & `thumb-info`
|
|
* Customizable window title via `win-title`
|
|
|
|
|
|
Screenshots
|
|
-----------
|
|
|
|
**Image mode with default colors:**
|
|
|
|
|
|
|
|
**Thumbnail mode with custom colors:**
|
|
|
|
|
|
|
|
|
|
Installing via package manager
|
|
------------------------------
|
|
|
|
<a href="https://repology.org/project/nsxiv/versions">
|
|
<img align="right" width="192" src="https://repology.org/badge/vertical-allrepos/nsxiv.svg">
|
|
</a>
|
|
|
|
nsxiv is available on the following distributions/repositories. If you don't see
|
|
your distro listed here, either contact your distro's package maintainer or
|
|
consider packaging it yourself and adding it to the respective community repo.
|
|
|
|
|
|
Dependencies
|
|
------------
|
|
|
|
nsxiv requires the following software to be installed:
|
|
|
|
* X11
|
|
* Imlib2 (built with X11 support)
|
|
|
|
The following dependencies are optional:
|
|
|
|
* `inotify`<sup>\*</sup>: Used for auto-reloading images on change.
|
|
Disabled via `HAVE_INOTIFY=0`.
|
|
* `libXft`, `freetype2`, `fontconfig`: Used for the status bar.
|
|
Disabled via `HAVE_LIBFONTS=0`.
|
|
* `libexif`: Used for auto-orientation and exif thumbnails.
|
|
Disable via `HAVE_LIBEXIF=0`.
|
|
|
|
Please make sure to install the corresponding development packages in case that
|
|
you want to build nsxiv on a distribution with separate runtime and development
|
|
packages (e.g. \*-dev on Debian).
|
|
|
|
\* [inotify][] is a Linux-specific API for monitoring filesystem changes.
|
|
It's not natively available on `*BSD` systems but can be enabled via
|
|
installing and linking against [libinotify-kqueue][].
|
|
|
|
[inotify]: https://www.man7.org/linux/man-pages/man7/inotify.7.html
|
|
[libinotify-kqueue]: https://github.com/libinotify-kqueue/libinotify-kqueue
|
|
|
|
|
|
Building
|
|
--------
|
|
|
|
nsxiv is built using the commands:
|
|
|
|
$ make
|
|
|
|
You can pass `HAVE_X=0` to `make` to disable an optional dependency.
|
|
For example:
|
|
|
|
$ make HAVE_LIBEXIF=0
|
|
|
|
will disable `libexif` support. Alternatively they can be disabled via editing
|
|
`config.mk`. `OPT_DEP_DEFAULT=0` can be used to disable all optional
|
|
dependencies.
|
|
|
|
Installing nsxiv:
|
|
|
|
# make install
|
|
|
|
Installing desktop entry:
|
|
|
|
# make install-desktop
|
|
|
|
Installing icons:
|
|
|
|
# make install-icon
|
|
|
|
Installing all of the above:
|
|
|
|
# make install-all
|
|
|
|
Please note, that these requires root privileges.
|
|
By default, nsxiv is installed using the prefix `/usr/local`, so the full path
|
|
of the executable will be `/usr/local/bin/nsxiv`, the `.desktop` entry will be
|
|
`/usr/local/share/applications/nsxiv.desktop` and the icon path will be
|
|
`/usr/local/share/icons/hicolor/{size}/apps/nsxiv.png`.
|
|
|
|
You can install nsxiv into a directory of your choice by changing this command to:
|
|
|
|
$ make PREFIX="/your/dir" install
|
|
|
|
Example scripts are installed using `EGPREFIX` which defaults to
|
|
`/usr/local/share/doc/nsxiv/examples`. You can change `EGPREFIX` the same way
|
|
you can change `PREFIX` shown above.
|
|
|
|
The build-time specific settings of nsxiv can be found in the file *config.h*.
|
|
Please check and change them, so that they fit your needs.
|
|
If the file *config.h* does not already exist, then you have to create it with
|
|
the following command:
|
|
|
|
$ make config.h
|
|
|
|
|
|
Usage
|
|
-----
|
|
|
|
Refer to the man-page for the documentation:
|
|
|
|
$ man nsxiv
|
|
|
|
You may also view the man-page [online](https://nsxiv.codeberg.page/man/).
|
|
However, note that the online man-page might not accurately represent your local
|
|
copy.
|
|
|
|
|
|
F.A.Q.
|
|
------
|
|
|
|
* Can I open remote urls with nsxiv? <br>
|
|
Yes, see [nsxiv-url](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-url)
|
|
|
|
* Can I open all the images in a directory? <br>
|
|
Yes, see [nsxiv-rifle](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-rifle)
|
|
|
|
* Can I set default arguments for nsxiv? <br>
|
|
Yes, see [nsxiv-env](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-env)
|
|
|
|
* Can I pipe images into nsxiv? <br>
|
|
Yes, see [nsxiv-pipe](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-pipe)
|
|
|
|
You may also wish to see the [known issues](https://codeberg.org/nsxiv/nsxiv/issues/242).
|
|
|
|
|
|
Customization
|
|
-------------
|
|
|
|
The main method of customizing nsxiv is by setting values for the variables in *config.h*,
|
|
or by using Xresources as explained in the manual. If these options are not sufficient,
|
|
you may implement your own features by following
|
|
[this guide](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/CUSTOMIZATION.md).
|
|
|
|
Due to our limited [project scope](etc/CONTRIBUTING.md#project-scope), certain features or
|
|
customization cannot be merged into nsxiv mainline. Following the spirit of suckless
|
|
software, we host the [nsxiv-extra](https://codeberg.org/nsxiv/nsxiv-extra) repo where users
|
|
are free to submit whatever patches or scripts they wish.
|
|
|
|
If you think your custom features can be beneficial for the general user base and is within
|
|
our project scope, please submit it as a pull request on this repository, then we *may*
|
|
merge it to mainline.
|
|
|
|
Description on how to use or submit patches can be found on
|
|
nsxiv-extra's [README](https://codeberg.org/nsxiv/nsxiv-extra).
|
|
|
|
|
|
Download
|
|
--------
|
|
|
|
You can [browse](https://codeberg.org/nsxiv/nsxiv) the source code repository
|
|
on Codeberg or get a copy using git with the following command:
|
|
|
|
$ git clone https://codeberg.org/nsxiv/nsxiv.git
|
|
|
|
You can view the changelog [here](etc/CHANGELOG.md)
|
|
|
|
|
|
Similar projects
|
|
----------------
|
|
|
|
If nsxiv isn't able to fit your needs, check out the image viewer section of
|
|
**[suckless rocks](https://suckless.org/rocks)** to find other minimal image
|
|
viewers to try out.
|
|
|
|
Below are a couple other lesser known projects not listed in suckless rocks.
|
|
|
|
* [MAGE](https://codeberg.org/explosion-mental/mage):
|
|
A smaller/more-suckless version of sxiv.
|
|
* [div](https://codeberg.org/TAAPArthur/div):
|
|
Minimal and extensive, aimed at C devs willing to build their own features.
|
|
* [mpv-image-viewer](https://github.com/occivink/mpv-image-viewer):
|
|
Lua script to turn mpv into an image viewer. Supports thumbnails via
|
|
[mpv-gallery-view](https://github.com/occivink/mpv-gallery-view).
|