mirror of https://github.com/mjohanning99/sxiv.git
Update README, add .diff files
parent
866704f2ca
commit
0ec29663fb
249
README.md
249
README.md
|
@ -1,244 +1,9 @@
|
|||
![sxiv](http://muennich.github.com/sxiv/img/logo.png "sxiv")
|
||||
# Marvin's build of sxiv
|
||||
This is my build of sxiv. It includes some key-remappings, an installer to automatically install the `key-handler` file into the correct directory and has starts up at a 16:9 resolution (the original started at a 4:3 resolution). The code that has been changed can be found in the appropriate `.diff` files (`config.h.diff` and `key-handler.diff`).
|
||||
|
||||
**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](http://muennich.github.com/sxiv/img/image.png "Image mode")
|
||||
|
||||
**Thumbnail mode:**
|
||||
|
||||
![Thumb](http://muennich.github.com/sxiv/img/thumb.png "Thumb mode")
|
||||
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
sxiv requires the following software to be installed:
|
||||
|
||||
* Imlib2
|
||||
* X11
|
||||
* Xft
|
||||
* freetype2
|
||||
* fontconfig
|
||||
* giflib (optional, disabled with `HAVE_GIFLIB=0`)
|
||||
* libexif (optional, disabled with `HAVE_LIBEXIF=0`)
|
||||
|
||||
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".
|
||||
|
||||
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](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**
|
||||
|
||||
**[v26](https://github.com/muennich/sxiv/archive/v26.tar.gz)**
|
||||
*(January 16, 2020)*
|
||||
|
||||
* Maintenance release
|
||||
|
||||
**[v25](https://github.com/muennich/sxiv/archive/v25.tar.gz)**
|
||||
*(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](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)
|
||||
|
||||
**[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
|
||||
|
||||
**[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
|
||||
|
||||
**[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
|
||||
|
||||
**[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)
|
||||
|
||||
**[v1.1.1](https://github.com/muennich/sxiv/archive/v1.1.1.tar.gz)**
|
||||
*(June 2, 2013)*
|
||||
|
||||
* Various bug fixes
|
||||
|
||||
**[v1.1](https://github.com/muennich/sxiv/archive/v1.1.tar.gz)**
|
||||
*(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
|
||||
## Installation
|
||||
The program can be installed by running the `installer.sh` file; this will automatically install the program and copy the `exec/` folder to the appropriate place.
|
||||
You may also install the program using `make` and copy the `exec/` folder to its appropriate location (`~/.config/sxiv/exec/`) manually.
|
||||
|
||||
## Original source code
|
||||
The original program can be found on `muennich`'s Github page: https://github.com/muennich/sxiv
|
||||
|
|
|
@ -0,0 +1,14 @@
|
|||
5,6c5,6
|
||||
< WIN_WIDTH = 896,
|
||||
< WIN_HEIGHT = 504
|
||||
---
|
||||
> WIN_WIDTH = 800,
|
||||
> WIN_HEIGHT = 600
|
||||
103c103
|
||||
< { 0, XK_L, i_navigate, +1 },
|
||||
---
|
||||
> { 0, XK_n, i_navigate, +1 },
|
||||
106c106
|
||||
< { 0, XK_H, i_navigate, -1 },
|
||||
---
|
||||
> { 0, XK_p, i_navigate, -1 },
|
|
@ -0,0 +1,17 @@
|
|||
26,32c26,33
|
||||
< "C-c") while read file; do xclip -selection clipboard -target image/png "$file"; done ;;
|
||||
< "C-g") tr '\n' '\0' | xargs -0 gimp & ;;
|
||||
< "C-period") rotate 90 ;;
|
||||
< "C-w") while read file; do wal -i $file --saturate 0.9; done ;;
|
||||
< "C-t") while read file; do wal -i $file --saturate 0.9 --backend colorthief; done ;;
|
||||
< "C-z") while read file; do wal -i $file --saturate 0.9 --backend colorz; done ;;
|
||||
<
|
||||
---
|
||||
> "C-x") xclip -in -filter | tr '\n' ' ' | xclip -in -selection clipboard ;;
|
||||
> "C-c") while read file; do xclip -selection clipboard -target image/png "$file"; done ;;
|
||||
> "C-e") while read file; do urxvt -bg "#444" -fg "#eee" -sl 0 -title "$file" -e sh -c "exiv2 pr -q -pa '$file' | less" & done ;;
|
||||
> "C-g") tr '\n' '\0' | xargs -0 gimp & ;;
|
||||
> "C-r") while read file; do rawtherapee "$file" & done ;;
|
||||
> "C-comma") rotate 270 ;;
|
||||
> "C-period") rotate 90 ;;
|
||||
> "C-slash") rotate 180 ;;
|
Loading…
Reference in New Issue