~~NOTOC~~
{{ :apps:catfish.png?nolink|}}
===== Catfish - Introduction =====

Catfish is a versatile file search utility for the Xfce desktop. Powered by Python and GTK, it is fast, flexible, and exceptional at finding files.

----

===== Features =====
  * Minimalistic, GTK+3 interface
  * Search suggestions, powered by Zeitgeist and locate
  * Powerful filtering by date, file type, and more
  * Full-text file content search

----

===== Required Packages =====

  * [[https://github.com/python/|python 3]]
  * [[https://www.gtk.org|GTK+]] (3.12 or above)
  * [[https://wiki.gnome.org/Projects/GLib|GLib]] (GLib / GObject Python bindings: GdkPixbuf, GLib, GTK 3, Pango, Cairo, Xfconf)
  * [[https://pypi.org/project/pexpect/|Pexpect]]
  * locate or mlocate 

==== Optional ====

Catfish includes optional support for Zeitgeist, which is used to provide
instant search results. You can learn more about Zeitgeist on the [[https://launchpad.net/zeitgeist-project|Zeitgeist Homepage]] or the [[https://wiki.archlinux.org/index.php/Zeitgeist|Zeitgeist Arch Wiki page]].

To enable Zeitgeist (on Debian-based systems), just install the Python Zeitgeist GIR binding and ensure
the Zeitgeist datahub is running.

    sudo apt install gir1.2-zeitgeist-2.0 zeitgeist

----

===== Installation instructions =====

To install the build and runtime requirements on a Debian-based system,
the following command is sufficient:

    sudo apt install python3 python3-distutils-extra gir1.2-gdkpixbuf-2.0
    gir1.2-glib-2.0 gir1.2-gtk-3.0 gir1.2-pango-1.0 python3-gi-cairo
    gir1.2-xfconf-0 xfconf python3-pexpect locate

If gir1.2-xfconf-0 cannot be found in your repository, it may be located
at the [[https://launchpad.net/~xubuntu-dev/+archive/ubuntu/experimental|Xubuntu Experimental PPA]]

    
 
From a source repository:

  - Unpack the archive.
  - Install Catfish:
     - To install locally (a user install), run: ''python3 setup.py install --user''
     - To install system-wide (a root install), run: ''sudo python3 setup.py install''
  - For a list of command line options run: ''catfish --help''

[[|Back to Top]]
----
[[:apps:catfish:|Back to Catfish Main Documentation Page]]