nsxiv/README.md

216 lines
6.8 KiB
Markdown
Raw Normal View History

2014-01-15 23:13:59 +01:00
![sxiv](http://muennich.github.com/sxiv/img/logo.png "sxiv")
**Simple X Image Viewer**
2011-01-21 15:27:06 +01:00
The primary goal of sxiv is to create an image viewer, which only has the most
basic features required for fast image viewing (the ones I want). It has vi key
bindings and works nicely with tiling window managers. Its code base should be
kept small and clean to make it easy for you to dig into it and customize it
for your needs.
2011-01-21 15:27:06 +01:00
2011-09-08 16:48:55 +02:00
Features
--------
2011-09-08 16:48:55 +02:00
* 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
2011-09-08 16:48:55 +02:00
2011-09-08 17:31:37 +02:00
Screenshots
-----------
2011-09-08 17:31:37 +02:00
**Image mode:**
2011-09-08 17:31:37 +02:00
![Image](http://muennich.github.com/sxiv/img/image.png "Image mode")
2011-09-08 17:31:37 +02:00
**Thumbnail mode:**
![Thumb](http://muennich.github.com/sxiv/img/thumb.png "Thumb mode")
2011-09-08 17:31:37 +02:00
2011-01-21 15:27:06 +01:00
Installation
------------
2011-01-21 15:27:06 +01:00
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".
2011-01-21 15:27:06 +01:00
You can install sxiv into a directory of your choice by changing the second
2011-01-21 15:27:06 +01:00
command to:
# make PREFIX="/your/dir" install
2011-01-21 15:27:06 +01:00
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.
2011-09-13 10:08:55 +02:00
If the file *config.h* does not already exist, then you have to create it with
the following command:
$ make config.h
2011-01-21 15:27:06 +01:00
Usage
-----
2017-10-27 17:25:56 +02:00
Please see the [man page](http://muennich.github.com/sxiv/sxiv.1.html) for
information on how to use sxiv.
Download & Changelog
--------------------
You can [browse](https://github.com/muennich/sxiv) 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**
2017-10-27 17:25:56 +02:00
**[v24](https://github.com/muennich/sxiv/archive/v24.tar.gz)**
*(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)
2015-12-20 13:21:25 +01:00
**[v1.3.2](https://github.com/muennich/sxiv/archive/v1.3.2.tar.gz)**
*(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
2014-11-16 21:38:30 +01:00
**[v1.3.1](https://github.com/muennich/sxiv/archive/v1.3.1.tar.gz)**
*(November 16, 2014)*
* Fixed build error, caused by delayed config.h creation
* Fixed segfault when run with -c
2014-10-24 12:25:18 +02:00
**[v1.3](https://github.com/muennich/sxiv/archive/v1.3.tar.gz)**
*(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
2014-04-24 20:40:26 +02:00
**[v1.2](https://github.com/muennich/sxiv/archive/v1.2.tar.gz)**
*(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)
2013-06-02 12:04:40 +02:00
**[v1.1.1](https://github.com/muennich/sxiv/archive/v1.1.1.tar.gz)**
*(June 2, 2013)*
2013-06-02 12:31:27 +02:00
* Various bug fixes
2013-06-02 12:04:40 +02:00
**[v1.1](https://github.com/muennich/sxiv/archive/v1.1.tar.gz)**
2013-03-30 12:50:54 +01:00
*(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](https://github.com/muennich/sxiv/archive/v1.0.tar.gz)**
*(October 31, 2011)*
* Support for multi-frame images & GIF animations
* POSIX compliant (IEEE Std 1003.1-2001)
**[v0.9](https://github.com/muennich/sxiv/archive/v0.9.tar.gz)**
*(August 17, 2011)*
* Made key and mouse mappings fully configurable in config.h
* Complete code refactoring
**[v0.8.2](https://github.com/muennich/sxiv/archive/v0.8.2.tar.gz)**
*(June 29, 2011)*
* POSIX-compliant Makefile; compiles under NetBSD
**[v0.8.1](https://github.com/muennich/sxiv/archive/v0.8.1.tar.gz)**
*(May 8, 2011)*
* Fixed fullscreen under window managers, which are not fully EWMH-compliant
**[v0.8](https://github.com/muennich/sxiv/archive/v0.8.tar.gz)**
*(April 18, 2011)*
* Support for thumbnail caching
* Ability to run external commands (e.g. jpegtran, convert) on current image
**[v0.7](https://github.com/muennich/sxiv/archive/v0.7.tar.gz)**
*(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](https://github.com/muennich/sxiv/archive/v0.6.tar.gz)**
*(February 16, 2011)*
* Bug fix: Correctly display filenames with umlauts in window title
* Basic support of thumbnails
**[v0.5](https://github.com/muennich/sxiv/archive/v0.5.tar.gz)**
*(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](https://github.com/muennich/sxiv/archive/v0.4.tar.gz)**
*(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](https://github.com/muennich/sxiv/archive/v0.3.1.tar.gz)**
*(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](https://github.com/muennich/sxiv/archive/v0.3.tar.gz)**
*(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](https://github.com/muennich/sxiv/archive/v0.2.tar.gz)**
*(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](https://github.com/muennich/sxiv/archive/v0.1.tar.gz)**
*(January 21, 2011)*
* Initial release