Difference between revisions of "Feh"

From ArchWiki
Jump to: navigation, search
(added Codeline formatting; updated installation instructions to use the new styling phrasing)
(Undo revision 262425 by Tessellated (talk))
(29 intermediate revisions by 15 users not shown)
Line 1: Line 1:
[[Category:Graphics and desktop publishing (English)]]
+
[[Category:Graphics and desktop publishing]]
 
+
[[es:Feh]]
{{i18n|Feh}}
+
[[it:Feh]]
 
+
[[lt:Feh]]
 +
[[ru:Feh]]
 +
[[zh-CN:Feh]]
 +
{{Article summary start}}
 +
{{Article summary text|feh is a lightweight and powerful image viewer that can also be used to manage the desktop wallpaper for standalone window managers lacking such features.}}
 +
{{Article summary heading|Related}}
 +
{{Article summary wiki|Nitrogen}}
 +
{{Article summary wiki|sxiv}}
 +
{{Article summary end}}
 
[https://derf.homelinux.org/~derf/projects/feh/ feh] is a lightweight and powerful image viewer that can also be used to manage the desktop wallpaper for standalone window managers lacking such features.
 
[https://derf.homelinux.org/~derf/projects/feh/ feh] is a lightweight and powerful image viewer that can also be used to manage the desktop wallpaper for standalone window managers lacking such features.
  
 
==Installation==
 
==Installation==
{{Package Official|feh}} is available in the [[Official Repositories]]:
+
[[pacman|Install]] {{pkg|feh}}, which is available in the [[Official Repositories|official repositories]].
# pacman -S feh
+
  
 
==Usage==
 
==Usage==
feh is highly configurable. For a full list of options, run {{Codeline|feh --help}}.
+
feh is highly configurable. For a full list of options, run {{Ic|feh --help}}.
  
 
===As an image viewer===
 
===As an image viewer===
Line 17: Line 24:
 
  $ feh -g 640x480 -d -S filename /path/to/directory
 
  $ feh -g 640x480 -d -S filename /path/to/directory
  
* The {{Codeline|-g}} flag forces the images to appear no larger than 640x480
+
* The {{Ic|-g}} flag forces the images to appear no larger than 640x480
* The {{Codeline|-S filename}} flag sorts the images by file name
+
* The {{Ic|-d}} flag draws the file name
 +
* The {{Ic|-S filename}} flag sorts the images by file name
  
 
This is just one example; there are many more options available should you desire more flexibility.
 
This is just one example; there are many more options available should you desire more flexibility.
  
 
====File Browser Image Launcher====
 
====File Browser Image Launcher====
The following script, originally posted [https://bbs.archlinux.org/viewtopic.php?pid=884635#p884635 on the forum], is useful for file browsers. It will display your selected image in feh, but it will enable you to browse all other images in the directory as well, in their default order, i.e. as if you had run "feh *" and cycled through to the selected image.
+
The following script is useful for file browsers. It will display your selected image in feh, but it will enable you to browse all other images in the directory as well, in their default order, i.e. as if you had run "feh *" and cycled through to the selected image.
  
 
The script assumes the first argument is the filename.
 
The script assumes the first argument is the filename.
<pre>
+
{{hc|feh_browser.sh|<nowiki>
 
#!/bin/bash
 
#!/bin/bash
  
Line 50: Line 58:
  
 
exec feh "$@" -- "${arr[@]:c}" "${arr[@]:0:c}"
 
exec feh "$@" -- "${arr[@]:c}" "${arr[@]:0:c}"
</pre>
+
</nowiki>}}
  
 
Invoke the script with the selected image's path, followed by any additional arguments to feh. Here is an example of a launcher that you can use in a file browser:
 
Invoke the script with the selected image's path, followed by any additional arguments to feh. Here is an example of a launcher that you can use in a file browser:
  
  /path/to/script %f -F -Z
+
{{bc|$ /path/to/script/feh_browser.sh %f -F -Z}}
  
{{Codeline|-F}} and {{Codeline|-Z}} are feh arguments. {{Codeline|-F}} opens the image in fullscreen mode, and {{Codeline|-Z}} automatically zooms the image. Adding the {{Codeline|-q}} flag (quiet) suppresses error messages to the terminal when feh tries loading non-image files from the current folder.
+
{{Ic|-F}} and {{Ic|-Z}} are feh arguments. {{Ic|-F}} opens the image in fullscreen mode, and {{Ic|-Z}} automatically zooms the image. Adding the {{Ic|-q}} flag (quiet) suppresses error messages to the terminal when feh tries loading non-image files from the current folder.
 +
 
 +
A simple but less versatile alternative is
 +
{{hc|feh_browser.sh|<nowiki>
 +
#! /bin/sh
 +
feh -. "$(dirname "$1")" --start-at "$1"
 +
</nowiki>}}
 +
This one does not seem to accept options.
  
 
===As a desktop wallpaper manager===
 
===As a desktop wallpaper manager===
Line 63: Line 78:
 
When using [[GNOME]], you must disable Nautilus from controlling the desktop. The easiest way is to run this command:
 
When using [[GNOME]], you must disable Nautilus from controlling the desktop. The easiest way is to run this command:
  
$ gconftool-2 --set /apps/nautilus/preferences/show_desktop --type boolean false
+
{{bc|$ gconftool-2 --set /apps/nautilus/preferences/show_desktop --type boolean false}}
  
 
The following command is an example of how to set the initial background:
 
The following command is an example of how to set the initial background:
  
$ feh --bg-scale /path/to/image.file
+
{{bc|$ feh --bg-scale /path/to/image.file}}
  
 
Other scaling options include:
 
Other scaling options include:
--bg-tile FILE
+
{{bc|
--bg-center FILE
+
--bg-tile FILE
--bg-max FILE
+
--bg-center FILE
--bg-fill FILE
+
--bg-max FILE
 +
--bg-fill FILE
 +
}}
  
To restore the background on the next session, add the following to your startup file (e.g. {{Filename|~/.xinitrc}}, {{Filename|~/.config/openbox/autostart.sh}}, etc.):
+
To restore the background on the next session, add the following to your startup file (e.g. {{ic|~/.xinitrc}}, {{ic|~/.config/openbox/autostart}}, etc.):
sh ~/.fehbg &
+
{{bc|$ sh ~/.fehbg &}}
  
To change the background image, edit the file {{Filename|~/.fehbg}} which gets created after running the command {{Codeline|feh --bg-scale /path/to/image.file}} mentioned above.
+
To change the background image, edit the file {{ic|~/.fehbg}} which gets created after running the command {{Ic|feh --bg-scale /path/to/image.file}} mentioned above.
 +
== Tips and tricks ==
 +
===Random background image===
 +
==== Using a script ====
 +
To rotate the wallpaper randomly, create a script with the code below (e.g. {{ic|wallpaper.sh}}). Make the script executable:
  
====Random background image====
+
{{bc|$ chmod +x wallpaper.sh}}
To rotate the wallpaper randomly, create a script with the code below (e.g. {{Filename|wallpaper.sh}}). Make the script executable ({{Codeline|chmod +x wallpaper.sh}}) and call it from {{Filename|~/.xinitrc}}. You can also put the source directly in {{Filename|~/.xinitrc}} instead of in a separate file.
+
  
Change the {{Filename|~/.wallpaper}} directory to fit your setup and the {{Codeline|15m}} delay as you please (see {{Codeline|man sleep}} for options).
+
and call it from {{ic|~/.xinitrc}}. You can also put the source directly in {{ic|~/.xinitrc}} instead of in a separate file.
<pre>
+
 
 +
Change the {{ic|~/.wallpaper}} directory to fit your setup and the {{Ic|15m}} delay as you please (see {{Ic|man sleep}} for options).
 +
{{hc|wallpaper.sh|<nowiki>
 
#!/bin/sh
 
#!/bin/sh
  
 
while true; do
 
while true; do
 
find ~/.wallpaper -type f \( -name '*.jpg' -o -name '*.png' \) -print0 |
 
find ~/.wallpaper -type f \( -name '*.jpg' -o -name '*.png' \) -print0 |
shuf -n1 -z | xargs -0 feh --bg-scale
+
shuf -n1 -z | xargs -0 feh --bg-max
 
sleep 15m
 
sleep 15m
 
done
 
done
</pre>
+
</nowiki>}}
 +
 
 +
You may have to change {{ic|find ~/.wallpaper}} to {{ic|find ~/.wallpaper/}} to make the above work.
  
 
This version does not fork as much, but this version does not recurse through directories:
 
This version does not fork as much, but this version does not recurse through directories:
<pre>
+
{{hc|wallpaper.sh|<nowiki>
 
#!/bin/bash
 
#!/bin/bash
  
 
shopt -s nullglob
 
shopt -s nullglob
 
 
cd ~/.wallpaper
 
cd ~/.wallpaper
  
Line 113: Line 136:
 
sleep 15m
 
sleep 15m
 
done
 
done
</pre>
+
</nowiki>}}
 +
 
 +
=====For dual screen no-xinerama =====
 +
This script replace the call to '''feh''' for add a wallpaper on systems with dual screen nvidia twinview (for example).
 +
{{hc|wallpaper.sh|<nowiki>
 +
#!/bin/sh
 +
exec feh --bg-max --no-xinerama "$@"
 +
</nowiki>}}
 +
 
 +
==== Using a cron job ====
 +
Using a [[cron]] job, you can get a similar result, and it does not require having a script constantly sleeping.
 +
 
 +
Just do {{ic|$ crontab -e}} and add:
 +
 
 +
{{bc|<nowiki>
 +
* * * * *  DISPLAY=:0.0 feh --bg-max "$(find ~/.wallpaper/|shuf -n1)"
 +
</nowiki>}}
 +
 
 +
==== Using systemd user session ====
 +
{{Note|This is useful '''only''' if you are using ''systemd user session''. Read [[Systemd/User]] for more details.}}
 +
 
 +
Create the unit service file:
 +
{{hc|$HOME/.config/systemd/user/feh-wallpaper.service|<nowiki>
 +
[Unit]
 +
Description=Random wallpaper with feh
 +
 
 +
[Service]
 +
Type=oneshot
 +
EnvironmentFile=%h/.wallpaper
 +
ExecStart=/bin/bash -c '/usr/bin/feh --bg-max "$(find ${WALLPATH}|shuf|head -n 1)"'
 +
 
 +
[Install]
 +
WantedBy=default.target
 +
</nowiki>}}
 +
Now create the timer file. Change the time as necessary. In this example is {{ic|15 seconds}}.
 +
{{hc|$HOME/.config/systemd/user/feh-wallpaper.timer|<nowiki>
 +
[Unit]
 +
Description=Random wallpaper with feh
 +
 
 +
[Timer]
 +
OnUnitActiveSec=</nowiki>''15s''<nowiki>
 +
Unit=feh-wallpaper.service
 +
 
 +
[Install]
 +
WantedBy=default.target
 +
</nowiki>}}
 +
In this example the configuration is one hidden file on the home directory with the path of the directory where the images are stored
 +
{{hc|$HOME/.wallpaper|<nowiki>
 +
WALLPATH=</nowiki>''/home/user/.wallpaper/''
 +
}}
 +
 
 +
Activate the {{ic|feh-wallpaper.timer}} and {{ic|feh-wallpaper.service}} daemons. Read [[Daemons]] for more details.
 +
 
 +
{{Note|Remember that under ''systemd user session'', you should use the {{ic|--user}} flag on {{ic|systemctl}}.}}
 +
 
 +
== See also ==
 +
* [https://bbs.archlinux.org/viewtopic.php?pid=884635#p884635 Forum post with original script for feh_browser]

Revision as of 22:24, 11 June 2013

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary end feh is a lightweight and powerful image viewer that can also be used to manage the desktop wallpaper for standalone window managers lacking such features.

Installation

Install feh, which is available in the official repositories.

Usage

feh is highly configurable. For a full list of options, run feh --help.

As an image viewer

To quickly browse images in a specific directory, you can launch feh with the following arguments:

$ feh -g 640x480 -d -S filename /path/to/directory
  • The -g flag forces the images to appear no larger than 640x480
  • The -d flag draws the file name
  • The -S filename flag sorts the images by file name

This is just one example; there are many more options available should you desire more flexibility.

File Browser Image Launcher

The following script is useful for file browsers. It will display your selected image in feh, but it will enable you to browse all other images in the directory as well, in their default order, i.e. as if you had run "feh *" and cycled through to the selected image.

The script assumes the first argument is the filename.

feh_browser.sh
#!/bin/bash

shopt -s nullglob

if [[ ! -f $1 ]]; then
	echo "$0: first argument is not a file" >&2
	exit 1
fi

file=$(basename -- "$1")
dir=$(dirname -- "$1")
arr=()
shift

cd -- "$dir"

for i in *; do
	[[ -f $i ]] || continue
	arr+=("$i")
	[[ $i == $file ]] && c=$((${#arr[@]} - 1))
done

exec feh "$@" -- "${arr[@]:c}" "${arr[@]:0:c}"

Invoke the script with the selected image's path, followed by any additional arguments to feh. Here is an example of a launcher that you can use in a file browser:

$ /path/to/script/feh_browser.sh %f -F -Z

-F and -Z are feh arguments. -F opens the image in fullscreen mode, and -Z automatically zooms the image. Adding the -q flag (quiet) suppresses error messages to the terminal when feh tries loading non-image files from the current folder.

A simple but less versatile alternative is

feh_browser.sh
#! /bin/sh
feh -. "$(dirname "$1")" --start-at "$1"

This one does not seem to accept options.

As a desktop wallpaper manager

feh can be used to manage the desktop wallpaper for window managers that lack desktop features, such as Openbox, Fluxbox, and xmonad.

When using GNOME, you must disable Nautilus from controlling the desktop. The easiest way is to run this command:

$ gconftool-2 --set /apps/nautilus/preferences/show_desktop --type boolean false

The following command is an example of how to set the initial background:

$ feh --bg-scale /path/to/image.file

Other scaling options include:

--bg-tile FILE
--bg-center FILE
--bg-max FILE
--bg-fill FILE

To restore the background on the next session, add the following to your startup file (e.g. ~/.xinitrc, ~/.config/openbox/autostart, etc.):

$ sh ~/.fehbg &

To change the background image, edit the file ~/.fehbg which gets created after running the command feh --bg-scale /path/to/image.file mentioned above.

Tips and tricks

Random background image

Using a script

To rotate the wallpaper randomly, create a script with the code below (e.g. wallpaper.sh). Make the script executable:

$ chmod +x wallpaper.sh

and call it from ~/.xinitrc. You can also put the source directly in ~/.xinitrc instead of in a separate file.

Change the ~/.wallpaper directory to fit your setup and the 15m delay as you please (see man sleep for options).

wallpaper.sh
#!/bin/sh

while true; do
	find ~/.wallpaper -type f \( -name '*.jpg' -o -name '*.png' \) -print0 |
		shuf -n1 -z | xargs -0 feh --bg-max
	sleep 15m
done

You may have to change find ~/.wallpaper to find ~/.wallpaper/ to make the above work.

This version does not fork as much, but this version does not recurse through directories:

wallpaper.sh
#!/bin/bash

shopt -s nullglob
cd ~/.wallpaper

while true; do
	files=()
	for i in *.jpg *.png; do
		[[ -f $i ]] && files+=("$i")
	done
	range=${#files[@]}

	((range)) && feh --bg-scale "${files[RANDOM % range]}"

	sleep 15m
done
For dual screen no-xinerama

This script replace the call to feh for add a wallpaper on systems with dual screen nvidia twinview (for example).

wallpaper.sh
#!/bin/sh
exec feh --bg-max --no-xinerama "$@"

Using a cron job

Using a cron job, you can get a similar result, and it does not require having a script constantly sleeping.

Just do $ crontab -e and add:

* * * * *  DISPLAY=:0.0 feh --bg-max "$(find ~/.wallpaper/|shuf -n1)"

Using systemd user session

Note: This is useful only if you are using systemd user session. Read Systemd/User for more details.

Create the unit service file:

$HOME/.config/systemd/user/feh-wallpaper.service
[Unit]
Description=Random wallpaper with feh

[Service]
Type=oneshot
EnvironmentFile=%h/.wallpaper
ExecStart=/bin/bash -c '/usr/bin/feh --bg-max "$(find ${WALLPATH}|shuf|head -n 1)"'

[Install]
WantedBy=default.target

Now create the timer file. Change the time as necessary. In this example is 15 seconds.

$HOME/.config/systemd/user/feh-wallpaper.timer
[Unit]
Description=Random wallpaper with feh

[Timer]
OnUnitActiveSec=15s
Unit=feh-wallpaper.service

[Install]
WantedBy=default.target

In this example the configuration is one hidden file on the home directory with the path of the directory where the images are stored

$HOME/.wallpaper
WALLPATH=/home/user/.wallpaper/

Activate the feh-wallpaper.timer and feh-wallpaper.service daemons. Read Daemons for more details.

Note: Remember that under systemd user session, you should use the --user flag on systemctl.

See also