Fuzzy Finder suchen aus Datenströmen selbst dann Passendes heraus, wenn es keine exakten Treffer gibt.

Die unscharfe Suche gehört heute als fester Bestandteil zum IT-Alltag. Sie korrigiert Tippfehler, spürt Ähnlichkeiten auf und bietet eine Möglichkeit, selbst in unstrukturierten Daten noch mit vertretbarem Aufwand das Gewünschte zu finden. Das Grundprinzip basiert auf der in der 1960er-Jahren definierten Levenshtein-Distanz [1], den sogenannten Wortabständen (siehe Kasten “Levenshtein”). Quasi von Beginn an erweiterten und optimierten Entwickler diesen Algorithmus.

Allerdings ignorieren bis heute viele Standardwerkzeuge unscharfe Suchen oder beschränken sich auf stark vereinfachte Varianten. So verarbeitet das Tool Grep aus den Coreutils zwar beliebig komplexe reguläre Ausdrücke (Muster), eine unscharfe Suche unterstützt es aber nicht. Für eine solche stehen auf der Kommandozeile neben Agrep [2] und Ugrep [3] noch einige andere, weniger bekannte Tools bereit. Agrep sticht dabei mit einer Best-Match-Option heraus.

Fzf [4] und Fzy [5] (siehe Kasten “Kleiner Bruder”) bereichern den Shell-Baukasten um zwei neue, leistungsfähige Werkzeuge. Sie arbeiten als interaktive Filter, erhalten ihre Daten also voreingestellt auf der Standardeingabe und liefern die Ergebnisse auch dort wieder aus. Interaktiv bedeutet in diesem Kontext, dass sie Schnittstellen zur Eingabe der Suchmuster bereitstellen, die es erlauben, zur Laufzeit die Suchmuster anzupassen und zu verfeinern.

Fzf

Fzf steht für Fuzzy Finder. Das Werkzeug agiert als allgemein gehaltener Filter, der im interaktiven Modus auch als Menü-Generator fungiert. Mit dem Aufruf fzf starten Sie das Tool in der Shell, was normalerweise die Anzeige aller Dateien im aktuellen Verzeichnis bewirkt. Dabei nutzt Fzf einen eingebauten Find-Befehl, der dann zum Einsatz kommt, wenn das Programm keine Daten über die Standardeingabe erhält. Das Feature hilft dabei, Befehlszeilen kurz zu halten. Sie steuern es über die Umgebungsvariable FZF_DEFAULT_COMMAND, in der Sie bei Bedarf einen anderen Befehl vorgeben. Optionen, die Sie Fzf voreingestellt mitgeben wollen, hinterlegen Sie in der Umgebungsvariablen FZF_DEFAULT_OPTS.

Meist kommt das Programm in Verbindung mit der Pipe zum Einsatz, erhält die Eingabedaten also via Standardeingabe (Listing 1). Damit landen Sie im interaktiven Modus, der aus zwei Teilen besteht. Das sichtbare Interface, der Finder, erlaubt interaktive Aktionen. In ihm manövrieren Sie mit den Pfeiltasten oder über [Strg]+[K] und [Strg]+[J]. Die aktuelle Zeile zeigt das Terminal entsprechend der Einstellungen fett oder invers an. Durch einen Druck auf die Eingabetaste übernehmen Sie die markierte Zeile und schreiben sie in die Standardausgabe beziehungsweise ins Terminal.

$ locate / | fzf
[...]
.../Bilder-sda5/_1130192.png.out.pp3
.../Bilder-sda5/_1130192-1.png.out.pp3
.../Bilder-sda5/_1110520.jpg.out.pp3
.../Bilder-sda5/_1090399.dng.xmp
.../Bilder-sda5/_1090399.dng.pp3
.../Bilder-sda5/_1040511a.pts
.../Bilder-sda5/_1040511.pts
.../Bilder-sda5/_1040511-6.pts
.../Bilder-sda5/TANZ!-2020-2021
[...]

Am unteren Rand blinkt im Finder zusätzlich ein Prompt (>) und fordert zur Eingabe auf. Haben Sie Fzf bereits beim Aufruf ein Suchmuster mitgegeben (als Argument der Option -q), steht es in dieser Zeile zum Bearbeiten bereit. Im Hintergrund arbeitet der zweite Teil, der den Index und die unscharfe Suche steuert. In der vorletzten Zeile zeigt das Tool an, was diesbezüglich gerade geschieht: Ein sich stetig änderndes Zeichen symbolisiert, dass es aus den Eingaben einen Index erzeugt, in dem es dann das Muster sucht. Die aktuelle Größe dieses Index sehen Sie ebenfalls am unteren Ende.

Suchmuster

Der Finder stellt ein wesentliches Feature von Fzf dar. Die Möglichkeiten des Tools beschränken sich jedoch nicht darauf, vorhandene Suchmuster zu bearbeiten. Es wertet die Muster außerdem inkrementell aus. Jedes zusätzlich eingegebene Zeichen verfeinert also die Suche. Im voreingestellt aktivierten Extended-Search-Modus dürfen Sie zudem weitere Muster durch Leerzeichen getrennt angeben. Einigen darin verwendeten Sonderzeichen misst das Programm spezielle Bedeutungen zu (siehe Tabelle “Suche für Profis”). Mehrere Suchmuster kombinieren Sie wie in Listing 2.

