From ee71fb0dd0cd3e8d1cfdd2eae9b4b4e741e51d6a Mon Sep 17 00:00:00 2001 From: Přemysl Eric Janouch Date: Mon, 24 Jan 2022 08:41:05 +0100 Subject: Start a basic user guide Move some information out there from the README. --- docs/fiv.html | 120 ++++++++++++++++++++++++++++++++++++++++++++++++++++ docs/fiv.webp | Bin 0 -> 155162 bytes docs/stylesheet.css | 8 ++++ 3 files changed, 128 insertions(+) create mode 100644 docs/fiv.html create mode 100644 docs/fiv.webp create mode 100644 docs/stylesheet.css (limited to 'docs') diff --git a/docs/fiv.html b/docs/fiv.html new file mode 100644 index 0000000..b913f0d --- /dev/null +++ b/docs/fiv.html @@ -0,0 +1,120 @@ + + + + +fiv: User Guide + + + + + +

fiv: User Guide

+ +

+Přemysl Eric Janouch
+p@janouch.name
+version 0.0.0, +2022-01-25 + +

fiv's browser and viewer + +

Introduction

+ +

fiv is a general-purpose image browser and viewer. This document will +guide you through the application and help to familiarize you with it. + +

Controls

+ +

fiv is designed with computer mice having dedicated forwards/backwards +and page up/down buttons in mind, such as SteelSeries Sensei series. Ozone Neon +series may also be mapped this way. Your experience may be degraded with other +kinds of devices. + +

Controls should generally be accessible through the keyboard. Pressing Ctrl+? +will give you a convenient overview of all shortcuts. In addition to these, +remember that you may often use Ctrl+Tab and F6 to navigate to different groups +of widgets. + +

Browser

+ +

fiv normally starts in a file browser view. On the left side of the +window, you'll find your GTK+ bookmarks, mounted locations as recognized by +GVfs, an item for entering arbitrary filesystem paths or URIs, view controls, +and finally breadcrumbs leading to the currently opened directory, as well as +its descendants. + +

You can open items in a new window either by middle clicking on them either +directly, or with the Ctrl key pressed down. Right clicking the directory view +offers a context menu for opening files, or even the directory itself, +in a different application. + +

Viewer

+ +

The image viewer may be both entered (so long as you have a file selected) +and exited using the Enter key. This way you may easily switch between the two +modes. When using the mouse, the forwards and backwards buttons will fulfill +the same function. + +

Double clicking the image switches full-screen view, and the mouse wheel +adjusts the zoom level. + +

Files are iterated in the same order, and using the same filtering as in +the browser. + +

+ +

File formats

+ +

The list of all supported file formats may be obtained by running: + +

+fiv --list-supported-media-types
+
+ +Unless it has been turned off in your installation, you may extend it through +gdk-pixbuf modules. + +

Thumbnails

+ +

fiv uses a custom way of storing thumbnails, and doesn't currently +provide any means of invalidating this cache. Should you find out that your +~/.cache/thumbnails directory is taking up too much space, run: + +

+rm -rf ~/.cache/thumbnails/wide-*
+
+ +

Configuration

+ +

The standard means to adjust the looks of the program is through GTK+ 3 CSS. +As an example, to tightly pack browser items, put the following in your +~/.config/gtk-3.0/gtk.css: + +

+fiv-browser { -FivBrowser-spacing: 0; padding: 0; border: 0; margin: 0; }
+
+ +

Similarly, you can adjust some of the key bindings, as per the command table +in the fiv-view.h source file: + +

+@binding-set ViewBindings { bind 'p' { 'command' (print) }; }
+fiv-view { -gtk-key-bindings: ViewBindings; }
+
+ +

Should you want to experiment, you will find the GTK+ inspector very helpful. + + diff --git a/docs/fiv.webp b/docs/fiv.webp new file mode 100644 index 0000000..ef47681 Binary files /dev/null and b/docs/fiv.webp differ diff --git a/docs/stylesheet.css b/docs/stylesheet.css new file mode 100644 index 0000000..b4b5b2d --- /dev/null +++ b/docs/stylesheet.css @@ -0,0 +1,8 @@ +body { max-width: 50em; margin: 0 auto 4em auto; padding: 0 2em; + font-family: sans-serif; } h1, h2, h3 { font-weight: normal; } +h1 { font-size: 2.5em; } h2 { font-size: 2em; } h3 { font-size: 1.33em; } +h2 { padding-top: .67em; border-top: 1px solid silver; } +p { line-height: 1.5; } .figure { text-align: center; } img { max-width: 100%; } +q { font-style: normal; } .details { border-bottom: 1px solid silver; } +.details br { display: none; } .details br + span:before { content: " — "; } +pre { padding: 0 1em; } -- cgit v1.2.3-70-g09d2