Alexander/nsxiv
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated doc for thumbnail cache

Browse Source
This commit is contained in:
Bert 2011-04-08 17:07:25 +02:00
parent dc54981a68
commit bb85d3dca6
2 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -36,6 +36,7 @@ sxiv supports the following command-line options:
-a Display all given files, do not filter out unsupported files -a Display all given files, do not filter out unsupported files
(shorter startup time for long file list or slow file types) (shorter startup time for long file list or slow file types)
-C Remove all orphaned cache files from thumbnail cache and exit
-d Scale all images to 100%, but fit large images into window -d Scale all images to 100%, but fit large images into window
-F Use size-hints to make the window fixed/floating -F Use size-hints to make the window fixed/floating
-f Start in fullscreen mode -f Start in fullscreen mode

25
sxiv.1
View File

@ -3,7 +3,7 @@
sxiv \- Simple (or small or suckless) X Image Viewer sxiv \- Simple (or small or suckless) X Image Viewer
.SH SYNOPSIS .SH SYNOPSIS
.B sxiv .B sxiv
.RB [ \-adFfhpqrstvZ ] .RB [ \-aCdFfhpqrstvZ ]
.RB [ \-g .RB [ \-g
.IR GEOMETRY ] .IR GEOMETRY ]
.RB [ \-z .RB [ \-z
@ -24,6 +24,9 @@ sxiv has two modes of operation: image and thumbnail mode. The default is image
mode, in which only the current image is shown. In thumbnail mode a grid of mode, in which only the current image is shown. In thumbnail mode a grid of
small previews is displayed, making it easy to choose an image to open. small previews is displayed, making it easy to choose an image to open.
.P .P
sxiv can also cache its thumbnails. Please see the section THUMBNAIL CACHING
for information on how to enable this feature.
.P
Please note, that the fullscreen mode requires an EWMH/NetWM compliant window Please note, that the fullscreen mode requires an EWMH/NetWM compliant window
manager. manager.
.SH OPTIONS .SH OPTIONS
@ -33,6 +36,9 @@ Display all given files, do not filter out unsupported files. This might result
in a much shorter startup time, when the file list is very long or contains in a much shorter startup time, when the file list is very long or contains
large files of slow loadable types, e.g. gif and progressive jpg. large files of slow loadable types, e.g. gif and progressive jpg.
.TP .TP
.B \-C
Remove all orphaned cache files from the thumbnail cache directory and exit.
.TP
.B \-d .B \-d
Scale all images to 100%, but fit large images into window. Scale all images to 100%, but fit large images into window.
.TP .TP
@ -191,6 +197,23 @@ Pan image left.
.TP .TP
.B Shift+ScrollDown .B Shift+ScrollDown
Pan image right. Pan image right.
.SH THUMBNAIL CACHING
To enable thumbnail caching, please make sure to create the directory
.I ~/.sxiv/
with write permissions. sxiv will then store all thumbnails inside this
directory, but it will not create this directory by itself. It rather uses the
existance of this directory as an affirmation, that the user wants thumbnails
to be cached.
.P
Use the command line option
.I \-C
to keep the cache directory clean by removing all orphaned cache files.
Additionally, run the following command afterwards inside the cache directory
to remove empty subdirectories:
.P
.RS
find -type d -empty -delete
.RE
.SH AUTHORS .SH AUTHORS
.EX .EX
Bert Muennich <ber.t at gmx.com> Bert Muennich <ber.t at gmx.com>