Muster1$ Muster2 ^Muster3 !Muster4

Innerhalb des Suchmusters im Finder navigieren Sie mit den Pfeiltasten. Die markierte Zeile signalisiert die Auswahl. Alternativ stehen einige vorab eingestellte Tastenbindungen bereit (siehe Tabelle “Steuerung”). Alle Aktionen, die die Aus- oder Abwahl mehrerer Zeilen umfassen, setzen voraus, dass Sie die Software über -m im Multiauswahlmodus starten. Daneben unterstützt der Finder auch das Steuern per Maus. Das Mausrad scrollt, Klick und Doppelklick aktivieren beziehungsweise wählen. Bei gedrückter Umschalttaste wählt ein Mausklick mehrere Elemente aus. Der Doppelklick beendet die Eingabe.

Ansonsten arbeitet das Programm voreingestellt mit einer an den Emacs angepassten Tastenbindung. Mittels --bind lassen sich weitere oder abweichende Tastenbindungen einstellen. Die Befehlszeilenoption -e deaktiviert die unscharfe Suche und bewirkt, dass nur noch exakte Treffer erscheinen. Weitere wichtige Optionen von Fzf fasst die Tabelle “Wichtige Optionen” zusammen.

Wie das Programm Treffer ermittelt und bewertet, steuern Sie mit einer Reihe von Parametern. Die Bewertung der Eingabezeilen erfolgt dabei anhand der Kriterien aus der Tabelle “Modifikationen”. Dabei darf index nur am Ende stehen. Diese Option verwendet Fzf als Standard, wenn Sie nichts angeben. Mit diesen Kriterien, die Sie als Argument der Option --tiebreak=Kriterium explizit auswählen, bewertet Fzf die Eingaben. Voreingestellt verwendet es length beziehungsweise length,index. Falls Sie end verwenden, wertet die Software die Zeilen rückwärts aus.

Eine typische Fzf-Anwendung besteht in der fehlertoleranten Variante des Locate-Befehls. Letzterer sucht in einer zuvor erstellten Datenbank anhand von Namen nach Dateien im lokalen System. Diese Suche erfolgt strikt, liefert also bei Schreibfehlern oder Abkürzungen keine Ergebnisse. Im Beispiel aus Listing 3 erzeugt locate / eine Liste aller Einträge und liefert diese via Pipe an Fzf. Das setzt alle übergebenen Argumente als Muster für den Befehl ein. Übergeben Sie L keine Argumente, erscheint die gesamte Liste, und Sie geben Muster im interaktiven Modus von Fzf direkt ein.

L () { locate -i / | fzf -q "${*:-/}" ; }

Bei einer sehr großen Datenbank möchten Sie vermutlich viele Treffer ausschließen, um die Übersicht in den Ergebnissen zu erhöhen. Das erledigen Sie, indem Sie der Funktion Argumente übergeben. In Listing 4 sucht das Muster nach “etwas”, schließt dabei aber “anderes” aus. Wenn das immer noch zu viele Treffer liefert, etwa in den zufällig benannten Browser-Caches, führen weitere zusätzliche Muster im interaktiven Modus zu besseren Ergebnissen. Das Ausrufezeichen vor dem ausschließenden Muster maskieren Sie beim Aufruf in der Bash mit einem Backslash, anderenfalls interpretiert die Shell das Zeichen als History-Befehl und entfernt es aus der Befehlszeile.

> L etwas \!anderes
[...]
.../Musik/The Temptations -  Papa was a rolling stone.mp3.mp3
.../Bilder/png/2-wasserzeichen.png
.../Musik/Frumpy - How the Gypsy was Born.mp3
.../Musik/2/Bots - Was wollen wir trinken.mp3
.../Musik/Byron Metcalf - Heart Warriors+.mp3
.../Bilder/luftbild nokanal wassergrenze.png
[...]

Fzf unterstützt bei den Treffern einen ausgefeilten Vorschaumodus. Als Argument der Option --preview dient dabei eine Befehlszeile zum Erzeugen der Vorschau. Diese erscheint für die aktuelle, mit dem Cursor ausgewählte Datei in einem eigenen Fenster, das Fzf auf der rechten Seite erzeugt (Abbildung 1). Für die Ausgabe in Terminals eignen sich nur Textausgaben, sodass bei vielen Dateien die Metadaten oder die zuvor umgewandelten oder extrahierten Textinhalte anstatt der binären Daten in der Vorschau erscheinen.

Abbildung 1: Mit fzf --preview 'less {}' bietet das Programm eine Vorschau über den Pager Less an, die sich aber in erster Linie für Textdateien eignet.

