nsxivbb85d3d
Updated doc for thumbnail cache
+25 −1
2 files changed
| @@ -36,6 +36,7 @@ sxiv supports the following command-line options: | |||
| 36 | 36 | ||
| 37 | 37 | -a Display all given files, do not filter out unsupported files | |
| 38 | 38 | (shorter startup time for long file list or slow file types) | |
| 39 | + | -C Remove all orphaned cache files from thumbnail cache and exit | |
| 39 | 40 | -d Scale all images to 100%, but fit large images into window | |
| 40 | 41 | -F Use size-hints to make the window fixed/floating | |
| 41 | 42 | -f Start in fullscreen mode | |
| @@ -3,7 +3,7 @@ | |||
| 3 | 3 | sxiv \- Simple (or small or suckless) X Image Viewer | |
| 4 | 4 | .SH SYNOPSIS | |
| 5 | 5 | .B sxiv | |
| 6 | − | .RB [ \-adFfhpqrstvZ ] | |
| 6 | + | .RB [ \-aCdFfhpqrstvZ ] | |
| 7 | 7 | .RB [ \-g | |
| 8 | 8 | .IR GEOMETRY ] | |
| 9 | 9 | .RB [ \-z | |
| @@ -24,6 +24,9 @@ sxiv has two modes of operation: image and thumbnail mode. The default is image | |||
| 24 | 24 | mode, in which only the current image is shown. In thumbnail mode a grid of | |
| 25 | 25 | small previews is displayed, making it easy to choose an image to open. | |
| 26 | 26 | .P | |
| 27 | + | sxiv can also cache its thumbnails. Please see the section THUMBNAIL CACHING | |
| 28 | + | for information on how to enable this feature. | |
| 29 | + | .P | |
| 27 | 30 | Please note, that the fullscreen mode requires an EWMH/NetWM compliant window | |
| 28 | 31 | manager. | |
| 29 | 32 | .SH OPTIONS | |
| @@ -33,6 +36,9 @@ Display all given files, do not filter out unsupported files. This might result | |||
| 33 | 36 | in a much shorter startup time, when the file list is very long or contains | |
| 34 | 37 | large files of slow loadable types, e.g. gif and progressive jpg. | |
| 35 | 38 | .TP | |
| 39 | + | .B \-C | |
| 40 | + | Remove all orphaned cache files from the thumbnail cache directory and exit. | |
| 41 | + | .TP | |
| 36 | 42 | .B \-d | |
| 37 | 43 | Scale all images to 100%, but fit large images into window. | |
| 38 | 44 | .TP | |
| @@ -191,6 +197,23 @@ Pan image left. | |||
| 191 | 197 | .TP | |
| 192 | 198 | .B Shift+ScrollDown | |
| 193 | 199 | Pan image right. | |
| 200 | + | .SH THUMBNAIL CACHING | |
| 201 | + | To enable thumbnail caching, please make sure to create the directory | |
| 202 | + | .I ~/.sxiv/ | |
| 203 | + | with write permissions. sxiv will then store all thumbnails inside this | |
| 204 | + | directory, but it will not create this directory by itself. It rather uses the | |
| 205 | + | existance of this directory as an affirmation, that the user wants thumbnails | |
| 206 | + | to be cached. | |
| 207 | + | .P | |
| 208 | + | Use the command line option | |
| 209 | + | .I \-C | |
| 210 | + | to keep the cache directory clean by removing all orphaned cache files. | |
| 211 | + | Additionally, run the following command afterwards inside the cache directory | |
| 212 | + | to remove empty subdirectories: | |
| 213 | + | .P | |
| 214 | + | .RS | |
| 215 | + | find -type d -empty -delete | |
| 216 | + | .RE | |
| 194 | 217 | .SH AUTHORS | |
| 195 | 218 | .EX | |
| 196 | 219 | Bert Muennich <ber.t at gmx.com> | |