1 |
NAME |
2 |
cv - a fast gtk+ image viewer loosely modeled after XV |
3 |
|
4 |
SYNOPSIS |
5 |
cv |
6 |
|
7 |
cv directory |
8 |
|
9 |
cv path... |
10 |
|
11 |
cv -g <glob expression...> |
12 |
|
13 |
find .. -print0 | cv -0r |
14 |
|
15 |
cv --sort ... |
16 |
|
17 |
FEATURES |
18 |
CV is supposed to work similar to the venerable XV image viewer, just |
19 |
faster. Why faster? |
20 |
|
21 |
* optimized directory scanning algorithm |
22 |
|
23 |
The directory scanning in CV uses some tricks that - on most modern |
24 |
filesystems - makes it possible to detect filetypes faster than |
25 |
stat()'ing every file. This makes CV suitable for directories with |
26 |
lots of files (10000+). |
27 |
|
28 |
This algorithm is quite unprecise - it doesn't make a difference |
29 |
between files, device nodes, symlinks and the like, and filetype |
30 |
detection is done using the file extension only. |
31 |
|
32 |
On the positive side, it is usually many orders of magnitude faster |
33 |
than traditional scanning techniques (good for directories with |
34 |
10000 or 100000+ files). |
35 |
|
36 |
* queuing for all time-consuming background tasks |
37 |
|
38 |
All tasks, such as unlinking files or generating thumbnails, that |
39 |
can be done in the background will be done so - no waiting required, |
40 |
even when changing directories. |
41 |
|
42 |
* use of asynchronous I/O |
43 |
|
44 |
CV tries to use asynchronous I/O whereever it makes sense, for |
45 |
example while scanning directories, waiting for stat data, unlinking |
46 |
files or generating thumbnails. This usually decreases scanning |
47 |
times for large directories a bit (especially on RAID devices and |
48 |
over NFS) and makes CV much more interactive. |
49 |
|
50 |
* fast image loading |
51 |
|
52 |
The time span between the user issuing a command and displaying the |
53 |
new image should be as small as possible. CV uses optimized |
54 |
(especially for JPEG) loading functions and sacrifices some quality |
55 |
(e.g no gamma correction, although this might change) to achieve |
56 |
this speed. |
57 |
|
58 |
* fast thumbnail creation |
59 |
|
60 |
Thumbnail creation uses both CPU and Disk-I/O. CV interleaves both, |
61 |
so on modern CPUs, thumbnailing is usually limited by I/O speed. |
62 |
Thumbnail creation for JPEGs has been specially optimized and can |
63 |
even take advantage of multiple CPUs. |
64 |
|
65 |
* minimum optical clutter |
66 |
|
67 |
CV has no menus or other user interface elements that take up a lot |
68 |
of screen space (or are useful for beginning users). The schnauzer |
69 |
windows can also be somewhat crowded. |
70 |
|
71 |
The point of an image viewer is viewing images, not a nice GUI. This |
72 |
is similar to XV's behaviour. |
73 |
|
74 |
* efficient (and hard to learn) user interface |
75 |
|
76 |
CV uses key combinations. A lot. If you are an experienced XV user, |
77 |
you will find most of these keys familiar. If not, CV might be hard |
78 |
to use at first, but will be an efficient tool later. |
79 |
|
80 |
* multi-window GUI |
81 |
|
82 |
CV doesn't force you to use a specific layout, instead it relies on |
83 |
your window manager, thus enabling you to chose whatever layout that |
84 |
suits you most. |
85 |
|
86 |
* i18n'ed filename handling throughout |
87 |
|
88 |
As long as glib can recognize your filename encoding (either UTF-8 |
89 |
or locale-specific, depending on the setting of G_BROKEN_FILENAMES) |
90 |
and you have the relevant fonts, CV will display your filenames |
91 |
correctly. |
92 |
|
93 |
* extensible through plug-ins |
94 |
|
95 |
I have weird plug-ins that access remote databases to find a |
96 |
directory. This is not likely to be of any use to other people. |
97 |
Likewise, others might have weird requirements I cannot dream of. |
98 |
|
99 |
* filename clustering |
100 |
|
101 |
Among the standard plug-ins is a filename clustering plug-in, that |
102 |
(in case of tens of thousands images in one directory) might be able |
103 |
to cluster similar names together. |
104 |
|
105 |
DESCRIPTION |
106 |
THE IMAGE WINDOW |
107 |
You can use the following keys in the image window: |
108 |
|
109 |
q quit the program |
110 |
< half the image size |
111 |
> double the image size |
112 |
, shrink the image by ~9% (opposite of .) |
113 |
. enlarge the image by 10% |
114 |
n reset to normal size |
115 |
m maximize to screensize |
116 |
M maximize to screensize, respecting image aspect |
117 |
ctrl-m toggle maxpect-always mode |
118 |
ctrl-sift-m toggle using current image size as max image size |
119 |
u uncrop |
120 |
r set scaling mode to 'nearest' (fastest) |
121 |
s set scaling mode to 'bilinear' (default) |
122 |
t rotate clockwise 90° |
123 |
T rotate counterclockwise° |
124 |
a apply all rotations loslessly to a jpeg file (using exiftran) |
125 |
ctrl-shift-t apply current rotation for future image loads |
126 |
ctrl-v open a new visual schnauzer window for the current dir |
127 |
ctrl-c clone the current image window |
128 |
ctrl-e run an editor ($CV_EDITOR or "gimp") on the current image |
129 |
ctrl-p fire up the print dialog |
130 |
ctrl-shift-p same as ctrl-p, but automatically selects "ok" |
131 |
escape cancel a crop action |
132 |
|
133 |
And when playing movies, these additional keys are active: |
134 |
|
135 |
left rewind by 10 seconds |
136 |
right forward by 10 seconds |
137 |
down rewind by 60 seconds |
138 |
up forward by 60 seconds |
139 |
pg_up rewind by 600 seconds |
140 |
pg_down forward by 600 seconds |
141 |
o toggle on-screen display |
142 |
p pause/unpause |
143 |
escape stop playing |
144 |
9 turn volume down |
145 |
0 turn volume up |
146 |
|
147 |
Any other keys will be sent to the default schnauzer window, which can |
148 |
be toggled on and off by right-clicking into the image window. |
149 |
|
150 |
Left-clicking into the image window will let you crop the image (usually |
151 |
to zoom into large images that CV scales down). |
152 |
|
153 |
THE VISUAL SCHNAUZER |
154 |
Any image-loading action in a schnauzer window acts on the |
155 |
"last-recently-activated" imagewindow, which currently is simply the |
156 |
last image window that received a keypress. |
157 |
|
158 |
You can use the following keys in the schnauzer window: |
159 |
|
160 |
ctrl-space, |
161 |
space move to and display next image |
162 |
ctrl-backspace, |
163 |
backspace move to and display previous image |
164 |
ctrl-return, |
165 |
return display selected picture, or enter directory |
166 |
|
167 |
cursor keys move selection |
168 |
page-up move one page up |
169 |
page-down move one page down |
170 |
home move to first file |
171 |
end move to last file |
172 |
|
173 |
ctrl-a select all files |
174 |
ctrl-shift-a select all files currently displayed in the schnauzer window |
175 |
ctrl-d delete selected files WITHOUT ASKING AGAIN |
176 |
ctrl-g force generation of thumbnails for the selected files |
177 |
ctrl-shift-g remove thumbnails for the selected files |
178 |
ctrl-s rescan current direcory or files updates/deletes etc. |
179 |
ctrl-u update selected (or all) icons if neccessary |
180 |
ctrl-- unselected thumbnailed images |
181 |
ctrl-+ keep only thumbnailed images, deselect others |
182 |
|
183 |
^ go to parent directory (caret). |
184 |
|
185 |
0-9, |
186 |
a-z find the first filename beginning with this letter |
187 |
|
188 |
Right-clicking into the schnauzer window displays a pop-up menu with |
189 |
additional actions. |
190 |
|
191 |
SELECTION |
192 |
You can select entries in the Schnauzer in a variety of ways: |
193 |
|
194 |
Keyboard |
195 |
Moving the cursor with the keyboard will first deselect all files |
196 |
and then select the file you moved to. |
197 |
|
198 |
Clicking |
199 |
Clicking on an entry will select the one you clicked and deselect |
200 |
all others. |
201 |
|
202 |
Shift-Clicking |
203 |
Shift-clicking will toggle the selection on the entry under the |
204 |
mouse. |
205 |
|
206 |
Dragging |
207 |
Dragging will select all entries between the one selected when |
208 |
pushing the button and the one selected when releasing the button. |
209 |
If you move above or below the schnauzer area while drag-selecting, |
210 |
the schnauzer will move up/down one row twice per second. In |
211 |
addition, horizontal mouse movement acts as a kind of invisible |
212 |
horizontal scrollbar. |
213 |
|
214 |
Hint: double-click works while click-selecting |
215 |
You can double-click any image while click-selecting to display it |
216 |
without stopping the selection process. This will act as if you |
217 |
normally double-clicked the image to display it, and will toggle the |
218 |
selection twice, resulting in no change. |
219 |
|
220 |
FILES |
221 |
When starting, CV runs the .cvrc file in your $HOME directory as if it |
222 |
were a perl script. in that, you will mostly load plug-ins. |
223 |
|
224 |
Example: |
225 |
|
226 |
system "fping -q -t 10 ether" |
227 |
or require "/fs/cv/cvplugin.pl"; |
228 |
|
229 |
This will load a plug-in, but only if the machine *ether* is reachable |
230 |
(supposedly the plug-in is networked in some way :). |
231 |
|
232 |
ENVIRONMENT VARIABLES |
233 |
CV_EDITOR |
234 |
The program that gets executed when the user presses "CTRL-e" in the |
235 |
Schnauzer or image window. The default is "gimp". |
236 |
|
237 |
CV_AUDIO_PLAYER |
238 |
EXPERIMENTAL: audio playback is now via mpv, this variable is |
239 |
currently ignored. |
240 |
|
241 |
Program used to play all sorts of audio (wav, aif, mp3, ogg...), |
242 |
default "play". Will be called like "$CV_AUDIO_PLAYER -- <path>". |
243 |
|
244 |
CV_MPLAYER |
245 |
Program used to play all sorts of video files. Unlike |
246 |
"CV_AUDIO_PLAYER", this really must be some version of the "mpv" |
247 |
programs, or something that is very command-line compatible to them. |
248 |
|
249 |
Note: for video-thumbnailing, mplayer is still used (and hardcoded). |
250 |
|
251 |
CV_PRINT_DESTINATION |
252 |
The default (perl-style) destination to use in the print dialog. |
253 |
|
254 |
CV_TRASHCAN |
255 |
When set, must point to a directory where all files that are deleted |
256 |
by the "Delete Physically" (ctrl-d) action are moved to (other |
257 |
deletion actions still delete!). If unset, files that are deleted |
258 |
are really being deleted. |
259 |
|
260 |
SIGNALS |
261 |
Sending CV a SIGUSR1 signal will cause all image viewers to reload the |
262 |
currently loaded image. This is useful if you use CV as a viewer for |
263 |
changing data - just run it in the background with some path and each |
264 |
time the image changes, send it a SIGUSR1. |
265 |
|
266 |
SECURITY CONSIDERATIONS |
267 |
CV uses Pixbuf to load non-JPEG images. Pixbuf is not considered safe |
268 |
for this purpose, though (from the gtk-2.2 release notes): |
269 |
|
270 |
"While efforts have been made to make gdk-pixbuf robust against invalid |
271 |
images, using gdk-pixbuf to load untrusted data is not recommended, due |
272 |
to the likelyhood that there are additional problems where an invalid |
273 |
image could cause gdk-pixbuf to crash or worse." |
274 |
|
275 |
BUGS/TODO |
276 |
Lots of functionality is missing. |
277 |
|
278 |
Pixbuf doesn't always honor G_BROKEN_FILENAMES, so accessing files with |
279 |
names incompatible with utf-8 might fail. |
280 |
|
281 |
rotate on disk |
282 |
lots of ui issues |
283 |
save(?) |
284 |
preferences |
285 |
|
286 |
AUTHOR |
287 |
Marc Lehmann <cv@plan9.de>. |
288 |
|