Eine große Hilfe leistet Less als universelle Vorschau (Listing 5), da sich der Pager mittels Lesspipe [6] besonders gut zur Anzeige unterschiedlicher Dateitypen eignet. Es genügt daher, als Befehl --preview 'less {}' anzugeben, weil dieser Befehl schon bei korrekt installierter Lesspipe direkt in der Lage ist, etwa den Inhalt von Textdateien anzuzeigen, aber auch den von Archiven oder die Metadaten von Multimedia-Dateien.

$ fzf --preview 'Vorschaubefehl'

Sowohl die Position als auch die Größe des Vorschaufensters stellen Sie über die Option --preview-window Position ein. Die wesentlichen Argumente dieser Option sind die Position (top, bottom, left, right), die Größe (in Prozent der Terminalbreite) und der Modus (wrap, cycle und hidden). Diese Angaben geben Sie ohne Leerzeichen und nur durch Doppelpunkte getrennt am Stück ein (Listing 6).

$ fzf --preview-window=top:55%:wrap:cycle

Neben der Vorschau gibt es mit den Aktionen eine weitere Möglichkeit, eine Ansicht der Inhalte zu generieren. Im Programm umfassen die Actions eine ganze Gruppe von Funktionen, die Sie im interaktiven Finder aktivieren. Sie triggern die Actions außerdem durch sogenannte Events. Als solche erkennt Fzf derzeit nur change, wenn sich die Suchanfrage ändert, sowie backward-eof, falls die Suchanfrage leer ist und Sie dennoch mittels [Rückschritt] versuchen, sie zu löschen. Das Change-Event kommt oft zusammen mit first (zum ersten Treffer springen) zum Einsatz, für backward-eof ist abort (Aktion abbrechen) voreingestellt.

Tastenbindungen

Als Besonderheit erlaubt es Fzf, aus dem laufenden Programm heraus weitere Programme aufzurufen. Dieses über die Aktion execute gesteuerte Verfahren bietet vielfältige Möglichkeiten. So öffnen Sie etwa ausgewählte Dateien, um sie dann anzusehen oder zu bearbeiten. Als Argument der Aktion execute erwartet Fzf eine Befehlszeile, die es dann in einer Subshell ausführt. Die Zeichenkette {} steht dabei für die ausgewählten Dateien.

Die Option --bind dient dazu, um Aktionen auf eine Taste oder eine Tastenkombination zu legen. Dabei dürfen Sie mehr als eine Aktion bei einer Tastenbindung verwenden, was ein Beispiel aus der Manpage (Listing 7) praxisnah demonstriert. Beide Formen sind gleichwertig.

fzf --multi --bind 'ctrl-a:select-all+accept'
fzf --multi --bind 'ctrl-a:select-all' --bind 'ctrl-a:+accept'

Das Erstellen eigener Definitionen ermöglicht es, die Bedienung von Fzf an die anderer Programme anzupassen oder neue Funktionen bereitzustellen. Um das Argument von --bind zusammenzufassen, schließen Sie es in einfache oder doppelte Hochkommas ein, falls es Leerzeichen enthält.

Fzf stellt in der aktuellen Version nur eine Teilmenge der Tasten für Bindungen bereit (Tabelle “Unterstützte Tasten”). Andere Kombinationen, wie [Umschalt]+[Eingabe], ignoriert das Programm mit einer Warnung wie un-Supported key: shift-enter. Dafür akzeptiert die Software Mausklicks zusammen mit [Pfeil-oben]+[Pfeil-unten] sowie Doppelklicks. Viele Aktionen löschen schlicht Zeichen oder springen zu bestimmten Positionen in der Zeile. Die Tabelle “Aktionen” fasst einige andere, speziellere Funktionen zusammen. Die meisten davon sind normalerweise nicht an Tasten gebunden, stehen also voreingestellt nicht bereit.

Das Ausführen externer Befehle lässt sich auf zwei Arten erledigen. Mittels der Aktion execute führt Fzf die Befehlszeile aus, wartet bis zum Ende des Befehls und zeigt dann dessen Ausgabe. In vielen Fällen ist das genau das gewünschte Verhalten. Um zu verhindern, dass Fzf wartet – und damit keine Eingaben mehr akzeptiert – schicken Sie die ausgeführten Befehle durch ein angehängtes Ampersand in den Hintergrund. Benötigen Sie die Ausgabe der ausgeführten Befehle nicht, nutzen Sie die Aktion execute-silent. Das Programm startet dann die Befehle, verwirft aber die Ausgabe.

Fazit

Sowohl Fzf als auch Fzy sind nützliche, gut anwendbare Tools, die die Arbeit in vielen Bereichen erleichtern und beschleunigen. An Fzf gefallen die Vielfalt der Funktionen, die flexiblen Möglichkeiten, das Terminal aufzuteilen, sowie insbesondere die Aktionen. Bei Fzy stechen hingegen dessen Schlichtheit und das optionale Einblenden des Scorings ins Auge. Beiden Werkzeugen fehlt allerdings die Möglichkeit, gezielt Einfluss auf die Algorithmen zu nehmen, wie das etwa Agrep erlaubt. (tle/agr)