Debian Codegraph @

doc/fim.man.html

raw
1 <!-- Creator : groff version 1.22.4 -->
2 <!-- CreationDate: Sun May 19 12:02:42 2024 -->
3 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
4 "http://www.w3.org/TR/html4/loose.dtd">
5 <html>
6 <head>
7 <meta name="generator" content="groff -Thtml, see www.gnu.org">
8 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
9 <meta name="Content-Style" content="text/css">
10 <style type="text/css">
11 p { margin-top: 0; margin-bottom: 0; vertical-align: top }
12 pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
13 table { margin-top: 0; margin-bottom: 0; vertical-align: top }
14 h1 { text-align: center }
15 </style>
16 <title>FIM</title>
17
18 </head>
19 <body>
20
21 <h1 align="center">FIM</h1>
22
23 <a href="#NAME">NAME</a><br>
24 <a href="#SYNOPSIS">SYNOPSIS</a><br>
25 <a href="#DESCRIPTION">DESCRIPTION</a><br>
26 <a href="#USAGE">USAGE</a><br>
27 <a href="#OPTIONS">OPTIONS</a><br>
28 <a href="#PROGRAM RETURN STATUS">PROGRAM RETURN STATUS</a><br>
29 <a href="#COMMON KEYS AND COMMANDS">COMMON KEYS AND COMMANDS</a><br>
30 <a href="#AFFECTING ENVIRONMENT VARIABLES">AFFECTING ENVIRONMENT VARIABLES</a><br>
31 <a href="#COMMON PROBLEMS">COMMON PROBLEMS</a><br>
32 <a href="#INVOCATION EXAMPLES">INVOCATION EXAMPLES</a><br>
33 <a href="#NOTES">NOTES</a><br>
34 <a href="#BUGS">BUGS</a><br>
35 <a href="#FILES">FILES</a><br>
36 <a href="#SEE ALSO">SEE ALSO</a><br>
37 <a href="#AUTHOR">AUTHOR</a><br>
38 <a href="#COPYRIGHT">COPYRIGHT</a><br>
39
40 <hr>
41
42
43 <h2>NAME
44 <a name="NAME"></a>
45 </h2>
46
47
48 <p style="margin-left:11%; margin-top: 1em">fim -
49 <b>F</b>bi (linux <b>f</b>rame<b>b</b>uffer
50 <b>i</b>mageviewer) <b>IM</b>proved, an universal image
51 viewer</p>
52
53 <h2>SYNOPSIS
54 <a name="SYNOPSIS"></a>
55 </h2>
56
57
58 <p style="margin-left:11%; margin-top: 1em"><b>fim</b>
59 [<i>{options}</i>] [--] <i>{imagepath}</i>
60 [<i>{imagepaths}</i>] <b><br>
61 fim</b> --output-device
62 [fb|sdl|gtk|ca|aa|dumb][=<i>{gfxopts}</i>] <b><br>
63 ... | fim</b> [<i>{options}</i>] [--] [<i>{imagepaths}</i>]
64 - <b><br>
65 fim</b> [<i>{options}</i>] [--] [<i>{files}</i>] - &lt;
66 <i>{file_name_list_text_file}</i> <b><br>
67 fim</b> --image-from-stdin [<i>{options}</i>] &lt;
68 <i>{imagefile}</i> <b><br>
69 fim</b> --script-from-stdin [<i>{options}</i>] &lt;
70 <i>{scriptfile}</i> <b><br>
71 fim</b> --help[=s|d|l|m] [<i>{help-item}</i> ...]</p>
72
73 <h2>DESCRIPTION
74 <a name="DESCRIPTION"></a>
75 </h2>
76
77
78 <p style="margin-left:11%; margin-top: 1em"><b>fim</b> is a
79 &rsquo;swiss army knife&rsquo; for displaying image files.
80 It is capable of displaying image files using different
81 graphical devices while offering a uniform look and feel.
82 Key bindings are customizable and specified in an
83 initialization file. Interaction with standard input and
84 output is possible, especially in shell scripts. An internal
85 scripting language specialized for image viewing allows
86 image navigation, scaling, manipulation of internal
87 variables, command aliases, and Vim-like autocommands. The
88 internal language can be interacted with via a command line
89 mode capable of autocompletion and history (the readline
90 mode). Further features are display of EXIF tags, JPEG
91 comments, EXIF rotation/orientation, load of
92 &quot;description files&quot;, faster load via image
93 caching, command recording, and much more.</p>
94
95 <p style="margin-left:11%; margin-top: 1em">As a default,
96 <b>fim</b> displays the specified file(s) on the detected,
97 most convenient graphical device. This can be with SDL if
98 running under X, an ASCII-art driver (aalib or libcaca) if
99 running behind ssh without X forwarding, or the linux
100 framebuffer device. Graphical file formats BMP, PCX are
101 supported natively, while JPEG, PNG, GIF, TIFF, PPM, PGM,
102 PBM, QOI, AVIF, WEBP are supported via third party
103 libraries. Further formats are supported via external
104 converters. For XCF (Gimp&rsquo;s) images,
105 &rsquo;xcftopnm&rsquo; or &rsquo;xcf2pnm&rsquo; is used. For
106 FIG vectorial images, &rsquo;fig2dev&rsquo; is used. For DIA
107 vectorial images, &rsquo;dia&rsquo; is used. For NEF raw
108 camera images, &rsquo;dcraw&rsquo; is used. For SVG
109 vectorial images, &rsquo;inkscape&rsquo; is used. For other
110 formats ImageMagick&rsquo;s &rsquo;convert&rsquo; is used.
111 The converter is given 15 seconds for the conversion before
112 a timeout.</p>
113
114 <p style="margin-left:11%; margin-top: 1em">If
115 <i>{imagepath}</i> is a file, its format is guessed not by
116 its name but by its contents. See the <b>_file_loader</b>
117 variable to change this default.</p>
118
119 <p style="margin-left:11%; margin-top: 1em">If
120 <i>{imagepath}</i> is a directory, load files of supported
121 formats contained there. If <i>{imagepath}</i> contains a
122 trailing slash (/), it is treated as a directory; otherwise
123 that is checked via <b>stat(2)</b>. To change this default,
124 see description of the <b>_pushdir_re</b> variable and the
125 <b>--no-stat-push</b> and <b>--recursive</b> options.</p>
126
127 <p style="margin-left:11%; margin-top: 1em">This man page
128 describes <b>fim</b> command line options and usage. See man
129 <i>fimrc</i>(5) for a full specification of the <b>fim</b>
130 language, commands, keysyms, autocommands, variables,
131 aliases, examples for a configuration file and readline
132 usage samples.</p>
133
134 <h2>USAGE
135 <a name="USAGE"></a>
136 </h2>
137
138
139 <p style="margin-left:11%; margin-top: 1em">You may invoke
140 <b>fim</b> from an interactive shell and control it with the
141 keyboard, as you would do with any image viewer with
142 reasonable key bindings.</p>
143
144 <p style="margin-left:11%; margin-top: 1em"><b>fim</b> is
145 keyboard oriented: there are no user menus or buttons
146 available. If you need some feature or setting which is not
147 accessible from the default keyboard configuration, you
148 probably need a custom configuration or simply need to type
149 a custom command. For these, you can use the internal
150 command and configuration language.</p>
151
152 <p style="margin-left:11%; margin-top: 1em">See options
153 <b>--read-from-stdin</b>, <b>--script-from-stdin</b>, and
154 <b>--image-from-stdin</b> for more script-oriented
155 usages.</p>
156
157 <p style="margin-left:11%; margin-top: 1em">The full
158 commands specification is also accessible at runtime using
159 the internal help system (typing :help).</p>
160
161 <h2>OPTIONS
162 <a name="OPTIONS"></a>
163 </h2>
164
165
166 <p style="margin-left:11%; margin-top: 1em">Accepted
167 command line <i>{options}:</i></p>
168
169 <table width="100%" border="0" rules="none" frame="void"
170 cellspacing="0" cellpadding="0">
171 <tr valign="top" align="left">
172 <td width="11%"></td>
173 <td width="3%">
174
175
176 <p><b>--</b></p></td>
177 <td width="8%"></td>
178 <td width="78%">
179
180
181 <p>Treat arguments after <b>--</b> as filenames. Treat
182 arguments before <b>--</b> as command line options if these
183 begin with <b>-</b>, and as filenames otherwise.</p></td></tr>
184 </table>
185
186 <p style="margin-left:11%;"><b>-a</b>,
187 <b>--autozoom</b></p>
188
189 <p style="margin-left:22%;">Enable autozoom. Automagically
190 pick a reasonable zoom factor when displaying a new image
191 (as in <b>fbi</b>).</p>
192
193 <p style="margin-left:11%;"><b>-b[24|1]</b>,
194 <b>--binary[=24|1]</b></p>
195
196 <p style="margin-left:22%;">Display contents of binary
197 files (of any filetype) as these were raw 24 or 1 bits per
198 pixel pixelmaps. The width of this image will not exceed the
199 value of the <b>_preferred_rendering_width</b> variable.
200 Regard this as an easter bunny option.</p>
201
202 <p style="margin-left:11%;"><b>--as-text</b></p>
203
204 <p style="margin-left:22%;">Display contents of files (of
205 any filetype) as these were text. The width of this image
206 will not exceed the value of the
207 <b>_preferred_rendering_width</b> variable. Non-printable
208 characters are then displayed as &quot; &quot;. Regard this
209 as another easter bunny option.</p>
210
211 <p style="margin-left:11%;"><b>--cd-and-readdir</b></p>
212
213 <p style="margin-left:22%;">Step in the directory of the
214 first file to be loaded, push other files from that
215 directory, and jump back to the first file. Useful when
216 invoking from a desktop environment.</p>
217
218 <p style="margin-left:11%;"><b>-c</b> <i>{commands},</i>
219 <b>--execute-commands</b> <i>{commands}</i></p>
220
221 <p style="margin-left:22%;">Execute <i>{commands}</i> after
222 reading the initialization file, just before entering the
223 interactive mode. No semicolon (<b>;</b>) is required at the
224 end of <i>{commands}</i>. Do not forget quoting
225 <i>{commands}</i> in a manner suitable to your shell. So -c
226 next is fine as it is. A more complicated example, with
227 quotings: -c &rsquo;*2;2pan_up;display;while(1){align
228 &quot;bottom&quot;;sleep &quot;1&quot; ; align
229 &quot;top&quot;}&rsquo; (with the single quotes) tells fim
230 to: double the displayed image size, pan twice up, display
231 the image, and finally do an endless loop consisting of
232 bottom and top aligning, alternated.</p>
233
234 <p style="margin-left:11%;"><b>-C</b> <i>{commands},</i>
235 <b>--execute-commands-early</b> <i>{commands}</i></p>
236
237 <p style="margin-left:22%;">Similar to the
238 <b>--execute-commands</b> option, but execute
239 <i>{commands}</i> earlier, just before reading the
240 initialization file. If <i>{commands}</i> takes the special
241 &rsquo;early&rsquo; form <i>=var=val</i>, it assigns value
242 <i>val</i> to variable <i>var</i> immediately, before the
243 interpreter is started, and with no value quoting
244 needed.</p>
245
246 <p style="margin-left:22%; margin-top: 1em">For example, -C
247 &rsquo;<b>_scale_style</b>=&quot; &quot;&rsquo; starts fim
248 no auto-scaling; the equivalent early form is: -C
249 &rsquo;=<b>_scale_style</b>= &rsquo;.</p>
250
251 <p style="margin-left:11%;"><b>-d</b> <i>{fbdev},</i>
252 <b>--device</b> <i>{fbdev}</i></p>
253
254 <p style="margin-left:22%;">Framebuffer device to use.
255 Default is the one your vc is mapped to (as in fbi).</p>
256
257
258 <p style="margin-left:11%;"><b>--dump-reference-help[=man]</b></p>
259
260 <p style="margin-left:22%;">Dump to stdout language
261 reference help and quit.</p>
262
263
264 <p style="margin-left:11%;"><b>--dump-default-fimrc</b></p>
265
266 <p style="margin-left:22%;">Dump default configuration (the
267 one hardcoded in the fim executable) to standard output and
268 quit.</p>
269
270 <p style="margin-left:11%;"><b>-E</b> <i>{scriptfile},</i>
271 <b>--execute-script</b> <i>{scriptfile}</i></p>
272
273 <p style="margin-left:22%;">Execute <i>{scriptfile}</i>
274 after the default initialization file is read, and before
275 executing <b>--execute-commands</b> commands.</p>
276
277 <p style="margin-left:11%;"><b>-f</b> <i>{fimrc},</i>
278 <b>--etc-fimrc</b> <i>{fimrc}</i></p>
279
280 <p style="margin-left:22%;">Specify an alternative
281 system-wide initialization file (default:
282 /usr/local/etc/fimrc), to be read prior to any other
283 configuration file. See also <b>--no-etc-fimrc-file</b>.</p>
284
285 <p style="margin-left:11%;"><b>-F</b> <i>{commands},</i>
286 <b>--final-commands</b> <i>{commands}</i></p>
287
288 <p style="margin-left:22%;">Similar to the
289 <b>--execute-commands</b> option, but execute
290 <i>{commands}</i> after exiting the interactive mode, just
291 before terminating the program.</p>
292
293 <p style="margin-left:11%;"><b>-h[s|d|l|m]</b>,
294 <b>--help[=s|d|l|m]</b></p>
295
296 <p style="margin-left:22%;">Print program invocation help,
297 and exit. Depending on the option, output can be: short,
298 descriptive, long from man, or complete man. For each
299 further argument <i>{help-item}</i> passed to <b>fim</b>, an
300 individual help message is shown. If <i>{help-item}</i>
301 starts with a /, it is treated as a search string (not a
302 regexp, though).</p>
303
304 <p style="margin-left:11%;"><b>-k</b> <i>{keysym},</i>
305 <b>--keysym-press</b> <i>{keysym}</i></p>
306
307 <p style="margin-left:22%;">Execute any command bound (via
308 the bind command) to a specified keysym at startup. A keysym
309 can be prefixed by a repetition count number. You can
310 specify the option multiple times to simulate multiple
311 keystrokes. Presses entered via <b>--keysym-press</b> are
312 processed with the same priority as those entered via
313 <b>--chars-press</b>, that is, as they appear. See man
314 <i>fimrc</i>(5) for a list of keysyms and the use of
315 bind.</p>
316
317 <p style="margin-left:11%;"><b>-K</b> <i>{chars},</i>
318 <b>--chars-press</b> <i>{chars}</i></p>
319
320 <p style="margin-left:22%;">Input one or more keyboard
321 characters at program startup (simulate keyboard presses).
322 This option can be specified multiple times. Each additional
323 time (or if the string is empty), a press of Enter (ASCII
324 code 0x0D) key is prepended. Examples: -K &rsquo;&rsquo;
325 simulates press of an Enter; -K &rsquo;:next;&rsquo;
326 activates the command line and enter &quot;next;&quot;
327 without executing it; -K &quot;:next;&quot; -K
328 &quot;next&quot; executes &quot;next&quot;, stays in the
329 command line and enter keys &quot;next&quot;; -K
330 &quot;:next;&quot; -K &quot;&quot; -K &quot;next&quot;
331 executes &quot;next&quot;, leaves the command line, and
332 executes in sequence any command bound to keys
333 &rsquo;n&rsquo;, &rsquo;e&rsquo;, &rsquo;x&rsquo;,
334 &rsquo;t&rsquo;. Presses entered via <b>--chars-press</b>
335 are processed with the same priority as those entered via
336 <b>--keysym-press</b>, that is, as they appear.</p>
337
338 <p style="margin-left:11%;"><b>-D</b> <i>{filename},</i>
339 <b>--load-image-descriptions-file</b> <i>{filename}</i></p>
340
341 <p style="margin-left:22%;">Load image descriptions from
342 file <i>{filename}</i>. Each line begins with the basename
343 of an image file, followed by a Tab character (or a
344 different character if specified via
345 <b>--image-descriptions-file-separator</b>), then the
346 description text. The description text is copied into the
347 <b>i:_comment</b> variable of the image at load time,
348 overriding the comment possibly loaded from the file (e.g.
349 JPEG, PNG or TIFF comment). If a &rsquo;@&rsquo; followed by
350 an identifier <i>{identifier}</i> is encountered, and
351 i:<i>{var}</i> is set, its value is substituted here. If
352 &quot;@#&quot; is encountered, the remainder of the
353 description line is ignored. Special comment lines like
354 &quot;#!fim:<i>{var}</i>=<i>{val}</i>&quot; lead
355 i:<i>{var}</i> to be assigned value <i>{val}</i> (unquoted)
356 at image loading time (cached variable), unless <i>{var}</i>
357 starts with an underscore (&rsquo;_&rsquo;). Special comment
358 lines like &quot;#!fim:@<i>{var}</i>=<i>{val}</i>&quot;
359 create a variable <i>{var}</i> that are only valid in
360 expanding @<i>{var}</i> in comments. Special comment lines
361 like &quot;#!fim:<i>{var}</i>@=<i>{val}</i>&quot; or
362 &quot;#!fim:@<i>{var}</i>@=<i>{val}</i> (notice @ before =)
363 also expand whatever @<i>{identifier}</i> encountered in
364 <i>{val}</i> . Special comment lines like
365 &quot;#!fim:+=<i>{val}</i>&quot; add <i>{val}</i> to current
366 description. Special comment lines like
367 &quot;#!fim:^=<i>{val}</i>&quot; set <i>{val}</i> to be the
368 base of each description. Special comment lines like
369 &quot;#!fim:!=&quot; reset all cached variables. Special
370 comment lines like &quot;#!fim:/=<i>{dir}</i>&quot; prepend
371 <i>{dir}</i> to each file&rsquo;s basename. Special comment
372 lines like &quot;#!fim:\=<i>{dir}</i>&quot; prepend
373 <i>{dir}</i> to each file&rsquo;s name. Special description
374 text (to be associated to an image) begins with markers:
375 with &quot;#!fim:=&quot;, the last description line is
376 reused; with &quot;#!fim:+&quot;, what follows is appended
377 to the last description line; with &quot;#!fim:^&quot;, what
378 follows is prepended to the last description line; with
379 &quot;#!fim:s/<i>{f}</i>/<i>{t}</i>&quot;, the last
380 description line is used and substituted substring
381 <i>{t}</i> to occurrences of substring <i>{f}</i>
382 (<i>{f}</i> and <i>{t}</i> cannot contain newlines or a
383 &rsquo;/&rsquo;). If <i>{val}</i> is empty that variable is
384 unset. These variables are stored also in an internal index
385 used by the limit command. This option sets
386 <b>_caption_over_image</b>=2, so that a caption is displayed
387 over the image. A description file beginning with
388 &quot;#!fim:desc&quot; can be loaded without specifying this
389 switch.</p>
390
391 <p style="margin-left:11%;"><b>-S</b> <i>{sepchar},</i>
392 <b>--image-descriptions-file-separator</b>
393 <i>{sepchar}</i></p>
394
395 <p style="margin-left:22%;">A character to be used as a
396 separator between the filename and the description part of
397 lines specified just before a
398 --load-image-descriptions-file.</p>
399
400 <p style="margin-left:11%;"><b>-i</b>,
401 <b>--image-from-stdin</b></p>
402
403 <p style="margin-left:22%;">Read one single image from the
404 standard input (the image data, not the filename). May not
405 work with all supported file formats. In the image list,
406 this image takes the special name
407 &quot;&lt;STDIN&gt;&quot;.</p>
408
409
410 <p style="margin-left:11%;"><b>--mark-from-image-descriptions-file</b>
411 <i>{filename}</i></p>
412
413 <p style="margin-left:22%;">Set those files specified in
414 <i>{filename}</i> (see --load-image-descriptions-file for
415 the file format) as marked (see the list command).</p>
416
417 <p style="margin-left:11%;"><b>-m</b> <i>{vmode},</i>
418 <b>--mode</b> <i>{vmode}</i></p>
419
420 <p style="margin-left:22%;">Name of the video mode to use
421 video mode (must be listed in /etc/fb.modes). Default is not
422 to change the video mode. In the past, the XF86 config file
423 (/etc/X11/XF86Config) used to contain Modeline information,
424 which could be fed to the modeline2fb perl script
425 (distributed with fbset). On many modern xorg based systems,
426 there is no direct way to obtain a fb.modes file from the
427 xorg.conf file. So instead one could obtain useful fb.modes
428 info by using the (fbmodes (no man page AFAIK)) tool,
429 written by bisqwit. An unsupported mode should make fim exit
430 with failure. But it is possible the kernel could trick fim
431 and set a supported mode automatically, thus ignoring the
432 user set mode.</p>
433
434 <p style="margin-left:11%;"><b>-N</b>,
435 <b>--no-rc-file</b></p>
436
437 <p style="margin-left:22%;">No personal initialization file
438 is read (default is ~/.fimrc) at startup.</p>
439
440 <p style="margin-left:11%;"><b>--no-etc-fimrc-file</b></p>
441
442 <p style="margin-left:22%;">No system-wide initialization
443 file is read (default is /usr/local/etc/fimrc) at startup.
444 See also <b>--etc-fimrc</b>.</p>
445
446
447 <p style="margin-left:11%;"><b>--no-internal-config</b></p>
448
449 <p style="margin-left:22%;">No internal default
450 configuration at startup (uses internal variable
451 <b>_no_default_configuration</b>). Will only provide a
452 minimal working configuration.</p>
453
454 <p style="margin-left:11%;"><b>--no-commandline</b></p>
455
456 <p style="margin-left:22%;">With internal command line mode
457 disabled.</p>
458
459 <p style="margin-left:11%;"><b>--no-history-save</b></p>
460
461 <p style="margin-left:22%;">Do not save execution history
462 at finalization (uses internal variable
463 <b>_save_fim_history</b>).</p>
464
465 <p style="margin-left:11%;"><b>--no-history-load</b></p>
466
467 <p style="margin-left:22%;">Do not load execution history
468 at startup.</p>
469
470 <p style="margin-left:11%;"><b>--no-history</b></p>
471
472 <p style="margin-left:22%;">Do not load or save execution
473 history at startup.</p>
474
475 <p style="margin-left:11%;"><b>-p</b>,
476 <b>--script-from-stdin</b></p>
477
478 <p style="margin-left:22%;">Read commands from stdin before
479 entering in interactive mode.</p>
480
481 <p style="margin-left:11%;"><b>-o
482 [fb|sdl|gtk|ca|aa|dumb][=</b><i>{gfxopts}</i>]<i>,</i>
483 <b>--output-device <br>
484 [fb|sdl|gtk|ca|aa|dumb][=</b><i>{gfxopts}</i>]</p>
485
486 <p style="margin-left:22%;">Use the specified <b>device</b>
487 (one among fb|sdl|gtk|ca|aa|dumb) as fim video output
488 device, overriding automatic checks. If the <b>device</b> is
489 empty and followed by <i>{gfxopts}</i>, it will be selected
490 automatically. The available devices depend on the current
491 environment and on the configuration and compilation
492 options. You can get the list of available output devices
493 issuing <b>fim --version</b>. The possible values to
494 <i>{gfxopts}</i> that we describe here can also be passed as
495 &quot;display &rsquo;reinit&rsquo; <i>{gfxopts}</i>&quot; --
496 see man <i>fimrc</i> for this. The device name with options
497 (perhaps with modifications due to auto-detection) is stored
498 in variable <b>_device_string</b>. The <b>fb</b> option
499 selects the Linux framebuffer. Presence of <i>{gfxopts}</i>
500 with value <b>&rsquo;S&rsquo;</b> (e.g.
501 &rsquo;<b>fb=S</b>&rsquo;) makes framebuffer initialization
502 more picky: it does not tolerate running in a screen
503 session. The <b>ca</b> option (coloured ASCII-art) can be
504 specified as
505 <b>ca[={[&rsquo;w&rsquo;][&rsquo;h&rsquo;][&rsquo;H&rsquo;][&rsquo;d:&rsquo;DITHERMODE]}]</b>
506 ; if supplied, <b>&rsquo;w&rsquo;</b> selects windowed mode,
507 provided libcaca is running under X; by default (or with
508 <b>&rsquo;W&rsquo;</b>), windowed mode is being turned off
509 internally during initialization by unsetting the DISPLAY
510 environment variable. If <b>&rsquo;d:&rsquo;</b> is present,
511 the <b>DITHERMODE</b> following it will be passed as dither
512 algorithm string (alternatively, it can be a non-negative
513 number, too). The <b>aa</b> (monochrome ASCII-art) option
514 can be specified as
515 <b>aa[={[&rsquo;w&rsquo;|&rsquo;W&rsquo;]}]</b>; if
516 supplied, <b>&rsquo;w&rsquo;</b> selects windowed mode,
517 provided aalib is running under X; by default (or with
518 <b>&rsquo;W&rsquo;</b>), windowed mode is being turned off
519 internally during initialization by unsetting the DISPLAY
520 environment variable. Please note that the readline
521 (internal command line) functionality in <b>ca</b> and
522 <b>aa</b> modes is limited. If the graphical windowed mode
523 is <b>sdl</b> or <b>gtk</b> it can be followed by
524 <b>={[&rsquo;w&rsquo;][&rsquo;m&rsquo;][&rsquo;r&rsquo;][&rsquo;h&rsquo;][&rsquo;W&rsquo;][&rsquo;M&rsquo;][&rsquo;R&rsquo;][&rsquo;H&rsquo;][width[:height]][&rsquo;%&rsquo;]}</b>,
525 where <b>width</b> and <b>height</b> are integer numbers
526 specifying the desired resolution (if <b>height</b> not
527 specified, it takes the value of <b>width</b>); the
528 <b>&rsquo;w&rsquo;</b> character requests windowed mode
529 (instead of <b>&rsquo;W&rsquo;</b> for fullscreen); the
530 <b>&rsquo;m&rsquo;</b> character requests mouse pointer
531 display; the <b>&rsquo;h&rsquo;</b> character requests help
532 grid map draw (can be repeated for variants); the
533 <b>&rsquo;r&rsquo;</b> character requests support for window
534 resize; the <b>&rsquo;%&rsquo;</b> character requests to
535 treat <b>width</b> and <b>height</b> as percentage of
536 possible window resolution. The same letters uppercase
537 request explicit negation of the mentioned features.
538 Additionally, in <b>gtk</b> mode: <b>&rsquo;b&rsquo;</b>
539 hides the menu bar, <b>&rsquo;e&rsquo;</b> starts with empty
540 menus, <b>&rsquo;f&rsquo;</b> rebuilds the menus, and
541 <b>&rsquo;D&rsquo;</b> removes the menus. <b>Note</b>: the
542 <b>gtk</b> mode is a recent addition and may have defects.
543 The <b>sdl</b> mode works best with libsdl-2; libsdl-1.2
544 support is being discontinued. <br>
545 The <b>imlib2</b> option requests imlib2 and is unfinished:
546 do not use it. <br>
547 The <b>dumb</b> test mode is there only for test purposes
548 and is not interactive.</p>
549
550 <p style="margin-left:11%;"><b>--offset</b>
551 <i>{bytes-offset[{:upper-offset}|{+offset-range}]}</i></p>
552
553 <p style="margin-left:22%;">Use the specified <i>offset</i>
554 (in bytes) for opening the specified files. If
555 <i>:upper-offset</i> is specified, further bytes until
556 <i>upper-offset</i> are probed. If <i>+offset-range</i> is
557 specified instead, that many additional bytes are to be
558 probed. Use this option to search damaged file systems for
559 image files. Appending a modifier among
560 &rsquo;K&rsquo;,&rsquo;M&rsquo;,&rsquo;G&rsquo; (case
561 irrelevant) to an offset number changes the unit to be
562 respectively 2^10, 2^20, or 2^30 bytes.</p>
563
564 <p style="margin-left:11%;"><b>--pread-cmd</b>
565 <i>{cmd-filter-pipeline}</i></p>
566
567 <p style="margin-left:22%;">Specify a shell command with
568 <i>{cmd-filter-pipeline}</i>. If the current filename
569 matches &quot;^[/A-Za-z0-9_.][/A-Za-z0-9_.-]*$&quot;, it is
570 be substituted to any occurrence of &rsquo;{}&rsquo;. The
571 resulting command output is assumed to be file data, which
572 is read, decoded, and displayed. This works by setting the
573 internal <b>_pread_cmd</b> variable (empty by default).</p>
574
575 <p style="margin-left:11%;"><b>-P</b>,
576 <b>--text-reading</b></p>
577
578 <p style="margin-left:22%;">Enable textreading mode. This
579 has the effect that fim displays images scaled to the width
580 of the screen, and aligned to the top. If the images you are
581 watching are text pages, all you have to do to get the next
582 piece of text is to press space (in the default key
583 configuration, of course).</p>
584
585 <p style="margin-left:11%;"><b>-s</b> <i>{value},</i>
586 <b>--scroll</b> <i>{value}</i></p>
587
588 <p style="margin-left:22%;">Set scroll steps for internal
589 variable <b>_steps</b> (default is &quot;20%&quot;).</p>
590
591 <p style="margin-left:11%;"><b>--slideshow</b>
592 <i>{number}</i></p>
593
594 <p style="margin-left:22%;">Interruptible slideshow mode.
595 Wait for <i>{number}</i> of seconds (can have a decimal
596 part, and is assigned to the _slideshow_sleep_time variable)
597 after each image. Implemented by executing reload;
598 i:fresh=1; while(_fileindex &lt;=
599 _filelistlen-_loop_only_once){sleep _slideshow_sleep_time;
600 next;} _loop_only_once=0; sleep _slideshow_sleep_time; as a
601 first command. Can be interrupted by : or Esc. The other
602 keys execute accordingly to their function but do not
603 interrupt the slideshow. Like in fbi, this cycles forever,
604 unless <b>--once</b> is specified.</p>
605
606 <p style="margin-left:11%;"><b>--sanity-check</b></p>
607
608 <p style="margin-left:22%;">Perform a quick sanity check,
609 just after the initialization, and terminate.</p>
610
611 <p style="margin-left:11%;"><b>-t</b>,
612 <b>--no-framebuffer</b></p>
613
614 <p style="margin-left:22%;"><b>fim</b> Use an ASCII Art
615 driver. If present, use either of libcaca (coloured), or
616 aalib (monochrome). For more, see (man fimrc), (info aalib)
617 or (apropos caca)). If no ASCII Art driver had been enabled
618 at compile time, fim does not display any image at all.</p>
619
620 <p style="margin-left:11%;"><b>-T</b> <i>{terminal},</i>
621 <b>--vt</b> <i>{terminal}</i></p>
622
623 <p style="margin-left:22%;">The <i>{terminal}</i> is to be
624 used as virtual terminal device file (as in fbi). See (chvt
625 (1)), (openvt (1)) for more info about this. Use (con2fb
626 (1)) to map a terminal to a framebuffer device.</p>
627
628 <p style="margin-left:11%;"><b>--reverse</b></p>
629
630 <p style="margin-left:22%;">Reverse files list before
631 browsing (can be combined with the other sorting
632 options).</p>
633
634 <table width="100%" border="0" rules="none" frame="void"
635 cellspacing="0" cellpadding="0">
636 <tr valign="top" align="left">
637 <td width="11%"></td>
638 <td width="9%">
639
640
641 <p><b>--sort</b></p></td>
642 <td width="2%"></td>
643 <td width="78%">
644
645
646 <p>Sort files list before browsing according to full
647 filename.</p> </td></tr>
648 </table>
649
650 <p style="margin-left:11%;"><b>--sort-basename</b></p>
651
652 <p style="margin-left:22%;">Sort files list before browsing
653 according to file basename&rsquo;s.</p>
654
655 <p style="margin-left:11%;"><b>--sort-mtime</b></p>
656
657 <p style="margin-left:22%;">Sort files list before browsing
658 according to file modification time.</p>
659
660 <p style="margin-left:11%;"><b>--sort-fsize</b></p>
661
662 <p style="margin-left:22%;">Sort files list before browsing
663 according to file size.</p>
664
665 <p style="margin-left:11%;"><b>-u</b>, <b>--random</b></p>
666
667 <p style="margin-left:22%;">Randomly shuffle the files list
668 before browsing (seed depending on time() function).</p>
669
670 <p style="margin-left:11%;"><b>--random-no-seed</b></p>
671
672 <p style="margin-left:22%;">Pseudo-random shuffle the files
673 list before browsing (no seeding).</p>
674
675 <p style="margin-left:11%;"><b>-v</b>, <b>--verbose</b></p>
676
677 <p style="margin-left:22%;">Be verbose: show status
678 bar.</p>
679
680 <p style="margin-left:11%;"><b>--verbose-load</b></p>
681
682 <p style="margin-left:22%;">Load files verbosely (repeat
683 option to increase verbosity).</p>
684
685 <p style="margin-left:11%;"><b>--verbose-font-load</b></p>
686
687 <p style="margin-left:22%;">Load font verbosely (sets
688 <b>_fbfont_verbosity</b>).</p>
689
690
691 <p style="margin-left:11%;"><b>--verbose-interpreter</b></p>
692
693 <p style="margin-left:22%;">Execute interpreter verbosely
694 (Sets immediately <b>_debug_commands</b>=&quot;ackCm&quot;
695 if specified once,
696 <b>_debug_commands</b>=&quot;ackCmmi&quot; if specified
697 twice).</p>
698
699 <p style="margin-left:11%;"><b>-V</b>, <b>--version</b></p>
700
701 <p style="margin-left:22%;">Print to stdout program
702 version, compile flags, enabled features, linked libraries
703 information, supported filetypes/file loaders, and then
704 exit.</p>
705
706 <p style="margin-left:11%;"><b>-w</b>,
707 <b>--autowidth</b></p>
708
709 <p style="margin-left:22%;">Scale the image according to
710 the screen width.</p>
711
712 <p style="margin-left:11%;"><b>-=</b>,
713 <b>--no-auto-scale</b></p>
714
715 <p style="margin-left:22%;">Do not scale the images after
716 loading (sets &rsquo;<b>_scale_style</b>=&quot;
717 &quot;&rsquo;;).</p>
718
719 <p style="margin-left:11%;"><b>--autowindow</b></p>
720
721 <p style="margin-left:22%;">Resize the window size (if
722 supported by the video mode) to the image size. Don&rsquo;t
723 use this with other image scaling options.</p>
724
725 <p style="margin-left:11%;"><b>--no-stat-push</b></p>
726
727 <p style="margin-left:22%;">Sets <b>_push_checks</b>=0
728 before initialization, thus disabling file/dir existence
729 checks with stat(2) at push push time (and speeding up
730 startup).</p>
731
732 <p style="margin-left:11%;"><b>-H</b>,
733 <b>--autoheight</b></p>
734
735 <p style="margin-left:22%;">Scale the image according to
736 the screen height.</p>
737
738 <p style="margin-left:11%;"><b>-W</b> <i>{scriptfile},</i>
739 <b>--write-scriptout</b> <i>{scriptfile}</i></p>
740
741 <p style="margin-left:22%;">All the characters that you
742 type are recorded in the file <i>{scriptfile}</i>, until you
743 exit <b>fim</b>. This is useful if you want to create a
744 script file to be used with &quot;fim -c&quot; or
745 &quot;:exec&quot; (analogous to Vim&rsquo;s -s and
746 &quot;:source!&quot;). If the <i>{scriptfile}</i> file
747 exists, it is not touched (as in Vim&rsquo;s -w).</p>
748
749 <p style="margin-left:11%;"><b>-L</b>
750 <i>{fileslistfile},</i> <b>--read-from-file</b>
751 <i>{fileslistfile}</i></p>
752
753 <p style="margin-left:22%;">Read file list from a file:
754 each line one file to load (similar to
755 <b>--read-from-stdin</b>; use <b>--read-from-stdin-elds</b>
756 to control line breaking).</p>
757
758 <p style="margin-left:11%;"><b>-, --read-from-stdin</b></p>
759
760 <p style="margin-left:22%;">Read file list from stdin: each
761 line one file to load; use with --read-from-stdin-elds to
762 control line breaking).</p>
763
764 <p style="margin-left:22%; margin-top: 1em">Note that these
765 three standard input reading functionalities (-i,-p and -)
766 conflict : if two or more of them occur in fim invocation,
767 fim exits with an error and warn about the ambiguity.</p>
768
769 <p style="margin-left:22%; margin-top: 1em">See the section
770 <b>INVOCATION EXAMPLES</b> below to read some useful (and
771 unique) ways of employing fim.</p>
772
773 <p style="margin-left:11%;"><b>--read-from-stdin-elds</b>
774 <i>{delimiter-char}</i></p>
775
776 <p style="margin-left:22%;">Specify an endline delimiter
777 character for breaking lines read via
778 -/--read-from-stdin/--read-from-file (which shall be
779 specified after this). Line text before the delimiter are be
780 treated as names of files to load; the text after is
781 ignored. This is also useful e.g. to load description files
782 (see --load-image-descriptions-file) as filename list files.
783 Default is the newline character (0x0A); to specify an ASCII
784 NUL byte (0x00) use &rsquo;&rsquo;.</p>
785
786 <p style="margin-left:11%;"><b>-A</b>, <b>--autotop</b></p>
787
788 <p style="margin-left:22%;">Align images to the top border
789 (by setting &rsquo;<b>_autotop</b>=1&rsquo; after
790 initialization).</p>
791
792 <p style="margin-left:11%;"><b>-q</b>, <b>--quiet</b></p>
793
794 <p style="margin-left:22%;">Quiet execution mode. Sets
795 _display_status=0;_display_busy=0;.</p>
796
797 <p style="margin-left:11%;"><b>-r</b>
798 <i>{{width:height}|&rsquo;fullscreen&rsquo;},</i>
799 <b>--resolution</b> <i><br>
800 {{width:height}|&rsquo;fullscreen&rsquo;}</i></p>
801
802 <p style="margin-left:22%;">Set resolution specification in
803 pixels dimensions. Supported only by GTK and SDL. Will be
804 appended to the argument to --output-device. Shorthand value
805 &rsquo;fullscreen&rsquo; is translated as
806 &rsquo;W&rsquo;.</p>
807
808
809 <p style="margin-left:11%;"><b>-R[</b><i>{exp}</i>]<i>,</i>
810 <b>--recursive[=</b><i>{exp}</i>]</p>
811
812 <p style="margin-left:22%;">Push files/directories to the
813 files list recursively. The expression in variable
814 <b>_pushdir_re</b> (default:
815 &quot;.(JPG|PNG|GIF|BMP|TIFF|TIF|JPEG|JFIF|PPM|PGM|PBM|PCX|QOI|AVIF|WEBP)$&quot;)
816 lists extensions of filenames which are loaded in the list.
817 You can overwrite its value by optionally passing an
818 expression <i>{exp}</i> here as argument. If starting with
819 &rsquo;+&rsquo; or &rsquo;|&rsquo;, the expression following
820 is to be appended to it.</p>
821
822 <p style="margin-left:11%;"><b>-X</b>,
823 <b>--no-pipe-load</b></p>
824
825 <p style="margin-left:22%;">Do not load via external
826 converter programs: only use built-in file decoders.</p>
827
828 <p style="margin-left:11%;"><b>-B</b>,
829 <b>--background-recursive</b></p>
830
831 <p style="margin-left:22%;">Push files/directories to the
832 files list recursively, in background during program
833 execution. Any sorting options are ignored. Experimental
834 feature, unfinished.</p>
835
836 <p style="margin-left:11%;"><b>--load-shadow-directory</b>
837 <i>{dirname}</i></p>
838
839 <p style="margin-left:22%;">Add <i>{dirname}</i> to the
840 shadow directory list. Then &rsquo;scale
841 &quot;shadow&quot;&rsquo; temporarily substitutes the image
842 being displayed with that of the first same-named file
843 located under a shadow directory. Useful to browse low-res
844 images, but still being able to quickly view the hi-res
845 original residing in a shadow directory. This works as
846 intended as long as unique filenames are involved.</p>
847
848 <p style="margin-left:11%;"><b>-/</b> <i>{pattern},</i>
849 <b>--/</b> <i>{pattern}</i></p>
850
851 <p style="margin-left:22%;">After startup jump to pattern;
852 short for -c &rsquo;/&rsquo; <i>{pattern}</i>.</p>
853
854 <p style="margin-left:11%;"><b>--//</b>
855 <i>{pattern}</i></p>
856
857 <p style="margin-left:22%;">After startup jump to pattern;
858 as -c &rsquo;/&rsquo;<i>{pattern}</i> but with search on the
859 full path (with <b>_re_search_opts=&quot;f&quot;</b>).</p>
860
861 <p style="margin-left:11%;"><b>-1</b>, <b>--once</b></p>
862
863 <p style="margin-left:22%;">If running --slideshow, loop
864 only once (as in fbi).</p>
865
866 <h2>PROGRAM RETURN STATUS
867 <a name="PROGRAM RETURN STATUS"></a>
868 </h2>
869
870
871 <p style="margin-left:11%; margin-top: 1em">The program
872 return status is 0 on correct operation; 252 on unsupported
873 device specification; 248 on bad input; 255 on a generic
874 error; 42 on a signal-triggered program exit; or a different
875 value in case of an another error. <br>
876 The return status may be controlled by the use of the quit
877 command.</p>
878
879 <h2>COMMON KEYS AND COMMANDS
880 <a name="COMMON KEYS AND COMMANDS"></a>
881 </h2>
882
883
884 <p style="margin-left:11%; margin-top: 1em">The following
885 keys and commands are default hardcoded in the minimal
886 configuration. These are working by default before any
887 configuration file loading, and before the hardcoded config
888 loading (see variable
889 <b>_fim_default_config_file_contents</b>).</p>
890
891 <p style="margin-left:11%; margin-top: 1em">n goto
892 &rsquo;+1f&rsquo; <br>
893 p goto &rsquo;-1f&rsquo; <br>
894 + scale &rsquo;+&rsquo; <br>
895 - scale &rsquo;-&rsquo; <br>
896 h pan &rsquo;left&rsquo; <br>
897 l pan &rsquo;right&rsquo; <br>
898 k pan &rsquo;up-&rsquo; <br>
899 j pan &rsquo;down+&rsquo; <br>
900 q quit <br>
901 You can type a number before a command binding to iterate
902 the assigned command: <br>
903 3k 3pan &rsquo;up-&rsquo;</p>
904
905 <p style="margin-left:11%; margin-top: 1em">: enter command
906 line mode (here one can use readline bindings as C-r, C-s,
907 M-b, M-f, ...) <br>
908 :<i>{number}</i> jump to <i>{number}</i>^th image in the
909 list</p>
910
911 <table width="100%" border="0" rules="none" frame="void"
912 cellspacing="0" cellpadding="0">
913 <tr valign="top" align="left">
914 <td width="11%"></td>
915 <td width="-3%"></td>
916 <td width="7%">
917
918
919 <p>:^</p></td>
920 <td width="85%">
921
922
923 <p>jump to first image in the list</p></td></tr>
924 <tr valign="top" align="left">
925 <td width="11%"></td>
926 <td width="-3%"></td>
927 <td width="7%">
928
929
930 <p>:$</p></td>
931 <td width="85%">
932
933
934 <p>jump to last image in the list</p></td></tr>
935 </table>
936
937 <p style="margin-left:11%;">:*<i>{factor}</i> scale the
938 image by <i>{factor}</i> <br>
939 :<i>{scale}</i>% scale the image to the desired
940 <i>{scale}</i> <br>
941 :+<i>{scale}</i>% scale the image up to the desired
942 percentage <i>{scale}</i> (relatively to the original) <br>
943 :-<i>{scale}</i>% scale the image down to the desired
944 percentage <i>{scale}</i> (relatively to the original)</p>
945
946 <table width="100%" border="0" rules="none" frame="void"
947 cellspacing="0" cellpadding="0">
948 <tr valign="top" align="left">
949 <td width="11%"></td>
950 <td width="-3%"></td>
951 <td width="7%">
952
953
954 <p>/<i>{regexp}</i></p></td>
955 <td width="8%"></td>
956 <td width="8%">
957 </td>
958 <td width="7%">
959
960
961 <p>entering the pattern <i>{regexp}</i> (with
962 &rsquo;/&rsquo;) makes fim jump to the next image whose
963 filename matches <i>{regexp}</i></p></td>
964 <td width="62%">
965 </td></tr>
966 <tr valign="top" align="left">
967 <td width="11%"></td>
968 <td width="-3%"></td>
969 <td width="7%">
970
971
972 <p>/*.png$</p></td>
973 <td width="8%"></td>
974 <td width="8%">
975 </td>
976 <td width="7%">
977
978
979 <p>entering this pattern (with &rsquo;/&rsquo;) makes fim
980 jump to the next image whose filename ends with
981 &rsquo;png&rsquo;</p> </td>
982 <td width="62%">
983 </td></tr>
984 <tr valign="top" align="left">
985 <td width="11%"></td>
986 <td width="-3%"></td>
987 <td width="7%">
988
989
990 <p>/png</p></td>
991 <td width="8%">
992 </td>
993 <td width="8%">
994
995
996 <p>a shortcut for &rsquo;/.*png.*&rsquo;</p></td>
997 <td width="7%"></td>
998 <td width="62%">
999 </td></tr>
1000 <tr valign="top" align="left">
1001 <td width="11%"></td>
1002 <td width="-3%"></td>
1003 <td width="7%">
1004
1005
1006 <p>2,4 stdout &rsquo;{}&rsquo;</p></td>
1007 <td width="8%"></td>
1008 <td width="8%"></td>
1009 <td width="7%"></td>
1010 <td width="62%">
1011
1012
1013 <p>print three filenames to standard output.</p></td></tr>
1014 <tr valign="top" align="left">
1015 <td width="11%"></td>
1016 <td width="-3%"></td>
1017 <td width="7%">
1018
1019
1020 <p>!<i>{syscmd}</i></p></td>
1021 <td width="8%"></td>
1022 <td width="8%">
1023 </td>
1024 <td width="7%">
1025
1026
1027 <p>executes the <i>{syscmd}</i> quoted string as an
1028 argument to the &quot;system&quot; fim command.</p></td>
1029 <td width="62%">
1030 </td></tr>
1031 </table>
1032
1033 <p style="margin-left:11%; margin-top: 1em">You can
1034 visualize all of the default bindings invoking fim
1035 --dump-default-fimrc | grep bind . <br>
1036 You can visualize all of the default aliases invoking fim
1037 --dump-default-fimrc | grep alias .</p>
1038
1039 <p style="margin-left:11%; margin-top: 1em">The Return vs.
1040 Space key thing can be used to create a file list while
1041 reviewing the images and use the list for batch processing
1042 later on.</p>
1043
1044 <p style="margin-left:11%; margin-top: 1em">All of the key
1045 bindings are reconfigurable; see the default <b>fimrc</b>
1046 file for examples on this, or read the complete manual: the
1047 FIM.TXT file distributed with fim.</p>
1048
1049 <h2>AFFECTING ENVIRONMENT VARIABLES
1050 <a name="AFFECTING ENVIRONMENT VARIABLES"></a>
1051 </h2>
1052
1053
1054 <table width="100%" border="0" rules="none" frame="void"
1055 cellspacing="0" cellpadding="0">
1056 <tr valign="top" align="left">
1057 <td width="11%"></td>
1058 <td width="-3%">
1059
1060
1061 <p>FBFONT</p></td>
1062 <td width="7%"></td>
1063 <td width="8%"></td>
1064 <td width="8%">
1065 </td>
1066 <td width="69%">
1067
1068
1069 <p>(just like in fbi) a Linux consolefont font file.</p></td></tr>
1070 </table>
1071
1072 <p style="margin-left:11%;">If using a gzipped font file,
1073 the zcat program is used to uncompress it (via
1074 <b>execvp(3)</b>). <br>
1075 If FBFONT is unset, the following files are probed and the
1076 first existing one is selected:</p>
1077
1078
1079 <p style="margin-left:11%; margin-top: 1em">/usr/share/kbd/consolefonts/cp866-8x16.psf.gz
1080 <br>
1081 /usr/share/consolefonts/Uni3-TerminusBoldVGA14.psf.gz <br>
1082 /usr/lib/kbd/consolefonts/lat9-16.psf.gz <br>
1083 /usr/share/consolefonts/lat1-16.psf <br>
1084 /usr/share/consolefonts/lat1-16.psf.gz <br>
1085 /usr/share/consolefonts/lat1-16.psfu.gz <br>
1086 /usr/share/kbd/consolefonts/lat1-16.psf <br>
1087 /usr/share/kbd/consolefonts/lat1-16.psf.gz <br>
1088 /usr/share/kbd/consolefonts/lat1-16.psfu.gz <br>
1089 /usr/lib/kbd/consolefonts/lat1-16.psf <br>
1090 /usr/lib/kbd/consolefonts/lat1-16.psf.gz <br>
1091 /usr/lib/kbd/consolefonts/lat1-16.psfu.gz <br>
1092 /lib/kbd/consolefonts/lat1-16.psf <br>
1093 /lib/kbd/consolefonts/lat1-16.psf.gz <br>
1094 /lib/kbd/consolefonts/lat1-16.psfu.gz <br>
1095 /lib/kbd/consolefonts/Lat2-VGA14.psf.gz <br>
1096 /lib/kbd/consolefonts/Lat2-VGA16.psf.gz <br>
1097 /lib/kbd/consolefonts/Lat2-VGA8.psf.gz <br>
1098 /lib/kbd/consolefonts/Uni2-VGA16.psf.gz <br>
1099 /usr/share/consolefonts/default8x16.psf.gz <br>
1100 /usr/share/consolefonts/default8x9.psf.gz <br>
1101 /usr/share/consolefonts/Lat15-Fixed16.psf.gz <br>
1102 /usr/share/consolefonts/default.psf.gz <br>
1103 fim://</p>
1104
1105 <p style="margin-left:11%; margin-top: 1em">If the special
1106 fim:// string is specified, a hardcoded font is used.</p>
1107
1108 <table width="100%" border="0" rules="none" frame="void"
1109 cellspacing="0" cellpadding="0">
1110 <tr valign="top" align="left">
1111 <td width="11%"></td>
1112 <td width="-3%">
1113
1114
1115 <p>FBGAMMA</p></td>
1116 <td width="7%"></td>
1117 <td width="8%"></td>
1118 <td width="8%">
1119 </td>
1120 <td width="69%">
1121
1122
1123 <p>(just like in fbi) gamma correction (applies to dithered
1124 8 bit mode only). Default is 1.0.</p></td></tr>
1125 <tr valign="top" align="left">
1126 <td width="11%"></td>
1127 <td width="-3%">
1128
1129
1130 <p>FRAMEBUFFER</p></td>
1131 <td width="7%"></td>
1132 <td width="8%"></td>
1133 <td width="8%"></td>
1134 <td width="69%">
1135
1136
1137 <p>(just like in fbi) user set framebuffer device file
1138 (applies only to the fb mode).</p></td></tr>
1139 </table>
1140
1141 <p style="margin-left:11%;">If unset, fim probes for
1142 /dev/fb0.</p>
1143
1144 <table width="100%" border="0" rules="none" frame="void"
1145 cellspacing="0" cellpadding="0">
1146 <tr valign="top" align="left">
1147 <td width="11%"></td>
1148 <td width="-3%"></td>
1149 <td width="7%">
1150
1151
1152 <p>TERM</p></td>
1153 <td width="8%">
1154 </td>
1155 <td width="8%">
1156
1157
1158 <p>(only in fim) influences the output device selection
1159 algorithm, especially if $TERM==&quot;screen&quot;.</p></td>
1160 <td width="7%"></td>
1161 <td width="62%">
1162 </td></tr>
1163 <tr valign="top" align="left">
1164 <td width="11%"></td>
1165 <td width="-3%"></td>
1166 <td width="7%">
1167
1168
1169 <p>SSH_TTY</p></td>
1170 <td width="8%"></td>
1171 <td width="8%">
1172
1173
1174 <p>if set and no output device specified, assume
1175 we&rsquo;re over <b>ssh</b>, and give precedence to ca, then
1176 aa (if present).</p></td>
1177 <td width="7%"></td>
1178 <td width="62%">
1179 </td></tr>
1180 <tr valign="top" align="left">
1181 <td width="11%"></td>
1182 <td width="-3%"></td>
1183 <td width="7%">
1184
1185
1186 <p>TERMUX_VERSION</p></td>
1187 <td width="8%"></td>
1188 <td width="8%"></td>
1189 <td width="7%">
1190
1191
1192 <p>if set and no output device specified, assume
1193 we&rsquo;re over <b>termux</b>, and give precedence to ca,
1194 then aa (if present).</p></td>
1195 <td width="62%">
1196 </td></tr>
1197 <tr valign="top" align="left">
1198 <td width="11%"></td>
1199 <td width="-3%"></td>
1200 <td width="7%">
1201
1202
1203 <p>WAYLAND_DISPLAY</p></td>
1204 <td width="8%"></td>
1205 <td width="8%"></td>
1206 <td width="7%"></td>
1207 <td width="62%">
1208
1209
1210 <p>if set and no output device specified, assume
1211 we&rsquo;re over <b>Wayland</b>, and give precedence to gtk,
1212 then sdl, then ca, then aa (if present).</p></td></tr>
1213 <tr valign="top" align="left">
1214 <td width="11%"></td>
1215 <td width="-3%"></td>
1216 <td width="7%">
1217
1218
1219 <p>DISPLAY</p></td>
1220 <td width="8%"></td>
1221 <td width="8%">
1222
1223
1224 <p>If this variable is set, then the gtk driver has
1225 precedence, then sdl.</p></td>
1226 <td width="7%"></td>
1227 <td width="62%">
1228 </td></tr>
1229 </table>
1230
1231 <h2>COMMON PROBLEMS
1232 <a name="COMMON PROBLEMS"></a>
1233 </h2>
1234
1235
1236 <p style="margin-left:11%; margin-top: 1em"><b>fim -o
1237 fb</b> needs read-write access to the framebuffer devices
1238 (/dev/fbN or /dev/fb/N), i.e you (our your admin) have to
1239 make sure fim can open the devices in rw mode. The IMHO most
1240 elegant way is to use pam_console (see
1241 /etc/security/console.perms) to chown the devices to the
1242 user logged in on the console. Another way is to create some
1243 group, chown the special files to that group and put the
1244 users which are allowed to use the framebuffer device into
1245 the group. You can also make the special files world
1246 writable, but be aware of the security implications this
1247 has. On a private box it might be fine to handle it this way
1248 through.</p>
1249
1250 <p style="margin-left:11%; margin-top: 1em">If using udev,
1251 you can edit: /etc/udev/permissions.d/50-udev.permissions
1252 and set these lines like here: <br>
1253 # fb devices <br>
1254 fb:root:root:0600 <br>
1255 fb[0-9]*:root:root:0600 <br>
1256 fb/*:root:root:0600</p>
1257
1258 <p style="margin-left:11%; margin-top: 1em"><b>fim -o
1259 fb</b> also needs access to the linux console (i.e.
1260 /dev/ttyN) for sane console switch handling. That is
1261 obviously no problem for console logins, but any kind of
1262 pseudo tty (xterm, ssh, screen, ...) will <b>not</b>
1263 work.</p>
1264
1265 <h2>INVOCATION EXAMPLES
1266 <a name="INVOCATION EXAMPLES"></a>
1267 </h2>
1268
1269
1270 <p style="margin-left:11%; margin-top: 1em"><b>fim --help
1271 -R -B</b> <br>
1272 # get help for options <b>-R</b> and <b>-B</b></p>
1273
1274 <p style="margin-left:11%; margin-top: 1em"><b>fim
1275 media/</b> <br>
1276 # load files from the directory <b>media/</b></p>
1277
1278 <p style="margin-left:11%; margin-top: 1em"><b>fim -R
1279 media/ --sort</b> <br>
1280 # open files found by recursive traversal of directory
1281 media, then sorting the list</p>
1282
1283 <p style="margin-left:11%; margin-top: 1em"><b>find
1284 /mnt/media/ -name *.jpg | fim -</b> <br>
1285 # read input files list from standard input</p>
1286
1287 <p style="margin-left:11%; margin-top: 1em"><b>find
1288 /mnt/media/ -name *.jpg | shuf | fim -</b> <br>
1289 # read input files list from standard input, randomly
1290 shuffled</p>
1291
1292 <p style="margin-left:11%; margin-top: 1em"><b>cat
1293 script.fim | fim -p images/*</b> <br>
1294 # read a script file <b>script.fim</b> from standard input
1295 before displaying files in the directory <b>images</b></p>
1296
1297 <p style="margin-left:11%; margin-top: 1em"><b>scanimage
1298 ... | tee scan.ppm | fim -i</b> <br>
1299 # read the image scanned from a flatbed scanner as soon as
1300 it is read</p>
1301
1302 <p style="margin-left:11%; margin-top: 1em"><b>h5topng -x 1
1303 -y 2 dataset.hdf -o /dev/stdout | fim -i</b> <br>
1304 # visualize a slice from an HDF5 dataset file</p>
1305
1306 <p style="margin-left:11%; margin-top: 1em"><b>fim * &gt;
1307 selection.txt</b> <br>
1308 # output the file names marked interactively with the
1309 &rsquo;list &quot;mark&quot;&rsquo; command in fim to a
1310 file</p>
1311
1312 <p style="margin-left:11%; margin-top: 1em"><b>fim * | fim
1313 -</b> <br>
1314 # output the file names marked with &rsquo;m&rsquo; in fim
1315 to a second instance of fim, in which these could be marked
1316 again</p>
1317
1318 <p style="margin-left:11%; margin-top: 1em"><b>fim</b> -c
1319 &rsquo;pread &quot;vgrabbj -d /dev/video0 -o
1320 png&quot;;reload&rsquo; <br>
1321 # display an image grabbed from a webcam</p>
1322
1323 <p style="margin-left:11%; margin-top: 1em"><b>fim</b> -o
1324 aa -c &rsquo;pread &quot;vgrabbj -d /dev/video0 -o
1325 png&quot;;reload;system &quot;fbgrab&quot;
1326 &quot;asciime.png&quot;&rsquo; <br>
1327 # if running in framebuffer mode, saves a png screenshot
1328 with an ASCII rendering of an image grabbed from a
1329 webcam</p>
1330
1331 <p style="margin-left:11%; margin-top: 1em"><b>fim</b> -c
1332 &rsquo;while(1){pread &quot;vgrabbj -d /dev/video0 -o
1333 png&quot;;reload;sleep 1;};&rsquo;</p>
1334
1335 <p style="margin-left:11%; margin-top: 1em"># display a
1336 sequence of images grabbed from a webcam; circa 1 per
1337 second</p>
1338
1339 <h2>NOTES
1340 <a name="NOTES"></a>
1341 </h2>
1342
1343
1344 <p style="margin-left:11%; margin-top: 1em">This manual
1345 page is neither accurate nor complete. In particular, issues
1346 related to driver selection shall be described more
1347 accurately. Also the accurate sequence of autocommands
1348 execution, variables application is critical to
1349 understanding fim, and should be documented. The filename
1350 &quot;&lt;STDIN&gt;&quot; is reserved for images read from
1351 standard input (view this as a limitation), and thus
1352 handling files with such name may incur in limitations.</p>
1353
1354 <h2>BUGS
1355 <a name="BUGS"></a>
1356 </h2>
1357
1358
1359 <p style="margin-left:11%; margin-top: 1em"><b>fim</b> has
1360 bugs. Please read the <b>BUGS</b> file shipped in the
1361 documentation directory to discover the known ones. There
1362 are also inconsistencies in the way the internal command
1363 line works across the different graphical devices.</p>
1364
1365 <h2>FILES
1366 <a name="FILES"></a>
1367 </h2>
1368
1369
1370
1371 <p style="margin-left:11%; margin-top: 1em"><b>/usr/local/share/doc/fim</b></p>
1372
1373 <p style="margin-left:34%;">The directory with <b>fim</b>
1374 documentation files.</p>
1375
1376
1377 <p style="margin-left:11%;"><b>/usr/local/etc/fimrc</b></p>
1378
1379 <p style="margin-left:34%;">The system-wide <b>fim</b>
1380 initialization file (executed at startup, after executing
1381 the hardcoded configuration).</p>
1382
1383 <table width="100%" border="0" rules="none" frame="void"
1384 cellspacing="0" cellpadding="0">
1385 <tr valign="top" align="left">
1386 <td width="11%"></td>
1387 <td width="21%">
1388
1389
1390 <p><b>~/.fimrc</b></p></td>
1391 <td width="2%"></td>
1392 <td width="66%">
1393
1394
1395 <p>The personal <b>fim</b> initialization file (executed at
1396 startup, after the system-wide initialization file).</p></td></tr>
1397 <tr valign="top" align="left">
1398 <td width="11%"></td>
1399 <td width="21%">
1400
1401
1402 <p><b>~/.fim_history</b></p></td>
1403 <td width="2%"></td>
1404 <td width="66%">
1405
1406
1407 <p>File where to load from or save command history. See
1408 (man <i>fimrc</i>(5), man <i>readline</i>(3)).</p></td></tr>
1409 <tr valign="top" align="left">
1410 <td width="11%"></td>
1411 <td width="21%">
1412
1413
1414 <p><b>~/.inputrc</b></p></td>
1415 <td width="2%"></td>
1416 <td width="66%">
1417
1418
1419 <p>If <b>fim</b> is built with GNU readline support, it is
1420 susceptible to changes in the user set ~/.inputrc
1421 configuration file contents. For details, see (man
1422 <i>readline</i>(3)).</p> </td></tr>
1423 </table>
1424
1425 <h2>SEE ALSO
1426 <a name="SEE ALSO"></a>
1427 </h2>
1428
1429
1430 <p style="margin-left:11%; margin-top: 1em">Other
1431 <b>fim</b> man pages: <i>fimgs</i>(1), <i>fimrc</i>(1). <br>
1432 Conversion programs: <i>convert</i>(1), <i>dia</i>(1),
1433 <i>xcftopnm</i>(1), <i>fig2dev</i>(1), <i>inkscape</i>(1).
1434 <br>
1435 Related programs: <i>fbset</i>(1), <i>con2fb</i>(1),
1436 <i>vim</i>(1), <i>mutt</i>(1), <i>exiftool</i>(1),
1437 <i>exiftags</i>(1), <i>exiftime</i>(1), <i>exifcom</i>(1),
1438 <i>fbi</i>(1), <i>fbida</i>(1), <i>feh</i>(1),
1439 <i>qiv</i>(1), <i>sxiv</i>(1), <i>fbgrab</i>(1). <br>
1440 Related documentation: <i>fbdev</i>(4), <i>vcs</i>(4),
1441 <i>fb.modes</i>(8), <i>fbset</i>(8), <i>setfont</i>(8).</p>
1442
1443 <h2>AUTHOR
1444 <a name="AUTHOR"></a>
1445 </h2>
1446
1447
1448 <p style="margin-left:11%; margin-top: 1em">Michele Martone
1449 &lt;dezperado _CUT_ autistici _CUT_ org&gt; is the author of
1450 fim, &quot;Fbi IMproved&quot;.</p>
1451
1452 <h2>COPYRIGHT
1453 <a name="COPYRIGHT"></a>
1454 </h2>
1455
1456
1457 <p style="margin-left:11%; margin-top: 1em">Copyright (C)
1458 2007-2024 Michele Martone &lt;dezperado _CUT_ autistici
1459 _CUT_ org&gt; (author of fim) <br>
1460 Copyright (C) 1999-2004 Gerd Hoffmann &lt;kraxel _CUT_
1461 bytesex.org&gt; is the author of &quot;fbi&quot;, upon which
1462 <b>fim</b> was originally based.</p>
1463
1464 <p style="margin-left:11%; margin-top: 1em">This program is
1465 free software; you can redistribute it and/or modify it
1466 under the terms of the GNU General Public License as
1467 published by the Free Software Foundation; either version 2
1468 of the License, or (at your option) any later version.</p>
1469
1470 <p style="margin-left:11%; margin-top: 1em">This program is
1471 distributed in the hope that it will be useful, but WITHOUT
1472 ANY WARRANTY; without even the implied warranty of
1473 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1474 GNU General Public License for more details.</p>
1475
1476 <p style="margin-left:11%; margin-top: 1em">You should have
1477 received a copy of the GNU General Public License along with
1478 this program; if not, write to the Free Software Foundation,
1479 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
1480 USA.</p>
1481 <hr>
1482 </body>
1483 </html>