Personal fork of nsxiv
Go to file
TAAPArthur 25a3114709 Rework the build system (#19)
* Added simple configure script

Added simple script to autodetect if optional dependencies are installed
and enable/disable them as needed. Note this solution uses the compiler
directly instead of an external program like pkgconfig so it doesn't
require any extra dependencies. It is intended to work with any
arbitrary compiler; it has been tested with tcc and gcc.

There are some "breaking" changes hidden here
- HAVE_GIFLIB was renamed to HAVE_LIBGIF to match HAVE_LIBEXIF
- Simply typing `make` will no longer try to build with optional
  dependencies

* use implicit RM variable

* General clean-up in configure

- Use printf instead of echo
- Format style

* honor env PREFIX, use LDLIBS

* Revert "General clean-up in configure"

This reverts commit 8683c179dbf273a330f9a224a4d481a7bea42c5f.

* honor env LDFLAGS if set

* Don't set OPTIONAL_LIBS in configure

* make OBJ all caps

* follow suckless style build system

- remove configure script.
- HAVE_LIBGIF and HAVE_LIBEXIF defaults back to 1
- unload several varibales onto config.mk
- make version all-caps
- add -O2 optimization
- use CPPFLAGS for includes and defines

* Revert "follow suckless style build system"

This reverts commit 8bf75b1f68d72df349edba8d998d4659dd956dd8.

* Generate config.mk from make

* Inlined configure in Makefile

* update docs

* cleanups

- changes to config.mk should trigger a rebuild
- remove potentially confusing variables form Makefile

* Use install instead of mkdir/cp/chmod when sensible

* fixup! Inlined configure in Makefile

* Don't generate config.mk on rm -f *.o sxiv

* update docs and cleanups

- make config.mk silent
- mention editing config.mk in README

* fallback to 0 if user edits config.mk in unexpected way

* add comment on config.mk

* remove invalid comment

configure script is removed

* slight restructure

- make version all caps
- restructure variables that users may want to edit to top
- use CPPFLAGS for defines
- add some comments
- remove needless echos since we have verbose output now

* add echos back

Co-authored-by: NRK <nrk@disroot.org>
Co-authored-by: Berke Kocaoğlu <berke.kocaoglu@metu.edu.tr>
2021-09-16 22:55:31 +03:00
exec Add rawtherapee entry to key-handler 2019-01-01 13:47:46 +01:00
icon optimized icons 2014-11-01 20:12:27 +01:00
.editorconfig add an editorconfig file, closes #25 2021-09-16 22:55:31 +03:00
.gitignore Rework the build system (#19) 2021-09-16 22:55:31 +03:00
LICENSE Added LICENSE 2011-01-18 15:29:18 +01:00
Makefile Rework the build system (#19) 2021-09-16 22:55:31 +03:00
README.md Rework the build system (#19) 2021-09-16 22:55:31 +03:00
TODO Add TODO list 2016-08-08 09:34:37 +02:00
autoreload_inotify.c Ignore outdated inotify events 2018-02-18 14:12:41 +01:00
autoreload_nop.c Fix autoreload-nop accidentally selecting on stdin 2017-12-13 09:43:13 +01:00
commands.c Simplify cg_mark_range further 2018-06-10 12:39:23 +02:00
commands.lst Add mark range function 2018-06-09 11:44:47 +02:00
config.def.h set title based on prefix and suffix (#23) 2021-09-16 22:55:31 +03:00
image.c Rework the build system (#19) 2021-09-16 22:55:31 +03:00
main.c set title based on prefix and suffix (#23) 2021-09-16 22:55:31 +03:00
options.c set title based on prefix and suffix (#23) 2021-09-16 22:55:31 +03:00
sxiv.1 set title based on prefix and suffix (#23) 2021-09-16 22:55:31 +03:00
sxiv.desktop Advertise Webp support in desktop file. 2021-09-16 22:55:31 +03:00
sxiv.h set title based on prefix and suffix (#23) 2021-09-16 22:55:31 +03:00
thumbs.c set title based on prefix and suffix (#23) 2021-09-16 22:55:31 +03:00
utf8.h Replace utf8codepoint with Chris Wellons' utf8_decode 2017-12-07 21:19:53 +01:00
util.c Don't skip dot files when cleaning cache 2018-07-30 10:28:35 +02:00
window.c set title based on prefix and suffix (#23) 2021-09-16 22:55:31 +03:00

README.md

sxiv

Simple X Image Viewer

The sole purpose of sxiv is to be the perfect image viewer for me. It is free software so that you can use it and modify it for your needs. Please file a bug report if something does not work as documented or expected. Contributions are welcome but there is no guarantee that they will be incorporated.

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
  • Load all frames from GIF files and play GIF animations
  • Display image information in status bar

Screenshots

Image mode:

Image

Thumbnail mode:

Thumb

Dependencies

sxiv requires the following software to be installed:

  • Imlib2
  • X11
  • Xft
  • freetype2
  • fontconfig
  • giflib (optional, automatically enabled if installed)
  • libexif (optional, automatically enabled if installed)

Please make sure to install the corresponding development packages in case that you want to build sxiv on a distribution with separate runtime and development packages (e.g. *-dev on Debian).

Building

sxiv is built using the commands:

$ make
# make install

Please note, that the latter one requires root privileges. By default, sxiv is installed using the prefix "/usr/local", so the full path of the executable will be "/usr/local/bin/sxiv".

Running make will automatically detect if libexif and libgif are available and enable them if so. CLI arguments will override any automatic detection. For example:

$ make HAVE_LIBGIF=0

will always disable libgif. Alternatively, they can be disabled via editing config.mk.

You can install sxiv into a directory of your choice by changing the second command to:

# make PREFIX="/your/dir" install

The build-time specific settings of sxiv 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 the man page for information on how to use sxiv.

Download & Changelog

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

git clone https://github.com/muennich/sxiv.git

Stable releases

v26 (January 16, 2020)

  • Maintenance release

v25 (January 26, 2019)

  • Support font fallback for missing glyphs
  • Fix busy loop when built without inotify
  • Use background/foreground colors from X resource database

v24 (October 27, 2017)

  • Automatically reload the current image whenever it changes
  • Support embedding into other X windows with -e (e.g. tabbed)
  • New option -p prevents sxiv from creating cache and temporary files
  • Simpler mouse mappings, the most basic features are accessible with the mouse only (navigate, zoom, pan)

v1.3.2 (December 20, 2015)

  • external key handler gets file paths on stdin, not as arguments
  • Cache out-of-view thumbnails in the background
  • Apply gamma correction to thumbnails

v1.3.1 (November 16, 2014)

  • Fixed build error, caused by delayed config.h creation
  • Fixed segfault when run with -c

v1.3 (October 24, 2014)

  • Extract thumbnails from EXIF tags (requires libexif)
  • Zoomable thumbnails, supported sizes defined in config.h
  • Fixed build error with giflib version >= 5.1.0

v1.2 (April 24, 2014)

  • Added external key handler, called on keys prefixed with Ctrl-x
  • New keybinding {/} to change gamma (by András Mohari)
  • Support for slideshows, enabled with -S option & toggled with s
  • Added application icon (created by 0ion9)
  • Checkerboard background for alpha layer
  • Option -o only prints files marked with m key
  • Fixed rotation/flipping of multi-frame images (gifs)

v1.1.1 (June 2, 2013)

  • Various bug fixes

v1.1 (March 30, 2013)

  • Added status bar on bottom of window with customizable content
  • New keyboard shortcuts \/|: flip image vertically/horizontally
  • New keyboard shortcut Ctrl-6: go to last/alternate image
  • Added own EXIF orientation handling, removed dependency on libexif
  • Fixed various bugs

v1.0 (October 31, 2011)

  • Support for multi-frame images & GIF animations
  • POSIX compliant (IEEE Std 1003.1-2001)

v0.9 (August 17, 2011)

  • Made key and mouse mappings fully configurable in config.h
  • Complete code refactoring

v0.8.2 (June 29, 2011)

  • POSIX-compliant Makefile; compiles under NetBSD

v0.8.1 (May 8, 2011)

  • Fixed fullscreen under window managers, which are not fully EWMH-compliant

v0.8 (April 18, 2011)

  • Support for thumbnail caching
  • Ability to run external commands (e.g. jpegtran, convert) on current image

v0.7 (February 26, 2011)

  • Sort directory entries when using -r command line option
  • Hide cursor in image mode
  • Full functional thumbnail mode, use Return key to switch between image and thumbnail mode

v0.6 (February 16, 2011)

  • Bug fix: Correctly display filenames with umlauts in window title
  • Basic support of thumbnails

v0.5 (February 6, 2011)

  • New command line option: -r: open all images in given directories
  • New key shortcuts: w: resize image to fit into window; W: resize window to fit to image

v0.4 (February 1, 2011)

  • New command line option: -F, -g: use fixed window dimensions and apply a given window geometry
  • New key shortcut: r: reload current image

v0.3.1 (January 30, 2011)

  • Bug fix: Do not set setuid bit on executable when using make install
  • Pan image with mouse while pressing middle mouse button

v0.3 (January 29, 2011)

  • New command line options: -d, -f, -p, -s, -v, -w, -Z, -z
  • More mouse mappings: Go to next/previous image with left/right click, scroll image with mouse wheel (horizontally if Shift key is pressed), zoom image with mouse wheel if Ctrl key is pressed

v0.2 (January 23, 2011)

  • Bug fix: Handle window resizes correctly
  • New keyboard shortcuts: g/G: go to first/last image; [/]: go 10 images back/forward
  • Support for mouse wheel zooming (by Dave Reisner)
  • Added fullscreen mode

v0.1 (January 21, 2011)

  • Initial release