This is mainly just to reduce the amount of files in the project root. The criteria of what gets into `etc/` are the following: * The file should not be necessary for building nsxiv. This excludes the `icon/*` stuff since that's needed by `window.c`. * The file shouldn't have any valid reason to stay in the project root. This excludes things like `README.md`, `.gitignore` etc. Reviewed-on: #350 Reviewed-by: explosion-mental <firstname.lastname@example.org>
|1 day ago|
|.github/workflows||1 day ago|
|etc||1 day ago|
|icon||9 months ago|
|.editorconfig||11 months ago|
|.gitignore||9 months ago|
|LICENSE||12 years ago|
|Makefile||1 day ago|
|README.md||1 day ago|
|autoreload.c||2 weeks ago|
|commands.c||2 days ago|
|commands.h||2 months ago|
|config.def.h||2 months ago|
|config.mk||2 months ago|
|image.c||4 weeks ago|
|main.c||2 weeks ago|
|nsxiv.h||2 weeks ago|
|options.c||1 month ago|
|thumbs.c||4 weeks ago|
|utf8.h||10 months ago|
|util.c||1 month ago|
|window.c||4 weeks ago|
Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer
nsxiv is a fork of the now-unmaintained 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 GPLv2 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. Contributions are welcome, see CONTRIBUTING to get started.
- Basic image operations like zooming, panning, rotating
- Basic support for animated/multi-frame images
- 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
- Scriptability via
- Displaying image information in status bar via
- Customizable window title via
Image mode with default colors:
Thumbnail mode with custom colors:
Installing via package manager
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.
Repos not tracked by repology:
- Fedora: Enable the copr repo via
dnf copr enable mamg22/nsxiv.
nsxiv requires the following software to be installed:
The following dependencies are optional.
inotifyℹ: Used for auto-reloading images on change. Disabled via
fontconfig: Used for the status bar. Disabled via
giflib: Used for animated gif playback. Disabled via
libexif: Used for auto-orientation and exif thumbnails. Disable via
libwebp: Used for animated webp playback. (NOTE: animated webp also requires Imlib2 v1.7.5 or above) Disabled via
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).
nsxiv is built using the commands:
You can pass
make to disable an optional dependency.
$ make HAVE_LIBEXIF=0
libexif support. Alternatively they can be disabled via editing
OPT_DEP_DEFAULT=0 can be used to disable all optional
# make install
Installing desktop entry:
# make install-desktop
# 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
.desktop entry will be
/usr/local/share/applications/nsxiv.desktop and the icon path will be
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
Refer to the man page for the documentation:
$ man nsxiv
Can I open remote urls with nsxiv?
Yes, see nsxiv-url
Can I open all the images in a directory?
Yes, see nsxiv-rifle
Can I set default arguments for nsxiv?
Yes, see nsxiv-env
Can I pipe images into nsxiv?
Yes, see nsxiv-pipe
You may also wish to see the known issues.
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.
Due to our limited project scope, certain features or customization cannot be merged into nsxiv mainline. Following the spirit of suckless software, we host the 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.
You can browse 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
If nsxiv isn't able to fit your needs, check out the image viewer section of suckless rocks to find other minimal image viewers to try out.
Below are a couple other lesser known projects not listed in suckless rocks.