Krolyxon
Commit 6d7acac

Branches

Refs →

nsxivREADME.md

275 lines · 9.0 KB · Markdown

Raw Blame History Download
1![sxiv](http://muennich.github.com/sxiv/img/logo.png "sxiv")
2
3**Simple X Image Viewer**
4
5sxiv is an alternative to feh and qiv. Its only dependencies besides xlib are
6imlib2 and giflib. The primary goal for writing sxiv is to create an image
7viewer, which only has the most basic features required for fast image viewing
8(the ones I want). It has vi key bindings and works nicely with tiling window
9managers. Its code base should be kept small and clean to make it easy for you
10to dig into it and customize it for your needs.
11
12
13Features
14--------
15
16* Basic image operations, e.g. zooming, panning, rotating
17* Customizable key and mouse button mappings (in *config.h*)
18* Thumbnail mode: grid of selectable previews of all images
19* Ability to cache thumbnails for fast re-loading
20* Basic support for multi-frame images
21* Load all frames from GIF files and play GIF animations
22* Display image information in status bar
23
24
25Screenshots
26-----------
27
28**Image mode:**
29
30![Image](http://muennich.github.com/sxiv/img/image.png "Image mode")
31
32**Thumbnail mode:**
33
34![Thumb](http://muennich.github.com/sxiv/img/thumb.png "Thumb mode")
35
36
37Installation
38------------
39
40sxiv is built using the commands:
41
42 $ make
43 # make install
44
45Please note, that the latter one requires root privileges.
46By default, sxiv is installed using the prefix "/usr/local", so the full path
47of the executable will be "/usr/local/bin/sxiv".
48
49You can install sxiv into a directory of your choice by changing the second
50command to:
51
52 # make PREFIX="/your/dir" install
53
54The build-time specific settings of sxiv can be found in the file *config.h*.
55Please check and change them, so that they fit your needs.
56If the file *config.h* does not already exist, then you have to create it with
57the following command:
58
59 $ make config.h
60
61
62Usage
63-----
64
65sxiv has two modes of operation: image and thumbnail mode. The default is
66image mode, in which only the current image is shown. In thumbnail mode a grid
67of small previews is displayed, making it easy to choose an image to open.
68
69**Command line options:**
70
71 -b Do not show info bar on bottom of window
72 -c Remove all orphaned cache files from thumbnail cache and exit
73 -f Start in fullscreen mode
74 -G GAMMA Set image gamma to GAMMA (-32..32)
75 -g GEOMETRY Set window position and size
76 (see section GEOMETRY SPECIFICATIONS of X(7))
77 -i Read file list from stdin
78 -N NAME Set X window resource name to NAME
79 -n NUM Start at picture NUM
80 -o Write list of marked files to stdout when quitting
81 -q Be quiet, disable warnings
82 -r Search given directories recursively for images
83 -S DELAY Enable slideshow and set slideshow delay to DELAY seconds
84 -s MODE Set scale mode to MODE ([d]own, [f]it, [w]idth, [h]eight)
85 -t Start in thumbnail mode
86 -v Print version information and exit
87 -Z Same as `-z 100'
88 -z ZOOM Set zoom level to ZOOM percent
89
90**Key mappings:**
91
92 q Quit sxiv
93 Return Switch to thumbnail mode / open selected image
94
95 0-9 Prefix the next command with a number (denoted via [count])
96
97 Ctrl-x Send the next key to the external key-handler
98
99 g Go to first image
100 G Go to the last image, or image number [count]
101
102 f Toggle fullscreen mode (requires an EWMH/NetWM compliant
103 window manager)
104 b Toggle visibility of info bar on bottom of window
105 A Toggle visibility of alpha-channel, i.e. transparency
106
107 r Reload image
108 R Reload all thumbnails
109 D Remove image from file list and go to next image
110
111 m Mark/unmark current image
112 M Reverse all image marks
113 N Go [count] marked images forward
114 P Go [count] marked images backward
115
116*Thumbnail mode:*
117
118 h,j,k,l Move selection left/down/up/right [count] times
119 Ctrl-j,k Scroll thumbnail grid one window height down/up
120
121*Image mode:*
122
123 n,Space Go [count] images forward
124 p,Backspace Go [count] images backward
125 [,] Go [count] * 10 images backward/forward
126
127 Ctrl-n,p Go to the next/previous frame of a multi-frame image
128 Ctrl-Space Play/pause animation of a multi-frame image
129
130 + Zoom in
131 - Zoom out
132 = Set zoom level to 100%, or [count]%
133 w Set zoom level to 100%, but fit large images into window
134 W Fit image to window
135 e Fit image to window width
136 E Fit image to window height
137
138 h,j,k,l Pan image 1/5 of window width/height or [count] pixels
139 left/down/up/right (also with arrow keys)
140 H,J,K,L Pan to left/bottom/top/right image edge
141 Ctrl-h,j,k,l Pan image one window width/height left/down/up/right
142 (also with Ctrl-arrow keys)
143
144 <,> Rotate image (counter-)clockwise by 90 degrees
145 ? Rotate image by 180 degrees
146 |,_ Flip image horizontally/vertically
147
148 {,} Decrease/increase gamma
149 Ctrl-g Reset gamma
150
151 a Toggle anti-aliasing
152
153 s Toggle slideshow or set delay to [count] seconds
154
155
156**Mouse button mappings:**
157
158*Image mode:*
159
160 Button1 Go to the next image
161 Button2 Drag image with mouse while keeping it pressed
162 Button3 Go to the previous image
163 Scroll Pan image up/down
164 Shift+Scroll Pan image left/right
165 Ctrl+Scroll Zoom in/out
166
167
168Download & Changelog
169--------------------
170
171You can [browse](https://github.com/muennich/sxiv) the source code repository
172on GitHub or get a copy using git with the following command:
173
174 git clone https://github.com/muennich/sxiv.git
175
176**Stable releases**
177
178**[v1.1.1](https://github.com/muennich/sxiv/archive/v1.1.1.tar.gz)**
179*(June 2, 2013)*
180
181 * Various bug fixes
182
183**[v1.1](https://github.com/muennich/sxiv/archive/v1.1.tar.gz)**
184*(March 30, 2013)*
185
186 * Added status bar on bottom of window with customizable content
187 * New keyboard shortcuts `\`/`|`: flip image vertically/horizontally
188 * New keyboard shortcut `Ctrl-6`: go to last/alternate image
189 * Added own EXIF orientation handling, removed dependency on libexif
190 * Fixed various bugs
191
192**[v1.0](https://github.com/muennich/sxiv/archive/v1.0.tar.gz)**
193*(October 31, 2011)*
194
195 * Support for multi-frame images & GIF animations
196 * POSIX compliant (IEEE Std 1003.1-2001)
197
198**[v0.9](https://github.com/muennich/sxiv/archive/v0.9.tar.gz)**
199*(August 17, 2011)*
200
201 * Made key and mouse mappings fully configurable in config.h
202 * Complete code refactoring
203
204**[v0.8.2](https://github.com/muennich/sxiv/archive/v0.8.2.tar.gz)**
205*(June 29, 2011)*
206
207 * POSIX-compliant Makefile; compiles under NetBSD
208
209**[v0.8.1](https://github.com/muennich/sxiv/archive/v0.8.1.tar.gz)**
210*(May 8, 2011)*
211
212 * Fixed fullscreen under window managers, which are not fully EWMH-compliant
213
214**[v0.8](https://github.com/muennich/sxiv/archive/v0.8.tar.gz)**
215*(April 18, 2011)*
216
217 * Support for thumbnail caching
218 * Ability to run external commands (e.g. jpegtran, convert) on current image
219
220**[v0.7](https://github.com/muennich/sxiv/archive/v0.7.tar.gz)**
221*(February 26, 2011)*
222
223 * Sort directory entries when using `-r` command line option
224 * Hide cursor in image mode
225 * Full functional thumbnail mode, use Return key to switch between image and
226 thumbnail mode
227
228**[v0.6](https://github.com/muennich/sxiv/archive/v0.6.tar.gz)**
229*(February 16, 2011)*
230
231 * Bug fix: Correctly display filenames with umlauts in window title
232 * Basic support of thumbnails
233
234**[v0.5](https://github.com/muennich/sxiv/archive/v0.5.tar.gz)**
235*(February 6, 2011)*
236
237 * New command line option: `-r`: open all images in given directories
238 * New key shortcuts: `w`: resize image to fit into window; `W`: resize window
239 to fit to image
240
241**[v0.4](https://github.com/muennich/sxiv/archive/v0.4.tar.gz)**
242*(February 1, 2011)*
243
244 * New command line option: `-F`, `-g`: use fixed window dimensions and apply
245 a given window geometry
246 * New key shortcut: `r`: reload current image
247
248**[v0.3.1](https://github.com/muennich/sxiv/archive/v0.3.1.tar.gz)**
249*(January 30, 2011)*
250
251 * Bug fix: Do not set setuid bit on executable when using `make install`
252 * Pan image with mouse while pressing middle mouse button
253
254**[v0.3](https://github.com/muennich/sxiv/archive/v0.3.tar.gz)**
255*(January 29, 2011)*
256
257 * New command line options: `-d`, `-f`, `-p`, `-s`, `-v`, `-w`, `-Z`, `-z`
258 * More mouse mappings: Go to next/previous image with left/right click,
259 scroll image with mouse wheel (horizontally if Shift key is pressed),
260 zoom image with mouse wheel if Ctrl key is pressed
261
262**[v0.2](https://github.com/muennich/sxiv/archive/v0.2.tar.gz)**
263*(January 23, 2011)*
264
265 * Bug fix: Handle window resizes correctly
266 * New keyboard shortcuts: `g`/`G`: go to first/last image; `[`/`]`: go 10
267 images back/forward
268 * Support for mouse wheel zooming (by Dave Reisner)
269 * Added fullscreen mode
270
271**[v0.1](https://github.com/muennich/sxiv/archive/v0.1.tar.gz)**
272*(January 21, 2011)*
273
274 * Initial release
275