demos/spiv/spiv.1

   1 .TH spiv 1 2013 GFXprim "Simple yet Powerful Image Viewer"
   2
   3 .SH NAME
   4 spiv \- Simple yet Powerful Image Viewer
   5 .SH SYNOPSIS
   6 .B spiv
   7 [options] images|dirs
   8 .SH DESCRIPTION
   9 .B spiv
  10 is a fast, lightweight and minimalistic image viewer build on the
  11 top of the GFXprim library.
  12 .PP
  13 Spiv supports wide range of image formats, currently supported are
  14 JPEG, PNG, GIF, BMP, TIFF, PSP, PSD, PNM, PCX, JPEG2000 and CBZ
  15 (as well general ZIP archives with images), and more will come in
  16 the near future.
  17 .PP
  18 Spiv supports variety of video backends (via GFXprim backends)
  19 currently these are X11, Linux Framebuffer, SDL and AAlib. Spiv also
  20 supports wide range of backend pixel types from 1bit Grayscale to 32bit RGB
  21 with optional Floyd-Steinberg dithering (even, for example, from RGB888 to RGB565).
  22 .PP
  23 Spiv implements feh-like image actions, which are short shell scripts with
  24 printf-like modifiers.
  25 See
  26 .B ACTIONS
  27 below for further information.
  28
  29 .SH KEYBOARD CONTROL
  30 .IP "Esc, Enter, Q"
  31 Quit spiv
  32 .IP "Space"
  33 Move to the next image
  34 .IP "BackSpace"
  35 Move to the prev image
  36 .IP "PgDown"
  37 Move to the start of directory
  38 .IP "PgUp"
  39 Move to the end of directory
  40 .IP "Home"
  41 Move to the first image
  42 .IP "End"
  43 Move to the last image
  44 .IP "R"
  45 Rotate by 90 degrees clockwise
  46 .IP "E"
  47 Rotate by 90 degrees counterclockwise
  48 .IP "W"
  49 Toggle fixed, resizable window
  50 .IP "D"
  51 Turn on/off downscale when image is larger than win
  52 .IP "U"
  53 Turn on/off upscale when image is smaller than win
  54 .IP "H"
  55 Show help
  56 .IP "I"
  57 Toggle show info box
  58 .IP "P"
  59 Toggle show progress
  60 .IP "S"
  61 Start/stop slideshow
  62 .IP "F1-F10"
  63 Execute action 1 - 10
  64 .IP "<, KP Minus"
  65 Zoom out by 50% (by 10% with Shift)
  66 .IP ">, KP Plus"
  67 Zoom in by 50% (by 10% with Shift)
  68 .IP "1"
  69 Resize to the image size
  70 .IP "2"
  71 Resize to a half of the image size
  72 .IP "3"
  73 Resize to one third of the image size
  74 .IP "9"
  75 Resize to one ninth of the image size
  76 .IP "0"
  77 Resize to one tenth of the image size
  78 .IP "Shift 2"
  79 Resize twice of the image size
  80 .IP "Shift 3"
  81 Resize three times of the image size
  82 .IP "Up"
  83 Move image by 10px up (by 1 with Shift)
  84 .IP "Down"
  85 Move image by 10px down (by 1 with Shift)
  86 .IP "Left"
  87 Move image by 10px left (by 1 with Shift)
  88 .IP "Right"
  89 Move image by 10px right (by 1 with Shift)
  90 .IP "]"
  91 Change to next resampling method
  92 .IP "["
  93 Change to prev resampling method
  94 .IP "L"
  95 Toggle low pass filter
  96 .IP "C"
  97 Drop image cache
  98 .SH OPTIONS
  99 .TP
 100 .B  \-h, \-\-help
 101 Shows this help
 102 .TP
 103 .I Gui
 104 .TP
 105 .B  \-i, \-\-show\-info
 106 Show image info such as filename, size, etc...
 107 .TP
 108 .B  \-\-font\-path=value
 109 Path to TTF font to be used in GUI
 110 .TP
 111 .B  \-\-font\-height=value
 112 TTF font height in pixels
 113 .TP
 114 .B  \-p, \-\-show\-progress
 115 Show progress bar when loading/resampling/... images
 116 .TP
 117 .B  \-s=value, \-\-slideshow\-delay=value
 118 Delay between images in seconds (float) for slideshow
 119 .TP
 120 .B  \-d, \-\-dithering
 121 Turn on Floyd\-Steinberg dithering
 122 .TP
 123 .B  \-o=value, \-\-orientation=value
 124 Orientation, one of 0, 90, 180, 270
 125 .TP
 126 .B  \-f, \-\-full\-screen
 127 Start fullscreen.
 128 .TP
 129 .B  \-b=value, \-\-backend\-init=value
 130 Backend init string, set it to 'help' for more info
 131 .TP
 132 .I Zoom
 133 .TP
 134 .B  \-w=value, \-\-window\-size=value
 135 Window size, resizeable (\-wr) or fixed (\-wf)
 136 .TP
 137 .B  \-z=value, \-\-zoom\-strategy=value
 138 Zoom strategy, none (\-zn), upscale (\-zu), downscale (\-zd) or both (\-zb)
 139 .TP
 140 .B  \-m=value, \-\-max\-win\-size=value
 141 Window maximal size, 800x600 for example
 142 .TP
 143 .I Actions
 144 .TP
 145 .B  \-1=value, \-\-action\-1=value
 146 .TP
 147 .B  \-2=value, \-\-action\-2=value
 148 .TP
 149 .B  \-3=value, \-\-action\-3=value
 150 .TP
 151 .B  \-4=value, \-\-action\-4=value
 152 .TP
 153 .B  \-5=value, \-\-action\-5=value
 154 .TP
 155 .B  \-6=value, \-\-action\-6=value
 156 .TP
 157 .B  \-7=value, \-\-action\-7=value
 158 .TP
 159 .B  \-8=value, \-\-action\-8=value
 160 .TP
 161 .B  \-9=value, \-\-action\-9=value
 162 .TP
 163 .B  \-0=value, \-\-action\-10=value
 164 Sets command line for action 1\-10
 165 .TP
 166 .I Devel
 167 .TP
 168 .B  \-t, \-\-timers
 169 Turns on cpu and wall clock measurement (printed to stdout)
 170 .TP
 171 .B  \-e=value, \-\-backend\-emulation=value
 172 Emulate different backend pixel type (G1, G2, RGB555, ...)
 173 .TP
 174 .B  \-\-print\-man
 175 Prints spiv man page to stdout
 176 .SH CONFIGURATION FILE
 177 Configuraton file has simple key = value syntax, keys without values are written just as key.
 178 Lines started with # are comments.
 179 Keys are grouped in namespaces, namespace block is started
 180 by [NameSpace] and continues until next namespace.
 181 .TP
 182 .I [Gui]
 183 .TP
 184 .B ShowInfo
 185 Show image info such as filename, size, etc...
 186 .TP
 187 .B FontPath=value
 188 Path to TTF font to be used in GUI
 189 .TP
 190 .B FontHeight=value
 191 TTF font height in pixels
 192 .TP
 193 .B ShowProgress
 194 Show progress bar when loading/resampling/... images
 195 .TP
 196 .B SlideshowDelay=value
 197 Delay between images in seconds (float) for slideshow
 198 .TP
 199 .B Dithering
 200 Turn on Floyd-Steinberg dithering
 201 .TP
 202 .B Orientation=value
 203 Orientation, one of 0, 90, 180, 270
 204 .TP
 205 .B FullScreen
 206 Start fullscreen.
 207 .TP
 208 .B BackendInit=value
 209 Backend init string, set it to 'help' for more info
 210 .TP
 211 .I [Zoom]
 212 .TP
 213 .B WindowSize=value
 214 Window size, resizeable (-wr) or fixed (-wf)
 215 .TP
 216 .B ZoomStrategy=value
 217 Zoom strategy, none (-zn), upscale (-zu), downscale (-zd) or both (-zb)
 218 .TP
 219 .B MaxWinSize=value
 220 Window maximal size, 800x600 for example
 221 .TP
 222 .I [Actions]
 223 .TP
 224 .B 1=value
 225 .TP
 226 .B 2=value
 227 .TP
 228 .B 3=value
 229 .TP
 230 .B 4=value
 231 .TP
 232 .B 5=value
 233 .TP
 234 .B 6=value
 235 .TP
 236 .B 7=value
 237 .TP
 238 .B 8=value
 239 .TP
 240 .B 9=value
 241 .TP
 242 .B 10=value
 243 Sets command line for action 1-10
 244 .TP
 245 .I [Devel]
 246 .TP
 247 .B Timers
 248 Turns on cpu and wall clock measurement (printed to stdout)
 249 .TP
 250 .B BackendEmulation=value
 251 Emulate different backend pixel type (G1, G2, RGB555, ...)
 252 .PP
 253 Configuration is loaded from /etc/spiv.conf
 254 then ~/.spiv and overriden by command line parameters.
 255
 256 .SH ACTIONS
 257 Actions are short shell scripts with printf-like modifiers, the
 258 modifiers are substituted to current image path, name, etc. and executed
 259 by pressing function keys).
 260 .PP
 261 Actions could be set via command line parameters or written into the
 262 configuration file and support following modifiers:
 263
 264 .PP
 265 .B %f
 266 Path to current image
 267 .PP
 268 .B %F
 269 Shell escaped path to current image
 270 .PP
 271 .B %n
 272 Current image filename without extension
 273 .PP
 274 .B %N
 275 Shell escaped image filename without extension
 276 .PP
 277 .B %e
 278 Current image file extension
 279 .SH EXAMPLES
 280 .PP
 281 .B Shows all jpeg images in current directory
 282 .nf
 283 spiv *.jpg
 284
 285 .PP
 286 .B Shows all images stored in zip file
 287 .nf
 288 spiv images.zip
 289
 290 .PP
 291 .B Shows all loadable images in current directory
 292 .nf
 293 spiv .
 294
 295 .PP
 296 .B Runs slideshow with 5 second delay
 297 .nf
 298 spiv -s 5 vacation/
 299
 300 .PP
 301 .B Copies currently loaded image into directory 'sorted/' on pressing F1
 302 .nf
 303 spiv -1 'cp %F sorted' images/
 304
 305 .PP
 306 .B Emulates 1-bit Grayscale display and turns on Floyd-Steinberg dithering
 307 .nf
 308 spiv -e G1 -d images/
 309
 310 .PP
 311 .B Runs slideshow using X root window as backend window
 312 .nf
 313 spiv -b 'X11:use_root' -t 10 images/
 314
 315 .PP
 316 .B Same as above but works in KDE
 317
 318 .nf
 319 spiv -b 'X11:create_root' -t 10 images/
 320
 321 .SH BUGS
 322 Bugs happen. If you find one, report it on the GFXprim mailing list at
 323 .I gfxprim@ucw.cz
 324 .SH AUTHORS
 325 Spiv is developed by Cyril Hrubis <metan@ucw.cz>
 326 .PP
 327 GFXprim was/is developed by:
 328 .PP
 329 .nf
 330 Cyril Hrubis <metan@ucw.cz>
 331 .nf
 332 Jiri "BlueBear" Dluhos <jiri.bluebear.dluhos@gmail.com>
 333 .nf
 334 Tomas Gavenciak <gavento@ucw.cz>
 335