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

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

Diff Legend

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