ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/CV/README
(Generate patch)

Comparing CV/README (file contents):
Revision 1.2 by root, Mon Jul 11 03:49:38 2005 UTC vs.
Revision 1.9 by root, Mon Apr 27 02:24:09 2009 UTC

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines