diff options
| author | Přemysl Eric Janouch <p@janouch.name> | 2023-04-17 07:17:16 +0200 |
|---|---|---|
| committer | Přemysl Eric Janouch <p@janouch.name> | 2023-04-17 07:20:07 +0200 |
| commit | a6560509d99d75728c0c857de4859ca9d81f1a0d (patch) | |
| tree | cce8b3ac6ce32318dba60e3dac636d63a13c2a7f /docs/fiv.adoc | |
| parent | 44c28f00d65ace6ea6ef340de03139f98648ebe5 (diff) | |
| download | fiv-a6560509d99d75728c0c857de4859ca9d81f1a0d.tar.gz fiv-a6560509d99d75728c0c857de4859ca9d81f1a0d.tar.xz fiv-a6560509d99d75728c0c857de4859ca9d81f1a0d.zip | |
Revise documentation and help output
Split out clearly internal options.
Diffstat (limited to 'docs/fiv.adoc')
| -rw-r--r-- | docs/fiv.adoc | 37 |
1 files changed, 22 insertions, 15 deletions
diff --git a/docs/fiv.adoc b/docs/fiv.adoc index f7f992e..5285d5d 100644 --- a/docs/fiv.adoc +++ b/docs/fiv.adoc @@ -26,6 +26,15 @@ the _User Guide_. Options ------- +*--browse*:: + When an image is passed, start in browsing mode, and preselect that + image in its containing directory. This is used by *fiv*'s inode/directory + handler to implement the "Open Containing Folder" feature of certain + applications. + +*--help-all*:: + Show the full list of options, including those provided by GTK+. + *--invalidate-cache*:: Invalidate the wide thumbnail cache, removing thumbnails for files that can no longer be found. @@ -35,18 +44,11 @@ Options the list of MIME types within *fiv*'s desktop file when the list of GdkPixbuf loaders changes. -*--browse*:: - When an image is passed, start in browsing mode, and preselect that - image in its containing directory. This is used by *fiv*'s inode/directory - handler to implement the "Open Containing Folder" feature of certain - applications. - -*--thumbnail*=_SIZE_:: - Generate thumbnails for the first argument, in all sizes not exceeding - _SIZE_, and present the largest of them on the standard output - in an application-specific bitmap format. Available sizes follow directory - names in the _Thumbnail Managing Standard_. +*-V*, *--version*:: + Output version information and exit. +Internal options +~~~~~~~~~~~~~~~~ *--extract-thumbnail*:: Present any embedded thumbnail of the first argument on the standard output in an application-specific bitmap format. When both *--thumbnail* @@ -54,11 +56,16 @@ Options exiting early if successful. This is used to enhance responsivity of thumbnail procurement. -*-V*, *--version*:: - Output version information and exit. +*--thumbnail*=_SIZE_:: + Generate wide thumbnails for the first argument, in all sizes not exceeding + _SIZE_, and present the largest of them on the standard output + in an application-specific bitmap format. Available sizes follow directory + names in the _Thumbnail Managing Standard_. -*--help-all*:: - Show the full list of options, including those provided by GTK+. +*--thumbnail-for-search*=_SIZE_:: + Transform the first argument to a widely supported image file format, + and present it on the standard output. The image will be downscaled as + necessary so as to not exceed _SIZE_ (see *--thumbnail*). Reporting bugs -------------- |