From b13bbbfb3b8306119d86df95c147df62b4f51efe Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sun, 4 Nov 2018 16:06:20 +0100 Subject: Remove feh-cam and gen-cam-menu --- README.md | 1 - 1 file changed, 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 334e681..3b7be60 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,6 @@ Available flags are: | Flag | Default value | Description | | :--- | :---: | :--- | | app | 0 | install icons to /usr/share, regardless of `DESTDIR` and `PREFIX, and call gtk-update-icon-cache afterwards | -| cam | 0 | install deprecated feh-cam und gen-cam-menu scripts | | curl | 1 | use libcurl to view http:// and similar images | | debug | 0 | debug build, enables `--debug` | | exif | 0 | Builtin EXIF tag display support | -- cgit v1.2.3 From 8a83c119e7d0c75f09159df79848efa49efc2dc7 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sun, 4 Nov 2018 16:08:53 +0100 Subject: Fix typos/errors in README --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3b7be60..3b33520 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ Available flags are: | Flag | Default value | Description | | :--- | :---: | :--- | -| app | 0 | install icons to /usr/share, regardless of `DESTDIR` and `PREFIX, and call gtk-update-icon-cache afterwards | +| app | 0 | install icons to /usr/share, regardless of `DESTDIR` and `PREFIX`, and call gtk-update-icon-cache afterwards | | curl | 1 | use libcurl to view http:// and similar images | | debug | 0 | debug build, enables `--debug` | | exif | 0 | Builtin EXIF tag display support | @@ -87,7 +87,8 @@ Available flags are: | verscmp | 1 | Support naturing sorting (`--version-sort`). Requires a GNU-compatible libc exposing `strverscmp` | | xinerama | 1 | Support Xinerama/XRandR multiscreen setups | -So, by default **libcurl** and **Xinerama** are enabled, the rest is disabled. +So, by default **libcurl**, **verscmp**, and **Xinerama** are enabled. +All other flags are disabled. Additionally, the standard variables `PREFIX` and `DESTDIR` are supported. -- cgit v1.2.3 From 5adf6df2fd7d3e5616435c762c0877125b54da50 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Mon, 12 Nov 2018 16:22:44 +0100 Subject: README: Use HTTPS links --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3b33520..58a173c 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,7 @@ Imlib2 based image viewer --- - * http://feh.finalrewind.org/ - * http://linuxbrit.co.uk/feh/ + * https://feh.finalrewind.org/ * #feh on irc.oftc.net Dependencies @@ -51,7 +50,7 @@ Because of this, when using "make install app=1", feh will install its icons to /usr/share/..., even though they technically belong into /usr/local. -ZSH Completion for feh is available [here](http://git.finalrewind.org/zsh/plain/etc/completions/_feh) +ZSH Completion for feh is available [here](https://git.finalrewind.org/zsh/plain/etc/completions/_feh) Make flags ---------- @@ -79,7 +78,7 @@ Available flags are: | Flag | Default value | Description | | :--- | :---: | :--- | | app | 0 | install icons to /usr/share, regardless of `DESTDIR` and `PREFIX`, and call gtk-update-icon-cache afterwards | -| curl | 1 | use libcurl to view http:// and similar images | +| curl | 1 | use libcurl to view https:// and similar images | | debug | 0 | debug build, enables `--debug` | | exif | 0 | Builtin EXIF tag display support | | help | 0 | include help text (refers to the manpage otherwise) | -- cgit v1.2.3 From c859236dea93430928e318dde5850cc5c335e46c Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sun, 18 Nov 2018 15:52:47 +0100 Subject: Improve README and feh(1) introduction --- README.md | 75 ++++++++++++++++++++++++++++--------------------------------- man/feh.pre | 25 +++++++++------------ 2 files changed, 44 insertions(+), 56 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 58a173c..9f2e5dc 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,21 @@ [![build status](https://travis-ci.org/derf/feh.svg?branch=master)](https://travis-ci.org/derf/feh) -# feh -Imlib2 based image viewer +Feh – Image viewer and Cataloguer --- - * https://feh.finalrewind.org/ - * #feh on irc.oftc.net +feh is a light-weight, configurable and versatile image viewer. +It is aimed at command line users, but can also be started from graphical file +managers. Apart from viewing images, it can compile text and thumbnail +listings, show (un)loadable files, set X11 backgrounds, and more. + +Features include filelists, various image sorting modes, custom action scripts, +and image captions. feh can be controlled by configurable keyboard and mouse +shortcuts, terminal input and signals. When no file arguments or filelists are +specified, feh displays all files in the current directory. + +For more information, please refer to the [feh +website](https://feh.finalrewind.org/) or read the [feh +manual](https://man.finalrewind.org/1/feh/). Dependencies --- @@ -21,11 +31,10 @@ If built with exif=1: * libexif-dev * libexif12 -Recommended +Recommended Binaries --- - * jpegtran (supplied by the jpeg library, for lossless image rotation) - * convert (supplied by ImageMagick, can be used to load unsupported formats) + * convert (supplied by ImageMagick, can be used to load image formats not supported by Imlib2) Installation --- @@ -45,24 +54,23 @@ $ sudo make install **Explanation:** feh ships some icons and an X11 desktop entry, which allow it to be used from file managers, desktop menus and similar. However, installing -icons to /usr/local/share/... does not seem to work reliable in all cases. +icons to /usr/local/share/... does not seem to work reliably. Because of this, when using "make install app=1", feh will install its icons to /usr/share/..., even though they technically belong into /usr/local. - -ZSH Completion for feh is available [here](https://git.finalrewind.org/zsh/plain/etc/completions/_feh) +[ZSH completion for +feh](https://git.finalrewind.org/zsh/plain/etc/completions/_feh) is also +available. Make flags ---------- -Flags can be used to control the build and installation process. - -e.g. +feh's build process uses make flags to enable/disable optional features and +fine-tune the build and installation process. They can be passed as **make** +arguments or set as environment variables, like so: ```bash make flag=bool -``` -```bash make install flag=bool ``` or @@ -71,9 +79,8 @@ export flag=bool make && make install ``` -For example, `make xinerama=0 debug=1` will disable Xinerama support and produce a debug build. - -Available flags are: +The following flags are respected by the makefile. A default value of **1** +indicates that the corresponding feature is enabled by default. | Flag | Default value | Description | | :--- | :---: | :--- | @@ -86,8 +93,8 @@ Available flags are: | verscmp | 1 | Support naturing sorting (`--version-sort`). Requires a GNU-compatible libc exposing `strverscmp` | | xinerama | 1 | Support Xinerama/XRandR multiscreen setups | -So, by default **libcurl**, **verscmp**, and **Xinerama** are enabled. -All other flags are disabled. +For example, `make xinerama=0 debug=1` will disable Xinerama support and +produce a debug build; libcurl and natural sorting support will remain enabled. Additionally, the standard variables `PREFIX` and `DESTDIR` are supported. @@ -97,8 +104,8 @@ will be installed. It must be set both during `make` and `make install`. **DESTDIR _(default: empty)_** sets the installation root during "make install". It is mostly useful for package maintainers. -**Note:** config.mk is designed so that in most cases, you can set environment -variables instead of editing it. E.g.: +**Note:** Defaults are specified in `config.mk`. It is designed so that in most +cases, you can set environment variables instead of editing it. E.g.: ```bash CFLAGS='-g -Os' make @@ -113,26 +120,12 @@ Builtin EXIF support is maintained by Dennis Real, [here](https://github.com/rea Testing (non-X) --------------- -```bash -$ make test -``` - -Requires **perl >= 5.10** with `Test::Command`. The tests are non-interactive and -work without X, so they can safely be run even on a headless buildserver. - -Testing (X) ------------ - -Requires - * import (usually supplied by imagemagick) - * perl >= 5.10 with GD, Test::More and X11::GUITest - * twm - * Xephyr +The non-X11 parts of feh can be automatically tested by running ```bash -$ make test-x11 +$ make test ``` - -**_Be aware that this is quite experimental, so far the X-tests have only been -run on one machine. So they may or may not work for you._** +This requires **perl >= 5.10** and the perl module `Test::Command`. Tests are +non-interactive and do not require a running X11, so they can safely be run on +a headless buildserver. diff --git a/man/feh.pre b/man/feh.pre index f6db8c4..00bca66 100644 --- a/man/feh.pre +++ b/man/feh.pre @@ -32,27 +32,22 @@ $MAN_XINERAMA$, builtin EXIF support $MAN_EXIF$$MAN_DEBUG$ .Sh DESCRIPTION . .Nm -is a mode-based image viewer. -It is especially aimed at command line users who need a fast image viewer -without huge GUI dependencies, though it can also be started by -.Pq graphical -file managers to view an image. -When no file arguments or filelists are specified, -.Nm -displays all files in the current directory. +is a light-weight, configurable and versatile image viewer. +It is aimed at command line users, but can also be started from graphical file +managers. +Apart from viewing images, it can compile text and thumbnail +listings, show (un)loadable files, set X11 backgrounds, and more. . .Pp . +Features include filelists, various image sorting modes, custom action scripts, +and image captions. .Nm -supports filelists, various image sorting modes, image captions, HTTP and more. -It can be controlled by configurable keyboard and mouse shortcuts, terminal +can be controlled by configurable keyboard and mouse shortcuts, terminal input and signals. -. -.Pp -. -In many desktop environments, +When no file arguments or filelists are specified, .Nm -can also be used as wallpaper setter. +displays all files in the current directory. . .Pp . -- cgit v1.2.3 From 799cf5b72f2ebb7725c7f38b1e0c7b7acdfbff8c Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sun, 18 Nov 2018 15:58:03 +0100 Subject: README: PREFIX defaults to /usr/local --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9f2e5dc..2d66fd8 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ produce a debug build; libcurl and natural sorting support will remain enabled. Additionally, the standard variables `PREFIX` and `DESTDIR` are supported. -**PREFIX _(default: /usr)_** controls where the application and its data files +**PREFIX _(default: /usr/local)_** controls where the application and its data files will be installed. It must be set both during `make` and `make install`. **DESTDIR _(default: empty)_** sets the installation root during "make install". It -- cgit v1.2.3 From 60d3bcfdb3370730babe5e75ae8fbdaae9f09a35 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sun, 18 Nov 2018 19:59:59 +0100 Subject: some contribution notes --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 2d66fd8..390f9ca 100644 --- a/README.md +++ b/README.md @@ -129,3 +129,20 @@ $ make test This requires **perl >= 5.10** and the perl module `Test::Command`. Tests are non-interactive and do not require a running X11, so they can safely be run on a headless buildserver. + + +Contributing +--- + +Bugfixes are always welcome, just open a pull request :) + +Before proposing a new feature, please consider the scope of feh: It is an +image viewer and cataloguer, not an image editor or similar. Also, its option +list is already pretty long. Please discuss your ideas in a feature request +before opening a pull request in this case. + +Please keep in mind that feh's options, key bindings and format specifiers are +documented in two different places: The manual (man/feh.pre) and the help text +(src/help.raw). Although the help is not compiled in by default, it should be +kept up-to-date. On space-constrained embedded systems, it may be more useful +than the (significantly larger) man page. -- cgit v1.2.3