Krolyxon
Commit 2d703c3

Branches

Refs →

nsxivREADME.md

276 lines · 9.2 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 -d Scale all images to 100%, but fit large images into window
74 -F Use size-hints to make the window fixed/floating
75 -f Start in fullscreen mode
76 -G GAMMA Set image gamma to GAMMA (-32..32)
77 -g GEOMETRY Set window position and size
78 (see section GEOMETRY SPECIFICATIONS of X(7))
79 -i Read file list from stdin
80 -N NAME Set X window resource name to NAME
81 -n NUM Start at picture NUM
82 -o Write list of marked files to stdout when quitting
83 -q Be quiet, disable warnings
84 -r Search given directories recursively for images
85 -S DELAY Enable slideshow and set slideshow delay to DELAY seconds
86 -s Scale all images to fit into window
87 -t Start in thumbnail mode
88 -v Print version information and exit
89 -Z Same as `-z 100'
90 -z ZOOM Scale all images to current zoom level, use ZOOM at startup
91
92**Key mappings:**
93
94 q Quit sxiv
95 Return Switch to thumbnail mode / open selected image
96
97 0-9 Prefix the next command with a number (denoted via [count])
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 Ctrl-x KEY Execute $XDG_CONFIG_HOME/sxiv/exec/key-handler with
117 KEY and the path of the current image as arguments,
118 unless KEY is Escape, which cancels Ctrl-x.
119
120*Thumbnail mode:*
121
122 h,j,k,l Move selection left/down/up/right [count] times
123 Ctrl-j,k Scroll thumbnail grid one window height down/up
124
125*Image mode:*
126
127 n,Space Go [count] images forward
128 p,Backspace Go [count] images backward
129 [,] Go [count] * 10 images backward/forward
130
131 Ctrl-n,p Go to the next/previous frame of a multi-frame image
132 Ctrl-Space Play/pause animation of a multi-frame image
133
134 + Zoom in
135 - Zoom out
136 = Set zoom level to 100%, or [count]%
137 w Fit image into window
138 e Fit image width to window width
139 E Fit image height to window height
140
141 h,j,k,l Pan image 1/5 of window width/height or [count] pixels
142 left/down/up/right (also with arrow keys)
143 H,J,K,L Pan to left/bottom/top/right image edge
144 Ctrl-h,j,k,l Pan image one window width/height left/down/up/right
145 (also with Ctrl-arrow keys)
146
147 <,> Rotate image (counter-)clockwise by 90 degrees
148 ? Rotate image by 180 degrees
149 |,_ Flip image horizontally/vertically
150
151 s Toggle slideshow or set delay to [count] seconds
152
153 a Toggle anti-aliasing
154 W Resize window to fit image
155
156
157**Mouse button mappings:**
158
159*Image mode:*
160
161 Button1 Go to the next image
162 Button2 Drag image with mouse while keeping it pressed
163 Button3 Go to the previous image
164 Scroll Pan image up/down
165 Shift+Scroll Pan image left/right
166 Ctrl+Scroll Zoom in/out
167
168
169Download & Changelog
170--------------------
171
172You can [browse](https://github.com/muennich/sxiv) the source code repository
173on GitHub or get a copy using git with the following command:
174
175 git clone https://github.com/muennich/sxiv.git
176
177**Stable releases**
178
179**[v1.1.1](https://github.com/muennich/sxiv/archive/v1.1.1.tar.gz)**
180*(June 2, 2013)*
181
182 * Various bug fixes
183
184**[v1.1](https://github.com/muennich/sxiv/archive/v1.1.tar.gz)**
185*(March 30, 2013)*
186
187 * Added status bar on bottom of window with customizable content
188 * New keyboard shortcuts `\`/`|`: flip image vertically/horizontally
189 * New keyboard shortcut `Ctrl-6`: go to last/alternate image
190 * Added own EXIF orientation handling, removed dependency on libexif
191 * Fixed various bugs
192
193**[v1.0](https://github.com/muennich/sxiv/archive/v1.0.tar.gz)**
194*(October 31, 2011)*
195
196 * Support for multi-frame images & GIF animations
197 * POSIX compliant (IEEE Std 1003.1-2001)
198
199**[v0.9](https://github.com/muennich/sxiv/archive/v0.9.tar.gz)**
200*(August 17, 2011)*
201
202 * Made key and mouse mappings fully configurable in config.h
203 * Complete code refactoring
204
205**[v0.8.2](https://github.com/muennich/sxiv/archive/v0.8.2.tar.gz)**
206*(June 29, 2011)*
207
208 * POSIX-compliant Makefile; compiles under NetBSD
209
210**[v0.8.1](https://github.com/muennich/sxiv/archive/v0.8.1.tar.gz)**
211*(May 8, 2011)*
212
213 * Fixed fullscreen under window managers, which are not fully EWMH-compliant
214
215**[v0.8](https://github.com/muennich/sxiv/archive/v0.8.tar.gz)**
216*(April 18, 2011)*
217
218 * Support for thumbnail caching
219 * Ability to run external commands (e.g. jpegtran, convert) on current image
220
221**[v0.7](https://github.com/muennich/sxiv/archive/v0.7.tar.gz)**
222*(February 26, 2011)*
223
224 * Sort directory entries when using `-r` command line option
225 * Hide cursor in image mode
226 * Full functional thumbnail mode, use Return key to switch between image and
227 thumbnail mode
228
229**[v0.6](https://github.com/muennich/sxiv/archive/v0.6.tar.gz)**
230*(February 16, 2011)*
231
232 * Bug fix: Correctly display filenames with umlauts in window title
233 * Basic support of thumbnails
234
235**[v0.5](https://github.com/muennich/sxiv/archive/v0.5.tar.gz)**
236*(February 6, 2011)*
237
238 * New command line option: `-r`: open all images in given directories
239 * New key shortcuts: `w`: resize image to fit into window; `W`: resize window
240 to fit to image
241
242**[v0.4](https://github.com/muennich/sxiv/archive/v0.4.tar.gz)**
243*(February 1, 2011)*
244
245 * New command line option: `-F`, `-g`: use fixed window dimensions and apply
246 a given window geometry
247 * New key shortcut: `r`: reload current image
248
249**[v0.3.1](https://github.com/muennich/sxiv/archive/v0.3.1.tar.gz)**
250*(January 30, 2011)*
251
252 * Bug fix: Do not set setuid bit on executable when using `make install`
253 * Pan image with mouse while pressing middle mouse button
254
255**[v0.3](https://github.com/muennich/sxiv/archive/v0.3.tar.gz)**
256*(January 29, 2011)*
257
258 * New command line options: `-d`, `-f`, `-p`, `-s`, `-v`, `-w`, `-Z`, `-z`
259 * More mouse mappings: Go to next/previous image with left/right click,
260 scroll image with mouse wheel (horizontally if Shift key is pressed),
261 zoom image with mouse wheel if Ctrl key is pressed
262
263**[v0.2](https://github.com/muennich/sxiv/archive/v0.2.tar.gz)**
264*(January 23, 2011)*
265
266 * Bug fix: Handle window resizes correctly
267 * New keyboard shortcuts: `g`/`G`: go to first/last image; `[`/`]`: go 10
268 images back/forward
269 * Support for mouse wheel zooming (by Dave Reisner)
270 * Added fullscreen mode
271
272**[v0.1](https://github.com/muennich/sxiv/archive/v0.1.tar.gz)**
273*(January 21, 2011)*
274
275 * Initial release
276