Personal fork of nsxiv
Go to file
NRK 43fcd2e02e set env var NSXIV_USING_NULL for key-handler and update docs
Co-authored-by: Berke Kocaoğlu <berke.kocaoglu@metu.edu.tr>
2021-11-19 17:02:50 +06:00
examples set env var NSXIV_USING_NULL for key-handler and update docs 2021-11-19 17:02:50 +06:00
icon Embed new nsxiv icon (#163) 2021-11-13 17:43:15 +00:00
.editorconfig add an editorconfig file, closes #25 2021-09-16 22:55:31 +03:00
.gitignore Embed new nsxiv icon (#163) 2021-11-13 17:43:15 +00:00
CHANGELOG.md Stable version 27.1 2021-09-17 05:25:19 +06:00
CONTRIBUTING.md add links to labels in CONTRIBUTING (#154) 2021-11-03 05:28:12 +00:00
LICENSE Added LICENSE 2011-01-18 15:29:18 +01:00
Makefile Add ability to bind arbitrary functions. 2021-10-13 06:05:00 +06:00
README.md Adding shields.io badges for Readme (#159) 2021-11-06 02:02:02 -06:00
autoreload_inotify.c code-style: fix consistency issues all over the codebase (#94) 2021-10-11 09:07:18 +06:00
autoreload_nop.c code-style: fix consistency issues all over the codebase (#94) 2021-10-11 09:07:18 +06:00
commands.c make width of navigation area configurable (#155) 2021-11-04 04:20:28 +00:00
commands.h Add ability to bind arbitrary functions. 2021-10-13 06:05:00 +06:00
config.def.h make width of navigation area configurable (#155) 2021-11-04 04:20:28 +00:00
image.c code-style: general cleanups (#137) 2021-10-29 02:00:53 +06:00
main.c set env var NSXIV_USING_NULL for key-handler and update docs 2021-11-19 17:02:50 +06:00
nsxiv.1 set env var NSXIV_USING_NULL for key-handler and update docs 2021-11-19 17:02:50 +06:00
nsxiv.desktop Rename, Update Docs and Prepare for Release (#9) 2021-09-16 22:55:31 +03:00
nsxiv.h use dedicated function to process key/button bindings (#166) 2021-11-19 05:49:42 +00:00
options.c -0 sends NULL separated file-list to key-handler 2021-10-29 17:45:55 -06:00
thumbs.c code-style: general cleanups (#137) 2021-10-29 02:00:53 +06:00
utf8.h code-style: general cleanups (#137) 2021-10-29 02:00:53 +06:00
util.c code-style: general cleanups (#137) 2021-10-29 02:00:53 +06:00
window.c Add colors and fonts to config.h (#115) 2021-10-29 12:53:49 +06:00

README.md

nsxiv

tags license loc

Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer

nsxiv is a fork of now unmaintained sxiv with the purpose of maintaining it 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 in this repository, after making sure you are using the latest release of nsxiv. Contributions are welcome, see CONTRIBUTING.md for details.

Features

  • Basic image operations, e.g. zooming, panning, rotating
  • Customizable key and mouse button mappings (in config.h)
  • Thumbnail mode: grid of selectable previews of all images
  • Ability to cache thumbnails for fast re-loading
  • Basic support for multi-frame images
  • Play GIF animations
  • Display image information in status bar
  • Display image name/path in X title

Screenshots

Image mode: (Default colors)

Image

Thumbnail mode: (Custom colors)

Thumb

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.

Packaging status

Repos not tracked by repology:

  • Fedora: Enable the copr repo via dnf copr enable mamg22/nsxiv.

Dependencies

nsxiv requires the following software to be installed:

  • Imlib2
  • X11

The following dependencies are optional.

  • inotify : 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
  • giflib : Used for animated gif playback. Disabled via HAVE_LIBGIF=0.
  • libexif : Used for auto-orientation and exif thumbnails. Disable via HAVE_LIBEXIF=0
  • libwebp : Used for animated webp playback. Disabled via HAVE_LIBWEBP=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).

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 the Makefile directly. 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

Please see man page for information on how to use nsxiv. To do so, execute the following after the installation:

$ man nsxiv

F.A.Q

  • 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

User patches

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.

Description on how to use or submit patches can be found on nsxiv-extra's README.

Download

You can browse the source code repository on GitHub or get a copy using git with the following command:

$ git clone https://github.com/nsxiv/nsxiv.git

You can view the changelog here