ugrep
v7.1.1
[ README | Benutzerhandbuch | Indizierung | Benchmarks | Fragen und Antworten]
Option -Q öffnet eine Abfrage-TUI, um Dateien während der Eingabe zu durchsuchen!
ugrep ist schnell, benutzerfreundlich und mit einer Menge neuer Funktionen ausgestattet, die sich die Benutzer gewünscht haben
Enthält eine interaktive TUI mit integrierter Hilfe, Google-ähnliche Suche mit UND/ODER/NICHT-Mustern, Fuzzy-Suche, Suche (verschachtelt) in zip/7z/tar/pax/cpio-Archiven, Tarballs und komprimierten Dateien gz/Z/bz/ bz2/lzma/xz/lz4/zstd/brotli, Binärdateien suchen und hexdumpen, Dokumente wie PDF, doc, docx durchsuchen und in JSON, XML ausgeben, CSV oder Ihr eigenes benutzerdefiniertes Format
Erweiterte Unicode-Regex-Mustersyntax mit mehrzeiligem Mustervergleich, ohne dass spezielle Befehlszeilenoptionen erforderlich sind
Enthält einen Dateiindexer, um die Suche in langsamen und kalten Dateisystemen zu beschleunigen
ein echter Drop-in-Ersatz für GNU grep (vorausgesetzt, Sie kopieren oder verknüpfen ug mit grep sowie mit egrep und fgrep ), im Gegensatz zu anderen beliebten grep, die behaupten, „grep-Alternativen“ oder „Ersatz“ zu sein, wenn diese tatsächlich inkompatible Befehlszeilen implementieren Optionen und verwenden Sie einen inkompatiblen Regex-Matcher, d. h. nur Perl-Regex im Vergleich zu POSIX BRE (grep) und ERE (egrep), wenn ugrep alle Regex-Modi unterstützt
Benchmarks zeigen, dass ugrep (eines der) schnellsten grep ist, das den leistungsstarken DFA-basierten Regex-Matcher RE/flex verwendet
Wenn etwas verbessert oder zu ugrep hinzugefügt werden sollte, lassen Sie es mich wissen!
Oberste Priorität hat die Qualitätssicherung, um weiterhin sicherzustellen, dass ugrep keine Fehler aufweist und zuverlässig ist
Lassen Sie ugrep noch schneller laufen, siehe zum Beispiel #432, #421
Teilen Sie reproduzierbare Leistungsergebnisse
ug ist für die interaktive Nutzung gedacht und lädt eine optionale .ugrep-Konfigurationsdatei mit Ihren Einstellungen im Arbeitsverzeichnis oder Home-Verzeichnis. ug+ durchsucht auch PDFs, Dokumente, E-Books und Bildmetadaten
ugrep für den Batch-Einsatz wie GNU grep ohne .ugrep-Konfigurationsdatei, ugrep+ durchsucht auch PDFs, Dokumente, E-Books und Bildmetadaten
Entspricht standardmäßig Unicode-Mustern und durchsucht automatisch UTF-8-, UTF-16- und UTF-32-codierte Dateien
Entspricht mehreren Zeilen mit n oder R in Regex-Mustern, hierfür sind keine besonderen Optionen erforderlich!
Integrierte Hilfe: ug --help , wobei ug --help WHAT Optionen anzeigt, die sich auf WHAT beziehen, nach dem Sie suchen
ug --help regex , ug --help globs , ug --help fuzzy , ug --help format .
Benutzerfreundlich mit anpassbaren Konfigurationsdateien, die vom Befehl ug für die interaktive Verwendung verwendet werden und eine .ugrep-Konfigurationsdatei mit Ihren Einstellungen lädt
ug PATTERN ... ugrep --config PATTERN ...
ug --save-config ...options-you-want-to-save... speichert eine .ugrep-Konfigurationsdatei im Arbeitsverzeichnis, sodass diese Optionen beim nächsten Ausführen ug dort verwendet werden. Tun Sie dies in Ihrem Home-Verzeichnis, um eine .ugrep-Konfigurationsdatei mit Optionen zu speichern, die Sie im Allgemeinen verwenden möchten.
Interaktive Abfrage-TUI, drücken Sie F1 oder STRG-Z für Hilfe und TAB/UMSCHALT-TAB, um zu Verzeichnissen und Dateien zu navigieren
ug -Q ug -Q -e PATTERN
-Q ersetzt PATTERN in der Befehlszeile, damit Sie Muster interaktiv in die TUI eingeben können. Verwenden Sie in der TUI die Tasten ALT+Buchstaben, um kurze „Buchstabenoptionen“ ein-/auszuschalten, zum Beispiel ALT-n (Option -n ), um Zeilennummern anzuzeigen/auszublenden.
Durchsuchen Sie den Inhalt von Archiven (zip, tar, pax, jar, cpio, 7z) und komprimierten Dateien (gz, Z, bz, bz2, lzma, xz, lz4, zstd, brotli)
ug -z PATTERN ... ug -z --zmax=2 PATTERN ...
Geben Sie -z --zmax=2 an, um komprimierte Dateien und in Archiven verschachtelte Archive zu durchsuchen. Das Argument --zmax kann zwischen 1 (Standard) und 99 liegen und bis zu 99 Dekomprimierungs- und Dearchivierungsschritte zum Durchsuchen verschachtelter Archive umfassen
Suchen Sie mit Google-ähnlichen booleschen Abfragemustern unter Verwendung von -% Mustern mit AND (oder nur einem Leerzeichen), OR (oder einem Balken | ), NOT (oder einem Bindestrich - ), der Verwendung von Anführungszeichen für eine exakte Übereinstimmung und der Gruppierung mit ( ) (siehe unten). die linke Seite unten); oder mit den Optionen -e (als „oder“), --and , --andnot und --not Regex-Mustern (siehe rechts unten):
ug -% 'A B C' ... ug -e 'A' --and 'B' --and 'C' ...
ug -% 'A|B C' ... ug -e 'A' -e 'B' --and 'C' ...
ug -% 'A -B -C' ... ug -e 'A' --andnot 'B' --andnot 'C' ...
ug -% 'A -(B|C)'... ug -e 'A' --andnot 'B' --andnot 'C' ...
ug -% '"abc" "def"' ... ug -e 'QabcE' --and 'QdefE' ...
wobei A , B und C beliebige Regex-Muster sind (verwenden Sie die Option -F , um Zeichenfolgen zu durchsuchen)
Geben Sie die Option -%% ( --bool --files ) an, um die boolesche Abfrage auf Dateien als Ganzes anzuwenden: Eine Datei stimmt überein, wenn alle booleschen Bedingungen durch dateiweite Übereinstimmungsmuster erfüllt sind. Andernfalls gelten boolesche Bedingungen standardmäßig für einzelne Zeilen, da grep-Dienstprogramme im Allgemeinen zeilenbasierte Mustervergleicher sind. Die Option --stats zeigt die Abfrage in lesbarer Form an, nachdem die Suche abgeschlossen ist.
Durchsuchen Sie PDF, Doc, DocX, E-Book und mehr mit ug+ mithilfe von Filtern, die mit Dateinamenerweiterungen verknüpft sind:
ug+ PATTERN ...
oder geben Sie --filter mit einem Dateityp an, um ein Filterdienstprogramm zu verwenden:
ug --filter='pdf:pdftotext % -' PATTERN ...
ug --filter='doc:antiword %' PATTERN ...
ug --filter='odt,docx,epub,rtf:pandoc --wrap=preserve -t plain % -o -' PATTERN ...
ug --filter='odt,doc,docx,rtf,xls,xlsx,ppt,pptx:soffice --headless --cat %' PATTERN ...
ug --filter='pem:openssl x509 -text,cer,crt,der:openssl x509 -text -inform der' PATTERN ...
ug --filter='latin1:iconv -f LATIN1 -t UTF-8' PATTERN ...
Der Befehl ug+ ist derselbe wie der Befehl ug , verwendet jedoch zusätzlich Filter zum Durchsuchen von PDFs, Dokumenten und Bildmetadaten
Zeigen Sie den horizontalen Kontext mit der Option -o ( --only-matching ) und den Kontextoptionen -ABC an, um beispielsweise Übereinstimmungen in sehr langen Zeilen wie Javascript- und JSON-Quellen zu finden:
ug -o -C20 -nk PATTERN longlines.js
-o -C20 passt alle Übereinstimmungen mit Kontext in 20 Zeichen vor und 20 Zeichen nach einer Übereinstimmung an (dh insgesamt 40 Unicode-Zeichen), -nk gibt Zeilen- und Spaltennummern aus.
Finden Sie ungefähre Musterübereinstimmungen mit der Fuzzy-Suche innerhalb der angegebenen Levenshtein-Distanz
ug -Z PATTERN ... ug -Z3 PATTTERN ...
-Zn entspricht bis zu n zusätzlichen, fehlenden oder ersetzten Zeichen, -Z+n entspricht bis zu n zusätzlichen Zeichen, -Zn entspricht bis zu n fehlenden Zeichen und -Z~n entspricht bis zu n ersetzten Zeichen. -Z ist standardmäßig -Z1 .
Fzf-ähnliche Suche mit Regex (oder festen Zeichenfolgen mit -F ), Fuzzy-Matching mit bis zu 4 zusätzlichen Zeichen mit -Z+4 und Wörtern nur mit -w , Verwendung von -%% für dateiweite boolesche Suchen
ug -Q -%% -l -w -Z+4 --sort=best
-l listet die übereinstimmenden Dateien in der TUI auf. Drücken Sie TAB und dann ALT-y um eine Datei anzuzeigen, SHIFT-TAB und Alt-l um zurückzugehen und die Liste der übereinstimmenden Dateien anzuzeigen, sortiert nach der besten Übereinstimmung
Durchsuchen Sie Binärdateien und zeigen Sie Hexdumps mit binären Musterübereinstimmungen an (Unicode-Text oder -U für Bytemuster).
ug --hexdump -U BYTEPATTERN ... ug --hexdump TEXTPATTERN ...
ug -X -U BYTEPATTERN ... ug -X TEXTPATTERN ...
ug -W -U BYTEPATTERN ... ug -W TEXTPATTERN ...
--hexdump=4chC1 zeigt 4 Hexadezimalspalten ohne eine Zeichenspalte c , ohne Hexadezimalabstand h und mit einer zusätzlichen Hexadezimalzeile C1 vor und nach einer Übereinstimmung an.
Schließen Sie Dateien ein, um nach Dateitypen oder „magischen Dateibytes“ zu suchen, oder schließen Sie sie mit ^ aus
ug -t TYPE PATTERN ... ug -t ^TYPE PATTERN ...
ug -M 'MAGIC' PATTERN ... ug -M '^MAGIC' PATTERN ...
Schließen Sie Dateien und Verzeichnisse in die Suche ein, die mit Globs im Gitignore-Stil übereinstimmen, oder schließen Sie sie mit ^ aus
ug -g 'FILEGLOB' PATTERN ... ug -g '^FILEGLOB' PATTERN ...
ug -g 'DIRGLOB/' PATTERN ... ug -g '^DIRGLOB/' PATTERN ...
ug -g 'PATH/FILEGLOB' PATTERN ... ug -g '^PATH/FILEGLOB' PATTERN ...
ug -g 'PATH/DIRGLOB/' PATTERN ... ug -g '^PATH/DIRGLOB/' PATTERN ...
Schließen Sie Dateien für die Suche nach Dateinamenerweiterungen (Suffix) ein oder schließen Sie sie mit ^ aus, einer Abkürzung für -g"*.EXT"
ug -O EXT PATTERN ... ug -O ^EXT PATTERN ...
Versteckte Dateien (Dotfiles) und Verzeichnisse zum Durchsuchen einbeziehen (standardmäßig weggelassen)
ug -. PATTERN ... ug -g'.*,.*/' PATTERN ...
Geben Sie hidden in Ihrer .ugrep-Datei an, um versteckte Dateien immer mit ug zu durchsuchen.
Schließen Sie Dateien aus, die durch .gitignore usw. angegeben sind.
ug --ignore-files PATTERN ... ug --ignore-files=.ignore PATTERN ...
Geben Sie in Ihrer .ugrep-Datei ignore-files an, um sie immer mit ug zu ignorieren. Fügen Sie nach Bedarf weitere ignore-files=... hinzu.
Suchmuster ohne negative Muster („passt zu diesem, aber nicht zu jenem“)
ug -e PATTERN -N NOTPATTERN ... ug -e '[0-9]+' -N 123 ...
Verwenden Sie vordefinierte Regex-Muster, um Quellcode, Javascript, XML, JSON, HTML, PHP, Markdown usw. zu durchsuchen.
ug PATTERN -f c++/zap_comments -f c++/zap_strings ...
ug PATTERN -f php/zap_html ...
ug -f js/functions ... | ug PATTERN ...
Sortieren Sie übereinstimmende Dateien nach Name, bester Übereinstimmung, Größe und Zeit
ug --sort PATTERN ... ug --sort=size PATTERN ...
ug --sort=changed PATTERN ... ug --sort=created PATTERN ...
ug -Z --sort=best PATTERN ... ug --no-sort PATTERN ...
Ausgabeergebnisse in CSV, JSON, XML und benutzerdefinierten Formaten
ug --csv PATTERN ... ug --json PATTERN ...
ug --xml PATTERN ... ug --format='file=%f line=%n match=%O%~' PATTERN ...
ug --help format zeigt Hilfe zu Format- % Feldern für eine benutzerdefinierte Ausgabe an.
Suchen Sie mit den Perl-kompatiblen Regex-Mustern von PCRE und zeigen Sie Untermusterübereinstimmungen an oder ersetzen Sie sie
ug -P PATTERN ... ug -P --format='%1 and %2%~' 'PATTERN(SUB1)(SUB2)' ...
Ersetzen Sie Muster in der Ausgabe mit -P und --replace Ersatztext, der optional % Formatierungsfelder enthält, und verwenden Sie -y um den Rest der Datei durchzuleiten:
ug --replace='TEXT' PATTERN ... ug -y --replace='TEXT' PATTERN ...
ug --replace='(%m:%o)' PATTERN ... ug -y --replace='(%m:%o)' PATTERN ...
ug -P --replace='%1' PATTERN ... ug -y -P --replace='%1' PATTERN ...
ug --help format zeigt Hilfe zu Format- % Feldern an, die optional mit --replace verwendet werden können.
Suchen Sie nach Dateien mit einem bestimmten Kodierungsformat wie ISO-8859-1 bis 16, CP 437, CP 850, MACROMAN, KOI8 usw.
ug --encoding=LATIN1 PATTERN ...
Installieren Sie das neueste ugrep mit Homebrew:
$ brew install ugrep
oder mit MacPorts installieren:
$ sudo port install ugrep
Dadurch werden die Befehle ugrep und ug installiert, wobei ug dasselbe ist wie ugrep , aber auch die Konfigurationsdatei .ugrep lädt, wenn sie im Arbeitsverzeichnis oder Home-Verzeichnis vorhanden ist.
Installieren Sie mit Winget winget install Genivia.ugrep
Oder installieren Sie es mit Chocolatey choco install ugrep
Oder installieren Sie mit Scoop scoop install ugrep
Oder laden Sie die voll funktionsfähige ausführbare Datei ugrep.exe als Release-Artefakt von https://github.com/Genivia/ugrep/releases herunter. Die komprimierte Version enthält die Hauptbinärdatei ugrep.exe sowie ug.exe . Der ug -Befehl, der für die interaktive Verwendung gedacht ist, lädt und liest Einstellungen aus der .ugrep -Konfigurationsdatei (sofern im Arbeitsverzeichnis oder Home-Verzeichnis vorhanden).
Fügen Sie ugrep.exe und ug.exe zu Ihrem Ausführungspfad hinzu: Gehen Sie zu Einstellungen und suchen Sie unter „Einstellung suchen“ nach „Pfad“. Wählen Sie Umgebungsvariablen -> Pfad -> Neu und fügen Sie das Verzeichnis hinzu, in dem Sie die ausführbaren Dateien ugrep.exe und ug.exe abgelegt haben.
Tipp
Praktische Hinweise zur Verwendung ugrep.exe und ug.exe in der Windows-Befehlszeile:
' , sondern stattdessen " ; die meisten Windows-Befehlsdienstprogramme berücksichtigen die einfachen ' als Teil des Befehlszeilenarguments!-g/GLOB anstelle der üblichen GLOB Befehlszeilenargumente angegeben, um Dateien und Verzeichnisse für die Suche auszuwählen, insbesondere bei rekursiven Suchvorgängen."" angeben, das mit allen Eingaben übereinstimmt, kann dies von einigen Windows-Befehlsinterpretern wie Powershell ignoriert werden. In diesem Fall müssen Sie stattdessen die Option --match angeben.R anstelle von n verwenden, um alle Unicode-Zeilenumbrüche abzugleichen, z. B. rn Paare und einzelne r und n . $ apk add ugrep ugrep-doc
Überprüfen Sie https://pkgs.alpinelinux.org/packages?name=ugrep auf Versionsinformationen.
$ pacman -S ugrep
Überprüfen Sie https://archlinux.org/packages/extra/x86_64/ugrep auf Versionsinformationen.
Aktivieren Sie zunächst das EPEL-Repository, dann können Sie ugrep installieren.
$ dnf install ugrep
Überprüfen Sie https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ für Versionsinformationen.
$ apt-get install ugrep
Überprüfen Sie https://packages.debian.org/ugrep auf Versionsinformationen. Um ugrep lokal zu erstellen und auszuprobieren, lesen Sie weiter unten die Schritte zum Erstellen von „Alle Plattformen“.
$ dnf install ugrep
Überprüfen Sie https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ für Versionsinformationen.
$ pkg install ugrep
Überprüfen Sie https://www.freshports.org/textproc/ugrep auf Versionsinformationen.
$ pkgman install cmd:ugrep
Überprüfen Sie https://github.com/haikuports/haikuports/tree/master/app-text/ugrep auf Versionsinformationen. Um ugrep lokal zu erstellen und auszuprobieren, lesen Sie weiter unten die Schritte zum Erstellen von „Alle Plattformen“.
Sie können das Standard-NetBSD-Paketinstallationsprogramm (pkgsrc) verwenden: http://cdn.netbsd.org/pub/pkgsrc/current/pkgsrc/textproc/ugrep/README.html
$ pkg_add ugrep
Überprüfen Sie https://openports.pl/path/sysutils/ugrep auf Versionsinformationen.
$ zypper install ugrep
Überprüfen Sie https://build.opensuse.org/package/show/utilities/ugrep auf Versionsinformationen.
Aktivieren Sie zunächst das EPEL-Repository, dann können Sie ugrep installieren.
$ dnf install ugrep
Überprüfen Sie https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ für Versionsinformationen.
Klonen Sie ugrep mit
$ git clone https://github.com/Genivia/ugrep
Oder besuchen Sie https://github.com/Genivia/ugrep/releases, um eine bestimmte Version herunterzuladen.
Sie können diese jederzeit später hinzufügen, wenn Sie diese Funktionen benötigen:
Option -P (reguläre Perl-Ausdrücke) erfordert entweder die PCRE2-Bibliothek (empfohlen) oder die Boost.Regex-Bibliothek (optionaler Fallback). Wenn PCRE2 nicht installiert ist, installieren Sie PCRE2 z. B. mit sudo apt-get install -y libpcre2-dev oder laden Sie PCRE2 herunter und befolgen Sie die Installationsanweisungen. Alternativ können Sie Boost.Regex herunterladen und ./bootstrap.sh und sudo ./b2 --with-regex install ausführen. Siehe Boost: Erste Schritte.
Für die Option -z (Suche nach komprimierten Dateien und Archiven) muss die zlib-Bibliothek installiert sein. Es ist auf den meisten Systemen installiert. Wenn nicht, installieren Sie es, z. B. mit sudo apt-get install -y libz-dev . Um .bz und .bz2 Dateien zu durchsuchen, installieren Sie die bzip2-Bibliothek (empfohlen), z. B. mit sudo apt-get install -y libbz2-dev . Um .lzma und .xz Dateien zu durchsuchen, installieren Sie die lzma-Bibliothek (empfohlen), z. B. mit sudo apt-get install -y liblzma-dev . Um nach .lz4 Dateien zu suchen, installieren Sie die lz4-Bibliothek (optional, nicht erforderlich), z. B. mit sudo apt-get install -y liblz4-dev . Um nach .zst Dateien zu suchen, installieren Sie die zstd-Bibliothek (optional, nicht erforderlich), z. B. mit sudo apt-get install -y libzstd-dev . Um .br Dateien zu durchsuchen, installieren Sie die Brotli-Bibliothek (optional, nicht erforderlich), z. B. mit sudo apt-get install -y libbrotli-dev . Um .bz3 Dateien zu durchsuchen, installieren Sie die bzip3-Bibliothek (optional, nicht erforderlich), z. B. mit sudo apt-get install -y bzip3 .
Tipp
Auch wenn Ihr System über Befehlszeilen-Dienstprogramme wie bzip2 verfügt, bedeutet das nicht unbedingt, dass die Entwicklungsbibliotheken wie libbz2 installiert sind. Die Entwicklungsbibliotheken sollten installiert sein.
Einige Linux-Systeme sind möglicherweise nicht für das Laden dynamischer Bibliotheken von /usr/local/lib konfiguriert, was beim Ausführen von ugrep zu einem Fehler beim Laden der Bibliothek führt. Um dies zu korrigieren, fügen Sie export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/usr/local/lib" zu Ihrer ~/.bashrc Datei hinzu. Oder führen Sie sudo ldconfig /usr/local/lib aus.
Führen Sie das Skript ./build.sh aus, um ugrep zu erstellen:
$ cd ugrep
$ ./build.sh
Dadurch wird die ausführbare Datei ugrep im Verzeichnis ugrep/src mit ./configure und make -j erstellt und mit make test überprüft. Wenn alle Tests erfolgreich sind, wird die ausführbare Datei von ugrep nach ugrep/bin/ugrep kopiert und der symbolische Link ugrep/bin/ug -> ugrep/bin/ugrep für den Befehl ug hinzugefügt.
Beachten Sie, dass ug mit ugrep identisch ist, aber zusätzlich die Konfigurationsdatei .ugrep lädt, wenn sie im Arbeitsverzeichnis oder Home-Verzeichnis vorhanden ist. Das bedeutet, dass Sie Ihre Standardoptionen für ug in .ugrep definieren können.
Alternative Pfade zu installierten oder lokalen Bibliotheken können mit ./build.sh angegeben werden. So erhalten Sie Hilfe zu den verfügbaren Build-Optionen:
$ ./build.sh --help
Sie können statische ausführbare Dateien erstellen, indem Sie Folgendes angeben:
$ ./build.sh --enable-static
Dies kann fehlschlagen, wenn Bibliotheken nicht statisch verknüpft sind, wie z. B. Brotli. Versuchen Sie es in diesem Fall mit ./build.sh --enable-static --without-brotli .
Sie können ugrep mit aktivierten benutzerdefinierten Standardeinstellungen erstellen, z. B. einem Pager:
$ ./build.sh --enable-pager
Zu den Optionen zum Auswählen von Standardeinstellungen für Builds gehören:
--help zeigt Build-Optionen an--enable-static erstellt statische ausführbare Dateien, wenn möglich--enable-hidden durchsucht immer versteckte Dateien und Verzeichnisse--enable-pager verwendet immer einen Pager, um die Ausgabe auf Terminals anzuzeigen--enable-pretty färbt die Ausgabe an Terminals ein und fügt Dateinamenüberschriften hinzu--disable-auto-color deaktiviert automatische Farben, erfordert die ugrep-Option --color=auto um Farben anzuzeigen--disable-mmap deaktiviert speicherzugeordnete Dateien--disable-sse2 deaktiviert SSE2- und AVX-Optimierungen--disable-avx2 deaktiviert die AVX2- und AVX512BW-Optimierungen, kompiliert jedoch mit SSE2, wenn dies unterstützt wird--disable-neon deaktiviert ARM NEON/AArch64-Optimierungen--with-grep-path der Standard -f Pfad, wenn GREP_PATH nicht definiert ist--with-grep-colors die Standardfarben, wenn GREP_COLORS nicht definiert ist Nachdem der Build abgeschlossen ist, kopieren Sie ugrep/bin/ugrep und ugrep/bin/ug an einen geeigneten Speicherort, beispielsweise in Ihr ~/bin -Verzeichnis. Oder, wenn Sie die Befehle und Manpages ugrep und ug installieren möchten:
$ sudo make install
Dadurch werden auch die Musterdateien mit vordefinierten Mustern für die Option -f unter /usr/local/share/ugrep/patterns/ installiert. Die Option -f überprüft zunächst das Arbeitsverzeichnis auf das Vorhandensein von Musterdateien. Wenn sie nicht gefunden wird, prüft sie die Umgebungsvariable GREP_PATH , um die Musterdateien zu laden. Wenn sie nicht gefunden wird, liest sie die installierten vordefinierten Musterdateien.
Leider behalten Git-Klone keine Zeitstempel bei, was bedeutet, dass Sie möglicherweise auf „WARNUNG: ‚aclocal-1.15‘ fehlt auf Ihrem System“ stoßen. oder dass der Autoheader beim Ausführen make nicht gefunden wurde.
Um dieses Problem zu umgehen, führen Sie Folgendes aus:
$ autoreconf -fi
$ ./build.sh
GCC 8 und höher können Warnungen der Art „Hinweis: Parameterübergabe für Argument ... geändert in GCC 7.1“ erzeugen. Diese Warnungen sollten ignoriert werden.
Zum Erstellen von ugrep in einem Ubuntu-Container ist eine Docker-Datei enthalten.
Entwickler möchten möglicherweise Desinfektionsmittel verwenden, um den ugrep -Code zu überprüfen, wenn sie wesentliche Änderungen vornehmen, beispielsweise um Datenrennen mit dem ThreadSanitizer zu erkennen:
$ ./build.sh CXXFLAGS='-fsanitize=thread -O1 -g'
Wir haben ugrep mit dem Clang AddressSanitizer, MemorySanitizer, ThreadSanitizer und UndefinedBehaviorSanitizer überprüft. Diese Optionen verursachen einen erheblichen Laufzeitaufwand und sollten nicht für den endgültigen Build verwendet werden.
? Zurück zum Inhaltsverzeichnis
Bitte beachten Sie, dass die Befehle ugrep und ug standardmäßig Binärdateien durchsuchen und .gitignore-spezifische Dateien nicht ignorieren, wodurch rekursive Suchleistungsvergleiche nur sinnvoll sind, wenn die Optionen -I und --ignore-files verwendet werden. Um diese Optionen als Standard für ug festzulegen, fügen Sie einfach ignore-binary und ignore-files zu Ihrer .ugrep-Konfigurationsdatei hinzu.
Einen aktuellen Leistungsvergleich des neuesten ugrep finden Sie in den ugrep-Leistungsbenchmarks. Ugrep ist schneller als GNU grep, Silver Searcher, ack, sift. Die Geschwindigkeit von Ugrep übertrifft in den meisten Benchmarks die von Ripgrep.
Definieren wir zunächst den Befehl :grep in Vim, um Dateien rekursiv zu durchsuchen. Fügen Sie dazu die folgenden Zeilen zu Ihrer .vimrc Datei im Stammverzeichnis hinzu:
if executable('ugrep')
set grepprg=ugrep -RInk -j -u --tabs=1 --ignore-files
set grepformat=%f:%l:%c:%m,%f+%l+%c+%m,%-G%f\|%l\|%c\|%m
endif
Dies gibt an, dass mit dem Befehl Vim :grep die Groß-/Kleinschreibung -j nicht beachtet wird. Entfernen Sie für Suchvorgänge, bei denen die Groß-/Kleinschreibung beachtet wird, -j aus grepprg . Mehrere Übereinstimmungen in derselben Zeile werden im Quickfix-Fenster separat aufgelistet. Wenn dies nicht gewünscht ist, entfernen Sie -u aus grepprg . Mit dieser Änderung wird nur die erste Übereinstimmung in einer Zeile angezeigt. Die Option --ignore-files überspringt Dateien, die in .gitignore Dateien angegeben sind, sofern vorhanden. Um die Tiefe rekursiver Suchvorgänge nur auf das aktuelle Verzeichnis zu beschränken, hängen Sie -1 an grepprg an.
Sie können jetzt den Befehl Vim :grep in Vim aufrufen, um Dateien in einem angegebenen PATH nach PATTERN Übereinstimmungen zu durchsuchen:
:grep PATTERN [PATH]
Wenn Sie PATH weglassen, wird das Arbeitsverzeichnis durchsucht. Verwenden Sie % als PATH um nur die aktuell geöffnete Datei in Vim zu durchsuchen:
:grep PATTERN %
Der Befehl :grep zeigt die Ergebnisse in einem Quickfix-Fenster an, mit dem Sie schnell zu den gefundenen Übereinstimmungen springen können.
So öffnen Sie ein Quickfix-Fenster mit der neuesten Trefferliste:
:copen
Doppelklicken Sie in diesem Fenster auf eine Zeile (oder wählen Sie eine Zeile aus und drücken Sie die Eingabetaste), um zur Datei und zum Speicherort der Übereinstimmung in der Datei zu springen. Geben Sie die Befehle :cn und :cp ein, um zum nächsten bzw. vorherigen Treffer zu springen. Um die Suchergebnisse im Quickfix-Fenster zu aktualisieren, greifen Sie einfach darauf zu. Um beispielsweise den mit FIXME gekennzeichneten C++-Quellcode rekursiv im Arbeitsverzeichnis zu durchsuchen:
:grep -tc++ FIXME
So schließen Sie das Quickfix-Fenster:
:cclose
Sie können ugrep -Optionen mit dem Befehl :grep verwenden, um beispielsweise ein- und mehrzeilige Kommentare in der aktuellen Datei auszuwählen:
:grep -f c++/comments %
Um Platz zu sparen, wird im Quickfix nur die erste Zeile eines mehrzeiligen Kommentars angezeigt. Um alle Zeilen einer mehrzeiligen Übereinstimmung anzuzeigen, entfernen Sie %-G aus grepformat .
Ein beliebtes Vim-Tool ist ctrlp.vim, das installiert wird mit:
$ cd ~/.vim
$ git clone https://github.com/kien/ctrlp.vim.git bundle/ctrlp.vim
CtrlP verwendet ugrep , indem es die folgenden Zeilen zu Ihrer .vimrc hinzufügt:
if executable('ugrep')
set runtimepath^=~/.vim/bundle/ctrlp.vim
let g:ctrlp_match_window='bottom,order:ttb'
let g:ctrlp_user_command='ugrep "" %s -Rl -I --ignore-files -3'
endif
Dabei überspringt -I Binärdateien, die Option --ignore-files überspringt in .gitignore Dateien angegebene Dateien, sofern vorhanden, und Option -3 beschränkt die Suche in Verzeichnissen auf drei Ebenen (das Arbeitsverzeichnis und bis zu zwei Ebenen darunter).
Starten Sie Vim und geben Sie dann den Befehl ein:
:helptags ~/.vim/bundle/ctrlp.vim/doc
Um die CtrlP-Dokumentation in Vim anzuzeigen, geben Sie den folgenden Befehl ein:
:help ctrlp.txt
? Zurück zum Inhaltsverzeichnis
Dank Manuel Uberti können Sie ugrep jetzt in Emacs verwenden. Um ugrep anstelle von GNU grep in Emacs zu verwenden, fügen Sie die folgende Zeile zu Ihrer .emacs.d/init.el Datei hinzu:
(setq-default xref-search-program ‘ugrep)
Das bedeutet, dass Emacs-Befehle wie project-find-regexp die auf Xref basieren, jetzt die Leistungsfähigkeit von ugrep nutzen können.
Darüber hinaus ist es möglich, grep in den grep-Befehlen von Emacs zu verwenden. Sie können beispielsweise lgrep mit ugrep ausführen, indem Sie grep-template etwa wie folgt anpassen:
(setq-default grep-template "ugrep --color=always -0Iinr -e <R>")
Wenn Sie nicht über Emacs Version 29 (oder höher) verfügen, können Sie Emacs aus dem Emacs-Master-Zweig herunterladen und erstellen oder die XRef-Integration mit ugrep manuell aktivieren:
(with-eval-after-load 'xref
(push '(ugrep . "xargs -0 ugrep <C> --null -ns -e <R>")
xref-search-program-alist)
(setq-default xref-search-program 'ugrep))
? Zurück zum Inhaltsverzeichnis
Das sofort einsatzbereite ugrep unterstützt alle Standard-GNU/BSD-grep-Befehlszeilenoptionen und verbessert auch viele davon. Einzelheiten finden Sie unter „Bemerkenswerte Verbesserungen gegenüber grep“.
Wenn Sie sich genau an GNU/BSD-Grep-ASCII/LATIN1-Nicht-UTF-Unicode-Muster halten möchten, verwenden Sie die Option -U , um den vollständigen Unicode-Mustervergleich zu deaktivieren.
Tatsächlich wird ugrep mit den Optionen -U , -Y , -. und --sort sorgt dafür, dass es sich genau wie egrep verhält und nur ASCII/LATIN1-Nicht-UTF-Unicode-Muster abgleicht, sodass leere Muster versteckte Dateien abgleichen und durchsuchen können, anstatt sie zu ignorieren. Siehe grep-Äquivalenz.
Sie können praktische grep-Aliase mit oder ohne Optionen -U , -Y , -. und --sort oder schließen Sie nach Wunsch andere Optionen ein.
Oder Sie können ausführbare grep , egrep und fgrep Dateien erstellen, indem Sie ugrep in diese Namen kopieren. Wenn die ausführbare Datei ugrep (oder ugrep.exe ) als grep ( grep.exe ), egrep ( egrep.exe ), fgrep ( fgrep.exe ) kopiert wird, dann Option -U , -Y und -. werden automatisch zusammen mit -G für grep , -E für egrep und -F für fgrep aktiviert. Darüber hinaus ist beim Kopieren als zgrep , zegrep und zfgrep die Option -z aktiviert. Wenn beispielsweise ugrep als zegrep kopiert wird, stehen die Optionen -z , -E , -Y und -. und --sort sind aktiviert.
Ebenso funktionieren Symlinks und Hardlinks zu ugrep gut, um grep , egrep und fgrep Ersetzungen zu erstellen. So erstellen Sie beispielsweise einen Symlink egrep :
sudo ln -s `which ugrep` /opt/local/bin/egrep
Das /opt/local/bin ist nur ein Beispiel und kann sich in Ihrem $path befinden oder auch nicht und kann je nach Ihrem $path bei der Ausführung von egrep gefunden werden oder auch nicht.
ugrep entspricht GNU/BSD grep, wenn die folgenden Optionen verwendet werden:
grep = ugrep -G -U -Y -. --sort -Dread -dread
egrep = ugrep -E -U -Y -. --sort -Dread -dread
fgrep = ugrep -F -U -Y -. --sort -Dread -dread
zgrep = ugrep -z -G -U -Y -. --sort -Dread -dread
zegrep = ugrep -z -E -U -Y -. --sort -Dread -dread
zfgrep = ugrep -z -F -U -Y -. --sort -Dread -dread
Wo:
-U deaktiviert den Unicode-Wide-Character-Mustervergleich, sodass das Muster xa3 beispielsweise mit Byte A3 übereinstimmt und nicht mit dem Unicode-Codepunkt U+00A3, der durch die UTF-8-Sequenz C2 A3 dargestellt wird. Standardmäßig entspricht xa3 in ugrep U+00A3. Wir empfehlen, -U nicht für die Suche nach Textmustern zu verwenden, sondern nur für binäre Suchen oder zum Durchsuchen von Latin-1-Dateien (iso-8859-1), ohne diese Dateien als binär zu melden (seit ugrep v3.5.0).-Y ermöglicht leere Übereinstimmungen, sodass beispielsweise das Muster a* jede Zeile anstelle einer Folge von a s“ findet. Standardmäßig stimmt in ugrep das Muster a* mit einer Folge von a überein. Darüber hinaus stimmt in ugrep das Muster a*b*c* mit dem überein, mit dem es standardmäßig übereinstimmen soll. Siehe Verbesserungen.-. Durchsucht versteckte Dateien (Dotfiles). Standardmäßig werden versteckte Dateien ignoriert, wie die meisten Unix-Dienstprogramme.--sort gibt die nach Pfadnamen sortierte Ausgabe an, wobei zuerst sortierte übereinstimmende Dateien angezeigt werden, gefolgt von sortierten rekursiven Übereinstimmungen in Unterverzeichnissen. Andernfalls werden übereinstimmende Dateien in keiner bestimmten Reihenfolge gemeldet, um die Leistung zu verbessern.-Dread und -dread sind die GNU/BSD-Grep-Standardeinstellungen, werden jedoch nicht empfohlen. Eine Erklärung finden Sie unter „Verbesserungen“.? Zurück zum Inhaltsverzeichnis
Häufig verwendete Aliase zum Hinzufügen zu .bashrc zur Steigerung der Produktivität:
alias uq = 'ug -Q' # interactive TUI search (uses .ugrep config)
alias uz = 'ug -z' # compressed files and archives search (uses .ugrep config)
alias ux = 'ug -U --hexdump' # binary pattern search (uses .ugrep config)
alias ugit = 'ug -R --ignore-files' # works like git-grep & define your preferences in .ugrep config
alias grep = 'ug -G' # search with basic regular expressions (BRE) like grep
alias egrep = 'ug -E' # search with extended regular expressions (ERE) like egrep
alias fgrep = 'ug -F' # find string(s) like fgrep
alias zgrep = 'ug -zG' # search compressed files and archives with BRE
alias zegrep = 'ug -zE' # search compressed files and archives with ERE
alias zfgrep = 'ug -zF' # find string(s) in compressed files and/or archives
alias xdump = 'ugrep -X ""' # hexdump files without searching (don't use .ugrep config)
alias zmore = 'ugrep+ -z -I -+ --pager ""' # view compressed, archived and regular files (don't use .ugrep config)
? Zurück zum Inhaltsverzeichnis
-Q .n übereinstimmen.-U ).--bool ).--ignore-files .-Z .-z .-z .-z und --zmax=NUM gespeichert sind, bis zu NUM Ebenen tief.--filter unter Verwendung von Formatkonvertierungsdienstprogrammen von Drittanbietern als Plugins.-r , um Verzeichnisse rekursiv zu durchsuchen.-. aktiviert).-E als egrep, während -G BRE aktiviert).-J1 ).-W (binäre Übereinstimmungen werden in Hex ausgegeben, wobei Textübereinstimmungen wie gewohnt ausgegeben werden) und -X (alle Übereinstimmungen werden in Hex ausgegeben).--format ).-f verwendet die Umgebungsvariable GREP_PATH oder die vordefinierten Muster, die in /usr/local/share/ugrep/patterns installiert sind. Wenn -f angegeben ist und auch ein oder mehrere -e Muster angegeben sind, gelten die Optionen -F , -x und -w nicht für -f -Muster. Dies soll Verwirrung vermeiden, wenn -f mit vordefinierten Mustern verwendet wird, die mit diesen Optionen möglicherweise nicht mehr richtig funktionieren.-O , -M und -t geben Dateierweiterungen, Dateisignatur-Magic-Byte-Muster bzw. vordefinierte Dateitypen an. Dies ermöglicht die Suche nach bestimmten Dateitypen in Verzeichnisbäumen, beispielsweise mit den rekursiven Suchoptionen -R und -r . Die Optionen -O , -M und -t gelten auch für archivierte Dateien in cpio-, jar-, pax-, tar-, zip- und 7z-Dateien.-k , --column-number , um die Spaltennummer anzuzeigen, wobei der Tabulatorabstand durch Erweitern der Tabulatoren berücksichtigt wird, wie durch die Option --tabs angegeben.-P (reguläre Perl-Ausdrücke) unterstützt Rückverweise (mit --format ) und Lookbehinds, die die PCRE2- oder Boost.Regex-Bibliothek für einen schnellen Perl-Regex-Abgleich mit einer PCRE-ähnlichen Syntax verwenden.-b mit der Option -o oder mit der Option -u zeigt ugrep den genauen Byte-Offset der Musterübereinstimmung anstelle des Byte-Offsets des Anfangs der übereinstimmenden Zeile an, der von GNU/BSD grep gemeldet wird.-u , --ungroup , um nicht mehrere Übereinstimmungen pro Zeile zu gruppieren. Diese Option zeigt für jede weitere Musterübereinstimmung in der Zeile erneut eine übereinstimmende Eingabezeile an. Diese Option ist besonders nützlich mit der Option -c , um die Gesamtzahl der Musterübereinstimmungen pro Datei statt der Anzahl der pro Datei übereinstimmenden Zeilen zu melden.-Y von ugrep ermöglicht den Abgleich leerer Muster. Grepping mit Leer-Matching-Mustern ist seltsam und führt bei GNU-Grep und BSD-Grep zu unterschiedlichen Ergebnissen. Leere Übereinstimmungen werden von ugrep standardmäßig nicht ausgegeben, wodurch Fehler vermieden werden, die zu „zufälligen“ Ergebnissen führen könnten. Beispielsweise stimmt das Muster a* mit GNU/BSD grep mit jeder Zeile in der Eingabe überein und tatsächlich dreimal mit xyz (den leeren Übergängen vor und zwischen x , y und z ). Um leere Übereinstimmungen zuzulassen, ist die ugrep- Option -Y erforderlich. Muster, die mit ^ beginnen oder mit $ enden, wie z. B. ^h*$ , entsprechen leer. Diese Muster aktivieren automatisch die Option -Y .-D, --devices=ACTION wird standardmäßig skip statt read . Dadurch wird verhindert, dass Named Pipes in Verzeichnissen, die rekursiv durchsucht werden, unerwartet hängen bleiben, wie es bei GNU/BSD grep passieren kann, das Geräte standardmäßig read .-d, --directories=ACTION wird standardmäßig skip statt read . Standardmäßig werden in der Befehlszeile angegebene Verzeichnisse durchsucht, jedoch nicht rekursiv tiefer in Unterverzeichnisse hinein.-N PATTERN , bei denen es sich um Muster der Form (?^X) handelt, die alle X Eingaben überspringen und so X aus der Suche entfernen. Negative Muster können beispielsweise verwendet werden, um Zeichenfolgen und Kommentare zu überspringen, wenn im Quellcode nach Bezeichnern gesucht wird, und um Übereinstimmungen zu finden, die nicht in Zeichenfolgen und Kommentaren enthalten sind. Vordefinierte zap -Muster verwenden negative Muster. Verwenden Sie beispielsweise -f cpp/zap_comments , um Musterübereinstimmungen in C++-Kommentaren zu ignorieren.GREP_OPTIONS , da das Verhalten von ugrep auf jedem System portierbar und vorhersehbar sein muss. Auch GNU grep hat GREP_OPTIONS aus diesem Grund aufgegeben. Bitte verwenden Sie den Befehl ug , der die .ugrep-Konfigurationsdatei lädt, die sich im Arbeitsverzeichnis oder im Home-Verzeichnis (falls vorhanden) befindet, oder verwenden Sie Shell-Aliase, um neue Befehle mit spezifischen Suchoptionen zu erstellen.? Zurück zum Inhaltsverzeichnis
So führen Sie eine Suche mithilfe einer Konfigurationsdatei .ugrep durch, die sich im Arbeitsverzeichnis oder Home-Verzeichnis befindet (beachten Sie, dass ug dasselbe ist wie ugrep --config ):
ug PATTERN FILE...
Um eine .ugrep Konfigurationsdatei im Arbeitsverzeichnis zu speichern, bearbeiten Sie diese Datei dann in Ihrem Home-Verzeichnis, um Ihre Einstellungen für ug Standardeinstellungen anzupassen:
ug --save-config
So durchsuchen Sie das Arbeitsverzeichnis und rekursiv tiefer nach main (beachten Sie, dass -r recurse symlinks standardmäßig aktiviert ist, wenn keine Dateiargumente angegeben sind):
ug main
Das Gleiche, aber durchsuchen Sie C++-Quellcodedateien nur rekursiv und ignorieren Sie alle anderen Dateien:
ug -tc++ main
Das Gleiche gilt für die interaktive Abfrage-TUI, beginnend mit dem anfänglichen Suchmuster main (beachten Sie, dass -Q mit einem anfänglichen Muster die Option -e erfordert, da Muster normalerweise interaktiv angegeben werden und alle Befehlszeilenargumente als Dateien/Verzeichnisse betrachtet werden):
ug -Q -tc++ -e main
So suchen Sie nach #define (und # define usw.) mithilfe eines Regex-Musters in C++-Dateien (beachten Sie, dass Muster in Anführungszeichen gesetzt werden sollten, um Shell-Globbing von * und ? zu verhindern):
ug -tc++ '#[t ]*define'
Um nach main als Wort ( -w ) rekursiv zu suchen, ohne Symlinks ( -r ) im Verzeichnis myproject zu folgen, werden die passenden Zeilen- ( -n ) und Spaltennummern ( -k ) neben den übereinstimmenden Zeilen angezeigt:
ug -r -nkw main myproject
Das Gleiche, aber durchsuchen Sie nur myproject ohne tiefer zu rekursieren (beachten Sie, dass Verzeichnisargumente standardmäßig auf einer Ebene durchsucht werden):
ug -nkw main myproject
Das Gleiche, aber durchsuchen Sie myproject und eine Unterverzeichnisebene tiefer (zwei Ebenen) mit -2 :
ug -2 -nkw main myproject
Das Gleiche, aber durchsuchen Sie nur C++-Dateien in myproject und seinen Unterverzeichnissen mit -tc++ :
ug -tc++ -2 -nkw main myproject
Dasselbe, aber auch in Archiven (z. B. ZIP- und TAR-Dateien) und komprimierten Dateien mit -z suchen:
ug -z -tc++ -2 -nkw main myproject
Durchsuchen Sie rekursiv das Arbeitsverzeichnis nach main und ignorieren Sie dabei gitignored-Dateien (z. B. vorausgesetzt, dass sich .gitignore im Arbeitsverzeichnis oder darunter befindet):
ug --ignore-files -tc++ -nkw main
So listen Sie alle Dateien im Arbeitsverzeichnis und tiefer auf, die von .gitignore Dateien nicht ignoriert werden:
ug --ignore-files -l ''
So zeigen Sie die Liste der Dateinamenerweiterungen und „Magic Bytes“ (Shebangs) an, die entsprechend den -t Argumenten durchsucht werden:
ug -tlist
Um alle Shell-Dateien rekursiv aufzulisten, basierend auf Erweiterungen und Shebangs mit -l (beachten Sie, dass '' mit jeder nicht leeren Datei übereinstimmt):
ug -l -tShell ''
? Zurück zum Inhaltsverzeichnis
Um im Quellcode nach main zu suchen und dabei Zeichenfolgen und Kommentarblöcke zu ignorieren, können Sie negative Muster mit der Option -N verwenden, um unerwünschte Übereinstimmungen in in C/C++ zitierten Zeichenfolgen und Kommentarblöcken zu überspringen:
ug -r -nkw -e 'main' -N '"(\.|\r?n|[^\n"])*"|//.*|/*(.*n)*?.**+/' myproject
Das richtig einzugeben ist eine Menge Arbeit! Wenn Sie wie ich sind, möchte ich keine Zeit damit verbringen, mit Regex-Mustern herumzuspielen, wenn ich an etwas Wichtigerem arbeite. Es gibt einen einfacheren Weg, indem Sie die vordefinierten Muster ( -f ) von UGREP verwenden, die mit dem ugrep -Tool installiert sind:
ug -r -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
Diese Abfrage sucht auch über andere Dateien als C/C ++ - Quellcode wie ReadMes, Makefiles usw. Wir überspringen auch Symlinks mit -r . Lassen Sie uns diese Abfrage also verfeinern, indem Sie C/C ++ -Dateien nur mit Option -tc,c++ auswählen und Symlinks zu Dateien und Verzeichnissen mit -R einfügen:
ug -R -tc,c++ -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
Was ist, wenn Sie nur nach dem main der Bezeichner suchen möchten, jedoch nicht als main( in diesem Fall, verwenden Sie ein negatives Muster, um unerwünschte mainh*( Musterübereinstimmungen:
ug -R -tc,c++ -nkw -e 'main' -N 'mainh*(' -f c/zap_strings -f c/zap_comments myproject
Dies verwendet die Optionen -e und -N um explizit ein Muster bzw. ein h Muster anzugeben, wobei im Wesentlichen das Muster main|(?^mainh*() Negative Muster sind nützlich, um Musterübereinstimmungen herauszufiltern, an denen wir nicht interessiert sind.
Nehmen wir als weiteres Beispiel an, wir möchten in C/C ++ - Kommentarblöcken nach dem Wort FIXME suchen. Dazu können wir zuerst die Kommentarblöcke mit UGREPs vordefinierter c/comments -Muster auswählen und dann mit FIXME Zeilen mithilfe einer Pipe auswählen:
ug -R -tc,c++ -nk -f c/comments myproject | ug -w 'FIXME'
Die Filterergebnisse mit Rohren sind im Allgemeinen einfacher als die Verwendung und Logik, die einige Suchwerkzeuge verwenden. Dieser Ansatz folgt dem Unix -Geist, um die Versorgungsunternehmen einfach zu halten und sie in Kombination für komplexere Aufgaben zu verwenden.
Erstellen wir eine sortierte Liste aller im Java -Quellcode gefundenen Kennungen, während Sie Strings und Kommentare überspringen:
ug -R -tjava -f java/names myproject | sort -u
Dies entspricht den Java -Unicode -Identifikatoren unter Verwendung der Regex p{JavaIdentifierStart}p{JavaIdentifierPart}* in patterns/java/names definiert.
Mit herkömmlichen GREP- und Grep-ähnlichen Tools ist es sehr bemüht, rekursiv nach der C/C ++-Quelldatei zu suchen, die die Funktion qsort definiert, und so etwas wie folgt erfordert:
ug -R --include='*.c' --include='*.cpp' '^([ t]*[[:word:]:*&]+)+[ t]+qsort[ t]*([^;n]+$' myproject
Glücklicherweise können wir mit UGREP einfach alle Funktionsdefinitionen in Dateien mit Erweiterung .c oder .cpp mithilfe von Option -Oc,cpp und vordefinierten functions aus auswählen, die mit dem Tool installiert sind, um alle Funktionsdefinitionen zu erstellen. Dann wählen wir die, die wir wollen:
ug -R -Oc,cpp -nk -f c/functions | ug 'qsort'
Beachten Sie, dass wir -tc,c++ verwenden können, um C/C ++ -Dateien auszuwählen. Dies enthält jedoch auch Header -Dateien, wenn wir nur .c und .cpp -Dateien suchen möchten.
Wir können auch Dateien und Verzeichnisse von der Suche überspringen, die in .gitignore definiert sind. Um dies zu tun, verwenden wir --ignore-files um Dateien und Verzeichnisse von rekursiven Suchanfragen auszuschließen, die den Globs in .gitignore übereinstimmen, wenn eine oder mehrere .gitignore Dateien gefunden werden:
ug -R -tc++ --ignore-files -f c++/defines
Dies sucht im Arbeitsverzeichnis nach C ++ -Dateien ( -tc++ ) nach #define Zeilen ( -f c++/defines ), während übersprungen und Verzeichnisse in .gitignore deklariert werden. Wenn Sie dies zu lange finden, um zu tippen, definieren Sie einen Alias, um Github -Verzeichnisse zu durchsuchen:
alias ugit='ugrep -R --ignore-files'
ugit -tc++ -f c++/defines
Zum Hervorheben von Übereinstimmungen, wenn sie durch eine Kette von Rohren gedrückt werden, sollten wir verwenden --color=always :
ugit --color=always -tc++ -f c++/defines | ugrep -w 'FOO.*'
Dies gibt eine farblich hohe Liste aller #define FOO... Makros in C/C ++-Quellcode-Dateien zurück, die in .gitignore definierte Dateien überspringen.
Beachten Sie, dass das Komplement von --exclude nicht --include ist, da Ausschlüsse immer Vorrang vor Einschlüssen haben. Daher können wir die Dateien, die mit --include-from='.gitignore' ignoriert werden, nicht zuverlässig auflisten. Es sind nur mit --include-dir ausdrücklich angegebene Dateien mit --include und Verzeichnissen ausdrücklich angegeben. Die --include-from von Listen von GLIPS, die sowohl Dateien als auch Verzeichnisse als Hinzufügen zu --include bzw --include-dir angesehen werden. Dies bedeutet, dass, wenn Verzeichnisnamen und Verzeichnispfade in dieser Datei nicht explizit aufgeführt sind, sie mit --include-from nicht besucht werden.
Da UGREP überprüft, ob die Eingabe gültig ist, können Sie eine utf-codierte Unicode (sofern nicht -U verwendet wird) als Filter verwendet, um die von einem Programm erzeugte Nicht-UTF-Ausgabe zu ignorieren:
program | ugrep -I ''
Wenn das Programm eine gültige Ausgabe erzeugt, wird die Ausgabe übergeben, andernfalls wird die Ausgabe option -I herausgefiltert. Wenn der Ausgang ursprünglich für einen sehr großen Teil gültig ist, aber von ungültiger Ausgabe folgt, kann UGREP die Ausgabe zunächst angeben, jedoch ohne die ungültige Ausgabe, nach der eine weitere Ausgabe blockiert wird.
Zum Filter von Linien, die gültig sind, ASCII oder UTF-codiert, während Sie Linien entfernen, die nicht sind:
program | ugrep '[p{Unicode}--[n]]+'
Beachten Sie, dass p{Unicode} n übereinstimmt, aber wir möchten nicht mit der gesamten Datei übereinstimmen! Nur Linien mit [p{Unicode}--[n]]+ .
? Zurück zum Inhaltsverzeichnis
Die Seite Ugrep Man:
man ugrep
Um eine Hilfe zu zeigen:
ug --help
Um Optionen zu zeigen, in denen erwähnt wird, WHAT :
ug --help WHAT
Um eine Liste der Optionswerte -t TYPES anzuzeigen:
ug -tlist
Drücken Sie in der interaktiven Abfrage TUI F1 oder Strg-Z für Hilfe und Optionen:
ug -Q
? Zurück zum Inhaltsverzeichnis
--config[=FILE], ---[FILE]
Use configuration FILE. The default FILE is `.ugrep'. The working
directory is checked first for FILE, then the home directory. The
options specified in the configuration FILE are parsed first,
followed by the remaining options specified on the command line.
The ug command automatically loads a `.ugrep' configuration file,
unless --config=FILE or --no-config is specified.
--no-config
Do not load the default .ugrep configuration file.
--save-config[=FILE] [OPTIONS]
Save configuration FILE to include OPTIONS. Update FILE when
first loaded with --config=FILE. The default FILE is `.ugrep',
which is automatically loaded by the ug command. When FILE is a
`-', writes the configuration to standard output. Only part of the
OPTIONS are saved that do not cause searches to fail when combined
with other options. Additional options may be specified by editing
the saved configuration file. A configuration file may be modified
manually to specify one or more config[=FILE] to indirectly load
the specified FILEs, but recursive config loading is not allowed.
Der Befehl ug ist für die kontextabhängige interaktive Suche gedacht und entspricht dem Befehl ugrep --config , um die Konfigurationsdatei .ugrep zu laden, wenn sie im Arbeitsverzeichnis vorhanden sind oder, wenn sie nicht gefunden wurden, im Home-Verzeichnis:
ug PATTERN ...
ugrep --config PATTERN ...
Der Befehl ug sortiert auch Dateien nach Namen pro Verzeichnis, das durchsucht wurde. Eine Konfigurationsdatei enthält NAME=VALUE pro Zeile, wobei NAME der Name einer langen Option ist (ohne -- ) und =VALUE ist ein Argument, das optional ist und abhängig von der Option weggelassen werden kann. Leere Linien und Linien, die mit einer # beginnen, werden ignoriert:
# Color scheme
colors=cx=hb:ms=hiy:mc=hic:fn=hi+y+K:ln=hg:cn=hg:bn=hg:se=
# Disable searching hidden files and directories
no-hidden
# ignore files specified in .ignore and .gitignore in recursive searches
ignore-files=.ignore
ignore-files=.gitignore
Die Befehlszeilenoptionen werden in der folgenden Reihenfolge analysiert: Zuerst wird die Konfigurationsdatei (Standard- oder benannter) geladen, und dann werden die verbleibenden Optionen und Argumente in der Befehlszeile analysiert.
Option --stats zeigt die nach der Suche verwendete Konfigurationsdatei an.
Mit den benannten Konfigurationsdateien sollen benutzerdefinierte Suchaufgaben optimiert werden, indem die Anzahl der Befehlszeilenoptionen auf nur eine ---FILE reduziert wird, um die in FILE angegebene Sammlung zu verwenden. Die Option --config=FILE und ihr abgekürztes Formular ---FILE laden Sie die angegebene Konfigurationsdatei im Arbeitsverzeichnis oder, wenn sie nicht gefunden wurden, im Heimverzeichnis:
ug ---FILE PATTERN ...
ugrep ---FILE PATTERN ...
Ein Fehler wird erstellt, wenn FILE nicht gefunden wird oder nicht gelesen werden kann.
Mit benannte Konfigurationsdateien können eine Sammlung von Optionen definiert werden, die für die Anforderungen einer Aufgabe im Entwicklungsworkflow eines Projekts spezifisch sind. Zum Beispiel, um ungelöste Probleme zu melden, indem Sie den Quellcode und die Dokumentation für Kommentare mit FixMe- und TODO -Elementen überprüfen. Eine solche benannte Konfigurationsdatei kann in einem Projekt lokalisiert werden, indem sie in das Projektverzeichnis platziert oder durch Platzierung in das Home -Verzeichnis global gemacht werden. Für visuelles Feedback kann ein für diese Aufgabe spezifisches Farbschema mit colors in der FILE angegeben werden, um die von einer benannte Konfiguration erzeugte Ausgabe im Gegensatz zur Standardkonfiguration zu identifizieren.
Die Option --save-config Option speichert eine .ugrep Konfigurationsdatei in das Arbeitsverzeichnis unter Verwendung der aktuellen Konfiguration, die mit --config geladen wurde. Dies speichert die aktuelle Konfiguration in Kombination mit zusätzlichen Optionen, wenn auch angegeben. Es werden nur die Optionen gespeichert, die nicht mit anderen Optionen und Optionen in Konflikt geraten können, die sich nicht negativ auf die Suchergebnisse auswirken können.
Die Option --save-config=FILE speichert die Konfiguration in der angegebenen FILE . Die Konfiguration wird in die Standardausgabe geschrieben, wenn FILE a - ist.
Alternativ kann eine Konfigurationsdatei manuell erstellt oder geändert werden. Eine Konfigurationsdatei kann eine oder mehrere config[=FILE] enthalten, um die spezifizierte FILE indirekt zu laden, aber das Laden von Konfigurationen ist untersagt. Der einfachste Weg, um eine Konfigurationsdatei zu erstellen, besteht darin, config oben in der Datei anzugeben, gefolgt von den langen Optionen zum Überschreiben der Standardeinstellungen.
? Zurück zum Inhaltsverzeichnis
-Q[=DELAY], --query[=DELAY]
Query mode: start a TUI to perform interactive searches. This mode
requires an ANSI capable terminal. An optional DELAY argument may
be specified to reduce or increase the response time to execute
searches after the last key press, in increments of 100ms, where
the default is 3 (300ms delay). No whitespace may be given between
-Q and its argument DELAY. Initial patterns may be specified with
-e PATTERN, i.e. a PATTERN argument requires option -e. Press F1
or CTRL-Z to view the help screen. Press F2 or CTRL-Y to invoke a
command to view or edit the file shown at the top of the screen.
The command can be specified with option --view, or defaults to
environment variable PAGER when defined, or EDITOR. Press Tab and
Shift-Tab to navigate directories and to select a file to search.
Press Enter to select lines to output. Press ALT-l for option -l
to list files, ALT-n for -n, etc. Non-option commands include
ALT-] to increase context. See also options --no-confirm, --delay,
--split and --view.
--no-confirm
Do not confirm actions in -Q query TUI. The default is confirm.
--delay=DELAY
Set the default -Q key response delay. Default is 3 for 300ms.
--split
Split the -Q query TUI screen on startup.
--view[=COMMAND]
Use COMMAND to view/edit a file in -Q query TUI by pressing CTRL-Y.
Diese Option startet eine Benutzeroberfläche, um Suchmuster interaktiv einzugeben:
-c , Übereinstimmungen zu zählen. Das Drücken von ALT -C wird erneut deaktiviert -c . Optionen können beim Suchen oder beim Anzeigen des Hilfebildschirms mit der ALT -Taste umgeschaltet werden. Wenn ALT/META-Schlüssel nicht unterstützt werden (z. B. x11 Xterm), drücken Sie Strg-O, gefolgt von der der Option entsprechenden Taste.-g Datei- und Verzeichnisanpassungs-Globs einzugeben, eine von Kommas getrennte Liste der Globore-Glob-Muster im Gitignore-Stil. Presssing ESC gibt die Kontrolle über die Eingabeaufforderung des Abfragemusters zurück (die Globs werden gespeichert). Wenn einem Globus A vorausgeht ! oder A ^ , überspringt Dateien, deren Name mit der GLOB übereinstimmt, wenn eine Globum eine / vollständige Pathnames enthält. Ansonsten werden die Basisnamen abgestimmt. Wenn eine Kugel mit A / endet, werden Verzeichnisse abgestimmt.Q> (normal), F> (feste Zeichenfolgen), G> (Basic Regex), P> (Perl -Matching) und Z> (Fuzzy -Matching). Wenn die Eingabeaufforderung --glob= angezeigt wird, kann eine von Kommas getrennte Liste von Globore-Glob-Muster eingegeben werden. Drücken Sie ESC -Rückgänge zur Steuerung der Muster -Eingabeaufforderung.--view angegebenen Pager anzuzeigen.--view=COMMAND angegeben werden. Andernfalls werden die Variablen der PAGER oder EDITOR verwendet, um den Befehl mit Strg-y aufzurufen. Dateinamen müssen in der Ausgabe aktiviert und sichtbar sein, um diese Funktion zu verwenden.--color gefärbt.DELAY an, wie z. B. 1. niedrigere Werte können die Systemlast jedoch erhöhen, da die Suche nach jeder gedrückten Taste wiederholt initiiert und storniert wird.--heading standardmäßig aktiviert. Drücken Sie Alt-+, um die Überschriften auszuschalten.Abfrage TUI Key Mapping:
| Schlüssel (en) | Funktion |
|---|---|
Alt-key | key |
Alt-/ xxxx / | Fügen Sie Unicode -Hex -Codepunkt U+xxxx ein |
Esc Ctrl-C | zurückgehen oder beenden |
Ctrl-Q | Schnelleingang und Ausgabe Die im Auswahlmodus ausgewählten Ergebnisse |
Tab | Chdir zum Verzeichnis der Datei oben im Bildschirm oder die Datei auswählen |
Shift-Tab | Chdir One Level Up oder DeSelect -Datei |
Enter | Geben Sie den Auswahlmodus ein und wechseln Sie ausgewählte Zeilen, um sie beim Ausgang auszugeben |
Up Ctrl-P | nach oben bewegen |
Down Ctrl-N | nach unten bewegen |
Left Ctrl-B | nach links bewegen |
Right Ctrl-F | nach rechts bewegen |
PgUp Ctrl-G | Anzeige nach einer Seite verschieben |
PgDn Ctrl-D | Verschieben Sie die Anzeige mit einer Seite nach unten |
Alt-Up | Verschieben Sie die Anzeige bis 1/2 Seite (macOS Shift-Up ) |
Alt-Down | Die Anzeige um 1/2 Seite nach unten verschieben (macOS Shift-Down ) |
Alt-Left | Verschieben Sie die Anzeige links bis 1/2 Seite (macOS Shift-Left ) links |
Alt-Right | Anzeige rechts bis 1/2 Seite verschieben (macOS Shift-Right ) |
Home Ctrl-A | Bewegen Sie den Cursor zum Beginn der Linie |
End Ctrl-E | Bewegen Sie den Cursor bis zum Ende der Linie |
Ctrl-K | Nach Cursor löschen |
Ctrl-L | Bildschirm aktualisieren |
Ctrl-O + key | Schalten Sie UGREP-Befehlszeilenoption um, die Alt-key key entspricht |
Ctrl-R F4 | Springe zum Lesezeichen |
Ctrl-S | Springen Sie zum nächsten Dir/Datei/Kontext |
Ctrl-T F5 | Split-Bildschirm umschalten ( --split startet einen Teilenbildschirm-TUI) |
Ctrl-U | Vor Cursor löschen |
Ctrl-V | wörtlicher Charakter |
Ctrl-W | Springen Sie einen Dir/Datei/Kontext zurück |
Ctrl-X F3 | Lesezeichen einstellen |
Ctrl-Y F2 | Zeigen oder bearbeiten die Datei oben auf dem Bildschirm angezeigt |
Ctrl-Z F1 | Hilfe und Optionen anzeigen |
Ctrl-^ | Chdir zurück zum Startarbeitsverzeichnis |
Ctrl-] | Farbe/Mono umschalten |
Ctrl- | Prozess beenden |
Um die Dateien im Arbeitsverzeichnis und unten interaktiv zu durchsuchen:
ug -Q
Gleiches, aber nur auf C ++ - Dateien beschränkt und ignorieren .gitignore Gitignore -Dateien:
ug -Q -tc++ --ignore-files
Um alle Makefiles im Arbeitsverzeichnis und unten interaktiv zu durchsuchen:
ug -Q -g 'Makefile*' -g 'makefile*'
Gleiches, aber für bis zu 2 Verzeichnisse (Arbeiten und eine Unterverzeichnisebene):
ug -Q -2 -g 'Makefile*' -g 'makefile*'
Um den Inhalt von main.cpp interaktiv zu betrachten und zu durchsuchen, wobei -y alle nicht anpassenden Zeilen als Kontext anzeigen:
ug -Q -y main.cpp
Um main.cpp interaktiv zu durchsuchen, beginnend mit dem Suchmuster TODO und einem Übereinstimmungskontext von 5 Zeilen (der Kontext kann interaktiv aktiviert und deaktiviert werden, überschreibt dies auch die Standardkontextgröße von 2 Zeilen):
ug -Q -C5 -e TODO main.cpp
Um den Inhalt eines Archivs anzuzeigen und zu durchsuchen (z. B. ZIP, Tarball):
ug -Q -z archive.tar.gz
So wählen Sie interaktiv Dateien aus project.zip aus, um mit unzip mit dem UGREP -Abfrageauswahlmodus zu dekomprimieren (Drücken Sie die Eingabetaste, um Zeilen auszuwählen):
unzip project.zip `zipinfo -1 project.zip | ugrep -Q`
? Zurück zum Inhaltsverzeichnis
-L, --files-without-match
Only the names of files not containing selected lines are written
to standard output. Pathnames are listed once per file searched.
If the standard input is searched, the string ``(standard input)''
is written.
-l, --files-with-matches
Only the names of files containing selected lines are written to
standard output. ugrep will only search a file until a match has
been found, making searches potentially less expensive. Pathnames
are listed once per file searched. If the standard input is
searched, the string ``(standard input)'' is written.
-R, --dereference-recursive
Recursively read all files under each directory. Follow all
symbolic links to files and directories, unlike -r.
-r, --recursive
Recursively read all files under each directory, following symbolic
links only if they are on the command line. Note that when no FILE
arguments are specified and input is read from a terminal,
recursive searches are performed as if -r is specified.
-S, --dereference-files
When -r is specified, symbolic links to files are followed, but not
to directories. The default is not to follow symbolic links.
--depth=[MIN,][MAX], -1, -2, -3, ... -9, -10, -11, -12, ...
Restrict recursive searches from MIN to MAX directory levels deep,
where -1 (--depth=1) searches the specified path without recursing
into subdirectories. Note that -3 -5, -3-5, and -35 search 3 to 5
levels deep. Enables -r if -R or -r is not specified.
-g GLOBS, --glob=GLOBS
Search only files whose name matches the specified comma-separated
list of GLOBS, same as --include='glob' for each `glob' in GLOBS.
When a `glob' is preceded by a `!' or a `^', skip files whose name
matches `glob', same as --exclude='glob'. When `glob' contains a
`/', full pathnames are matched. Otherwise basenames are matched.
When `glob' ends with a `/', directories are matched, same as
--include-dir='glob' and --exclude-dir='glob'. A leading `/'
matches the working directory. This option may be repeated and may
be combined with options -M, -O and -t to expand searches. See
`ugrep --help globs' and `man ugrep' section GLOBBING for details.
-O EXTENSIONS, --file-extension=EXTENSIONS
Search only files whose filename extensions match the specified
comma-separated list of EXTENSIONS, same as --include='*.ext' for
each `ext' in EXTENSIONS. When `ext' is preceded by a `!' or a
`^', skip files whose filename extensions matches `ext', same as
--exclude='*.ext'. This option may be repeated and may be combined
with options -g, -M and -t to expand the recursive search.
-t TYPES, --file-type=TYPES
Search only files associated with TYPES, a comma-separated list of
file types. Each file type corresponds to a set of filename
extensions passed to option -O and filenames passed to option -g.
For capitalized file types, the search is expanded to include files
with matching file signature magic bytes, as if passed to option
-M. When a type is preceded by a `!' or a `^', excludes files of
the specified type. This option may be repeated.
--stats
Output statistics on the number of files and directories searched,
and the inclusion and exclusion constraints applied.
Wenn keine Dateiargumente angegeben sind und die Eingabe von einem Terminal ausgelesen wird, werden rekursive Suchvorgänge so ausgeführt, wie es -r angegeben wird. Um das Lesen aus Standardeingaben zu erzwingen, geben Sie - als Dateiargument an.
So rekursiv alle nicht leeren Dateien im Arbeitsverzeichnis auflisten:
ug -r -l ''
So auflisten Sie alle nicht leeren Dateien im Arbeitsverzeichnis, aber nicht tiefer (da in diesem Fall ein Dateiargument angegeben ist . Für das Arbeitsverzeichnis):
ug -l '' .
So auflisten Sie alle nicht leeren Dateien im Verzeichnis mydir , aber nicht tiefer (da ein Dateiargument angegeben ist):
ug -l '' mydir
So auflisten Sie alle nicht leeren Dateien im Verzeichnis mydir und tiefer, während Sie Symlinks folgen:
ug -R -l '' mydir
So rekursiv alle nicht leeren Dateien auf dem angegebenen Pfad aufzulisten, während Sie nur Unterverzeichnisse besuchen, dh Verzeichnisse mydir/ und Unterverzeichnisse auf einer Ebene tiefere mydir/*/ werden besucht (beachten Sie, dass -2 -l -l2 werden kann.
ug -2 -l '' mydir
So rekursiv alle nicht leeren Dateien im Verzeichnis mydir aufzulisten, ohne symbolische Links zu folgen (außer in der Befehlszeile wie mydir ):
ug -rl '' mydir
So rekursiv alle Makefiles auflisten, die dem Text CPP entsprechen:
ug -l -tmake 'CPP'
So rekursiv alle Makefile.* Übereinstimmende bin_PROGRAMS :
ug -l -g'Makefile.*' 'bin_PROGRAMS'
So rekursiv alle nicht leeren Dateien mit Erweiterung .SH mit -Osh auflisten:
ug -l -Osh ''
So rekursiv alle Shell -Skripte auflisten, basierend auf Erweiterungen und Schäfer mit -tShell :
ug -l -tShell ''
So rekursiv alle Shell -Skripte auflisten, basierend auf Erweiterungen nur mit -tshell :
ug -l -tshell ''
? Zurück zum Inhaltsverzeichnis
--bool, -%, -%%
Specifies Boolean query patterns. A Boolean query pattern is
composed of `AND', `OR', `NOT' operators and grouping with `(' `)'.
Spacing between subpatterns is the same as `AND', `|' is the same
as `OR' and a `-' is the same as `NOT'. The `OR' operator binds
more tightly than `AND'. For example, --bool 'A|B C|D' matches
lines with (`A' or `B') and (`C' or `D'), --bool 'A -B' matches
lines with `A' and not `B'. Operators `AND', `OR', `NOT' require
proper spacing. For example, --bool 'A OR B AND C OR D' matches
lines with (`A' or `B') and (`C' or `D'), --bool 'A AND NOT B'
matches lines with `A' without `B'. Quoted subpatterns are matched
literally as strings. For example, --bool 'A "AND"|"OR"' matches
lines with `A' and also either `AND' or `OR'. Parentheses are used
for grouping. For example, --bool '(A B)|C' matches lines with `A'
and `B', or lines with `C'. Note that all subpatterns in a Boolean
query pattern are regular expressions, unless -F is specified.
Options -E, -F, -G, -P and -Z can be combined with --bool to match
subpatterns as strings or regular expressions (-E is the default.)
This option does not apply to -f FILE patterns. The double short
option -%% enables options --bool --files. Option --stats displays
the Boolean search patterns applied. See also options --and,
--andnot, --not, --files and --lines.
--files
Boolean file matching mode, the opposite of --lines. When combined
with option --bool, matches a file if all Boolean conditions are
satisfied. For example, --bool --files 'A B|C -D' matches a file
if some lines match `A', and some lines match either `B' or `C',
and no line matches `D'. See also options --and, --andnot, --not,
--bool and --lines. The double short option -%% enables options
--bool --files.
--lines
Boolean line matching mode for option --bool, the default mode.
--and [[-e] PATTERN] ... -e PATTERN
Specify additional patterns to match. Patterns must be specified
with -e. Each -e PATTERN following this option is considered an
alternative pattern to match, i.e. each -e is interpreted as an OR
pattern. For example, -e A -e B --and -e C -e D matches lines with
(`A' or `B') and (`C' or `D'). Note that multiple -e PATTERN are
alternations that bind more tightly together than --and. Option
--stats displays the search patterns applied. See also options
--not, --andnot, and --bool.
--andnot [[-e] PATTERN] ...
Combines --and --not. See also options --and, --not, and --bool.
--not [-e] PATTERN
Specifies that PATTERN should not match. Note that -e A --not -e B
matches lines with `A' or lines without a `B'. To match lines with
`A' that have no `B', specify -e A --andnot -e B. Option --stats
displays the search patterns applied. See also options --and,
--andnot, and --bool.
--stats
Output statistics on the number of files and directories searched,
and the inclusion and exclusion constraints applied.
Beachten Sie, dass die --and --not und --andnot -Optionen -e PATTERN erfordern.
Die -% Option macht alle Muster boolean basiert und unterstützt die folgenden logischen Operationen, die von höchster Vorrang auf die niedrigste Ebene aufgeführt sind:
| Operator | Alternative | Ergebnis |
|---|---|---|
"x" | Passen Sie x buchstäblich und genau wie angegeben (unter Verwendung der Standard Regex Escapes Q und E ) | |
( ) | Boolesche Expressionsgruppierung | |
-x | NOT x | Invertiertes Match, dh Matches, wenn x nicht übereinstimmt |
x|y | x OR y | entspricht den Zeilen mit x oder y |
xy | x AND y | entspricht den Zeilen mit x und y |
x und y sind Untermaterialien, die nicht mit den besonderen Symbolen beginnen | , - und ( (verwenden Sie Zitate oder Flucht, um diese zu entsprechen);
- NOT dasselbe und nehmen Vorrang vor OR , was bedeutet, dass -x|y == (-x)|y zum Beispiel.
| und OR sind gleich und haben Vorrang vor AND was bedeutet, dass xy|z == x (y|z) zum Beispiel;
Die Option --stats zeigt die booleschen Abfragen in der menschlich-lesbaren Form an, die nach Abschluss der Suche in CNF (Konjunktive Normalform) umgewandelt wurden. Um die CNF ohne Suche anzuzeigen, lesen Sie aus der Standardeingabe, die von einem EOF beendet wurde, wie echo | ugrep -% '...' --stats .
Subpatterns sind im Ausgang farblich, außer dass diejenigen, die nicht negiert sind, NOT (ein NOT -Subpattern kann bei Verwendung eines oder nicht-nicht-Musters wie x|-y ) immer noch in einer passenden Zeile angezeigt werden). Beachten Sie, dass sich Untermaterial überlappen kann. In diesem Fall ist nur das erste passende Untermaterial farblich.
Mehrere Zeilen können übereinstimmen, wenn Subpatterns Newlines übereinstimmen. Es gibt jedoch eine Ausnahme: Subpatters, die mit (?=X) Lookaheads enden, können nicht übereinstimmen, wenn X mehrere Zeilen umfasst.
Leere Muster stimmen zu jeder Zeile (GREP -Standard). Daher entspricht -% 'x|""|y' alles und x und y sind nicht farblich. Option -y sollte verwendet werden, um jede Zeile als Kontext anzuzeigen, z. B. -y 'x|y' .
FZF -ähnliche interaktive Abfragen (boolesche Suche mit festen Zeichenfolgen mit Fuzzy -Matching, um EG bis zu 4 zusätzliche Zeichen mit -Z+4 in Wörtern mit -w ) zu ermöglichen, drücken Sie die Registerkarte und Alt -y, um eine Datei mit Übereinstimmungen anzuzeigen. Drücken Sie Shift-TAB und ALT-L, um zur Liste der übereinstimmenden Dateien zurückzukehren:
ug -Q -%% -l -w -F -Z+4 --sort=best
Um alle Dateien rekursiv zu finden, die sowohl hot als auch dog überall in der Datei mit Option enthalten sind --files :
ug -%% 'hot dog'
ug --files -e hot --and dog
Um Linien zu finden, die sowohl hot als auch dog in myfile.txt enthalten:
ug -% 'hot dog' myfile.txt
ug -e hot --and dog myfile.txt
Um Linien zu finden place enthalten, und dann auch hotdog oder taco (oder beides) in myfile.txt :
ug -% 'hotdog|taco place' myfile.txt
ug -e hotdog -e taco --and place myfile.txt
Gleich, aber ausschließliche Linien entsprechen diner :
ug -% 'hotdog|taco place -diner' myfile.txt
ug -e hotdog -e taco --and place --andnot diner myfile.txt
Um Linien mit diner oder Linien zu finden, die sowohl fast als food in myfile.txt aber nicht bad sind, entsprechen:
ug -% 'diner|(fast food -bad)' myfile.txt
Um Linien mit fast food (genau) oder Linien mit diner zu finden, aber nicht bad oder old in myfile.txt :
ug -% '"fast food"|diner -bad -old' myfile.txt
Gleiches, aber mit einem anderen booleschen Ausdruck, der die gleiche Bedeutung hat:
ug -% '"fast food"|diner -(bad|old)' myfile.txt
Um Linien mit diner zu finden, was in myfile.txt good impliziert (dh Zeilen mit good ohne diner und Zeilen mit diner , aber nur denen mit good , was logisch impliziert ist!):
ug -% 'good|-diner' myfile.txt
ug -e good --not diner myfile.txt
Um Linien mit foo und -bar und "baz" in myfile.txt zu finden (nicht das - " sollte mit Escapes und mit --and -e -bar abgestimmt werden):
ug -% 'foo -bar "baz"' myfile.txt
ug -e foo --and -e -bar --and '"baz"' myfile.txt
Suchen Sie myfile.cpp nach Linien mit TODO oder FIXME , aber nicht beide in derselben Zeile, wie XOR:
ug -% 'TODO|FIXME -(TODO FIXME)' myfile.cpp
ug -e TODO -e FIXME --and --not TODO --not FIXME myfile.cpp
? Zurück zum Inhaltsverzeichnis
-e PATTERN, --regexp=PATTERN
Specify a PATTERN to search the input. An input line is selected
if it matches any of the specified patterns. This option is useful
when multiple -e options are used to specify multiple patterns, or
when a pattern begins with a dash (`-'), or to specify a pattern
after option -f or after the FILE arguments.
-f FILE, --file=FILE
Read newline-separated patterns from FILE. White space in patterns
is significant. Empty lines in FILE are ignored. If FILE does not
exist, the GREP_PATH environment variable is used as path to FILE.
If that fails, looks for FILE in /usr/local/share/ugrep/pattern.
When FILE is a `-', standard input is read. This option may be
repeated.
-L, --files-without-match
Only the names of files not containing selected lines are written
to standard output. Pathnames are listed once per file searched.
If the standard input is searched, the string ``(standard input)''
is written.
-N PATTERN, --neg-regexp=PATTERN
Specify a negative PATTERN to reject specific -e PATTERN matches
with a counter pattern. Note that longer patterns take precedence
over shorter patterns, i.e. a negative pattern must be of the same
length or longer to reject matching patterns. Option -N cannot be
specified with -P. This option may be repeated.
-v, --invert-match
Selected lines are those not matching any of the specified
patterns.
-w, --word-regexp
The PATTERN is searched for as a word, such that the matching text
is preceded by a non-word character and is followed by a non-word
character. Word-like characters are Unicode letters, digits and
connector punctuations such as underscore.
-x, --line-regexp
Select only those matches that exactly match the whole line, as if
the patterns are surrounded by ^ and $.
Siehe auch boolesche Abfragemuster mit -%, -%%, -und -Sie für leistungsstärkere Boolesche Abfragemöglichkeiten als die herkömmlichen Optionen für GNU/BSD -GREP.
Zeilen in der Datei myfile.sh , aber keine Zeilen, die übereinstimmen ^[ t]*# :
ug -v '^[ t]*#' myfile.sh
Suchen Sie myfile.cpp nach Linien mit FIXME und urgent , aber nicht Scotty :
ugrep FIXME myfile.cpp | ugrep urgent | ugrep -v Scotty
Gleiches, aber mit -% für boolesche Abfragen:
ug -% 'FIXME urgent -Scotty' myfile.cpp
So suchen Sie nach Dezimalstellen unter Verwendung von Muster d+ , die nicht mit 0 mit dem negativen Muster 0d+ beginnen und 555 ausschließen:
ug -e 'd+' -N '0d+' -N 555 myfile.cpp
Um nach Wörtern zu suchen, beginnend mit disp , ohne display in der Datei myfile.py mit einem "negativen Muster" -N '/<display>' zu verwenden, wobei -N ein zusätzliches negatives Muster angibt, das übereinstimmt: Übereinstimmende Übereinstimmungen:
ug -e '<disp' -N '<display>' myfile.py
So suchen Sie nach Zeilen mit dem Wort display in der Datei myfile.py über das Überspringen dieses Wortes in Zeichenfolgen und Kommentaren, wobei -f Muster in Dateien angibt, die in diesem Fall vordefinierte Muster sind:
ug -n -w 'display' -f python/zap_strings -f python/zap_comments myfile.py
Zeilen anzeigen, die keine leeren Zeilen sind:
ug -x -e '.*' -N 'h*' myfile.py
Gleich, aber mit -v und -x mit h* , dh Muster ^h*$ :
ug -v -x 'h*' myfile.py
So rekursiv alle Python -Dateien auflisten, die das Wort display nicht enthalten, sodass das Wort in Strings und Kommentaren auftritt:
ug -RL -tPython -w 'display' -f python/zap_strings -f python/zap_comments
? Zurück zum Inhaltsverzeichnis
--encoding=ENCODING
The encoding format of the input. The default ENCODING is binary
and UTF-8 which are the same. Note that option -U specifies binary
PATTERN matching (text matching is the default.)
Binär-, ASCII- und UTF-8-Dateien benötigen diese Option nicht, um sie zu durchsuchen. Auch UTF-16- und UTF-32-Dateien erfordern diese Option nicht, um sie zu durchsuchen, wobei angenommen wird, dass die UTF-16- und UTF-32-Dateien wie gewohnt mit einer UTF-BOM (Byte Order Mark) beginnen. Andere Dateicodierungen erfordern eine Option --encoding=ENCODING :
| Codierung | Parameter |
|---|---|
| ASCII | n / A |
| UTF-8 | n / A |
| UTF-16 mit BOM | n / A |
| UTF-32 mit BOM | n / A |
| UTF-16 sein mit Bom | UTF-16 oder UTF-16BE |
| UTF-16 Le W/O BOM | UTF-16LE |
| UTF-32 W/O BOM | UTF-32 oder UTF-32BE |
| UTF-32 W/O BOM | UTF-32LE |
| Latein-1 | LATIN1 oder ISO-8859-1 |
| ISO-8859-1 | ISO-8859-1 |
| ISO-8859-2 | ISO-8859-2 |
| ISO-8859-3 | ISO-8859-3 |
| ISO-8859-4 | ISO-8859-4 |
| ISO-8859-5 | ISO-8859-5 |
| ISO-8859-6 | ISO-8859-6 |
| ISO-8859-7 | ISO-8859-7 |
| ISO-8859-8 | ISO-8859-8 |
| ISO-8859-9 | ISO-8859-9 |
| ISO-8859-10 | ISO-8859-10 |
| ISO-8859-11 | ISO-8859-11 |
| ISO-8859-13 | ISO-8859-13 |
| ISO-8859-14 | ISO-8859-14 |
| ISO-8859-15 | ISO-8859-15 |
| ISO-8859-16 | ISO-8859-16 |
| MAC (cr = newline) | MAC |
| Makroman (Cr = Newline) | MACROMAN |
| Ebcdic | EBCDIC |
| DOS -Code Seite 437 | CP437 |
| DOS -Code Seite 850 | CP850 |
| DOS -Code Seite 858 | CP858 |
| Windows -Code Seite 1250 | CP1250 |
| Windows -Code Seite 1251 | CP1251 |
| Windows -Code Seite 1252 | CP1252 |
| Windows -Code Seite 1253 | CP1253 |
| Windows -Code Seite 1254 | CP1254 |
| Windows -Code Seite 1255 | CP1255 |
| Windows -Code Seite 1256 | CP1256 |
| Windows -Code Seite 1257 | CP1257 |
| Windows -Code Seite 1258 | CP1258 |
| KOI8-R | KOI8-R |
| KOI8-U | KOI8-U |
| Koi8-ru | KOI8-RU |
Beachten Sie, dass Regex-Muster immer in UTF-8 angegeben sind (einschließlich ASCII). Um Binärdateien mit Binärmustern zu durchsuchen, siehe Suchen und Anzeigen von Binärdateien mit -U, -W und -x.
So rekursiv alle Dateien auflisten, die ASCII (dh 7-Bit) sind:
ug -L '[^[:ascii:]]'
So rekursiv alle Dateien auflisten, die nicht-ASCII-, IE UTF-8-, UTF-16- und UTF-32-Dateien mit Nicht-ASCII-Unicode-Zeichen (U+0080 und UP) sind:
ug -l '[^[:ascii:]]'
So überprüfen Sie, ob eine Datei nicht-ASCII-Unicode (U+0080 und UP) enthält:
ug -q '[^[:ascii:]]' myfile && echo "contains Unicode"
Um ungültige Unicode -Zeichen aus einer Datei zu entfernen (beachten Sie, dass -o möglicherweise nicht funktioniert, da binäre Daten erkannt und abgelehnt werden und Neuleitungen hinzugefügt werden, aber --format="%o% prüft nicht Binärer und kopiert die Übereinstimmung" wie ist " ):
ug "[p{Unicode}n]" --format="%o" badfile.txt
So rekursiv Dateien mit ungültigem UTF-Inhalt (dh ungültige UTF-8-Byte-Sequenzen oder Dateien, die UTF-8/16/32 Codepunkte enthalten, die außerhalb des gültigen Unicode-Bereichs enthalten) aufzulisten, indem Sie einen beliebigen Codepunkt mit dem Codepunkt entsprechen . und durch Verwendung eines negativen Musters -N 'p{Unicode}' um jedes gültige Unicode -Zeichen zu ignorieren:
ug -l -e '.' -N 'p{Unicode}'
Zeilen mit lachendem Gesicht emojis anzeigen:
ug '[?-?]' emojis.txt
Die gleichen Ergebnisse werden mit x{hhhh} erhalten, um einen Unicode -Zeichenbereich auszuwählen:
ug '[x{1F600}-x{1F60F}]' emojis.txt
Zeilen von Zeilen mit den Namen Gödel (oder Goedel), Escher oder Bach anzeigen:
ug 'G(ö|oe)del|Escher|Bach' GEB.txt wiki.txt
Suchen Sie in einer UTF-16-Datei, die mit einer UTF-16-BOM gekennzeichnet ist, um nach lorem in einem unteren oder oberen Fall zu suchen:
ug -iw 'lorem' utf16lorem.txt
So durchsuchen Sie utf16lorem.txt, wenn diese Datei keine UTF-16-BOM mithilfe von --encoding hat:
ug --encoding=UTF-16 -iw 'lorem' utf16lorem.txt
So durchsuchen Sie die in ISO-8859-1 codierte Datei spanish-iso.txt :
ug --encoding=ISO-8859-1 -w 'año' spanish-iso.txt
? Zurück zum Inhaltsverzeichnis
-o, --only-matching
Output only the matching part of lines. If -A, -B or -C is
specified, fits the match and its context on a line within the
specified number of columns.
Mehrere Zeilen können mit Mustern übereinstimmen, die Newline -Zeichen entsprechen. Verwenden Sie die Option -o , um nur die Übereinstimmung auszugeben, nicht die vollständigen Zeilen, die übereinstimmen.
Um mit einem n Zeilenumbruch zu entsprechen, enthalten Sie n in das Muster, das dem LF -Zeichen entspricht. r Sie rn rn f n Zeilenumbrüchen n möchten, verwenden Sie R r?n v verwenden +0085, U+2028 und U+2029.
Zu C/C ++ /*...*/ Multi-Line-Kommentaren übereinstimmen:
ug '/*(.*n)*?.**+/' myfile.cpp
Um den C/C ++ -Kommentaren mit den vordefinierten c/comments mit -fc/comments anzupassen, beschränkt sich nur mit Option -o :
ug -of c/comments myfile.cpp
Gleich wie sed -n '/begin/,/end/p' : Alle Linien zwischen einer Linie mit begin und der ersten Zeile end mithilfe von Lazy Repetition übereinstimmen:
ug -o '.*begin(.|n)*?end.*' myfile.txt
? Zurück zum Inhaltsverzeichnis
-A NUM, --after-context=NUM
Output NUM lines of trailing context after matching lines. Places
a --group-separator between contiguous groups of matches. If -o is
specified, output the match with context to fit NUM columns after
the match or shortens the match. See also options -B, -C and -y.
-B NUM, --before-context=NUM
Output NUM lines of leading context before matching lines. Places
a --group-separator between contiguous groups of matches. If -o is
specified, output the match with context to fit NUM columns before
the match or shortens the match. See also options -A, -C and -y.
-C NUM, --context=NUM
Output NUM lines of leading and trailing context surrounding each
matching line. Places a --group-separator between contiguous
groups of matches. If -o is specified, output the match with
context to fit NUM columns before and after the match or shortens
the match. See also options -A, -B and -y.
-y, --any-line
Any line is output (passthru). Non-matching lines are output as
context with a `-' separator. See also options -A, -B, and -C.
--width[=NUM]
Truncate the output to NUM visible characters per line. The width
of the terminal window is used if NUM is not specified. Note that
double wide characters in the output may result in wider lines.
-o, --only-matching
Output only the matching part of lines. If -A, -B or -C is
specified, fits the match and its context on a line within the
specified number of columns.
So zeigen Sie zwei Kontextlinien vor und nach einer passenden Zeile an:
ug -C2 'FIXME' myfile.cpp
Drei Zeilen von Kontext nach einer übereinstimmenden Zeile zu zeigen:
ug -A3 'FIXME.*' myfile.cpp:
Zeigen Sie vor jeder Übereinstimmung mit einer C-Funktionsdefinition eine Kontextlinie an (C-Namen sind nicht-Unicode):
ug -B1 -f c/functions myfile.c
Zeigen Sie vor jeder Übereinstimmung mit einer C ++ - Funktionsdefinition (C ++ -Namen können möglicherweise ein Unicode sein).
ug -B1 -f c++/functions myfile.cpp
Zeigen Sie nicht übereinstimmende Zeilen als Kontext für die Übereinstimmung von Zeilen mit -y :
ug -y -f c++/functions myfile.cpp
Einen Hexdump einer passenden Linie mit einer Zeile von Hexdump -Kontext anzeigen:
ug -C1 -UX 'xaaxbbxcc' a.out
Der Kontext innerhalb einer Zeile wird mit Option -o mit einer Kontextoption angezeigt:
ug -o -C20 'pattern' myfile.cpp
Gleiches, aber mit hübschem Ausgang mit Überschriften, Zeilennummern und Spaltennummern ( -k ) und Zeigen Sie den Kontext:
ug --pretty -oC20 'pattern' myfile.cpp
? Zurück zum Inhaltsverzeichnis
-f FILE, --file=FILE
Read newline-separated patterns from FILE. White space in patterns
is significant. Empty lines in FILE are ignored. If FILE does not
exist, the GREP_PATH environment variable is used as path to FILE.
If that fails, looks for FILE in /usr/local/share/ugrep/pattern.
When FILE is a `-', standard input is read. This option may be
repeated.
--ignore-files[=FILE]
Ignore files and directories matching the globs in each FILE that
is encountered in recursive searches. The default FILE is
`.gitignore'. Matching files and directories located in the
directory of the FILE and in subdirectories below are ignored.
Globbing syntax is the same as the --exclude-from=FILE gitignore
syntax, but files and directories are excluded instead of only
files. Directories are specifically excluded when the glob ends in
a `/'. Files and directories explicitly specified as command line
arguments are never ignored. This option may be repeated to
specify additional files.
-g GLOBS, --glob=GLOBS
Search only files whose name matches the specified comma-separated
list of GLOBS, same as --include='glob' for each `glob' in GLOBS.
When a `glob' is preceded by a `!' or a `^', skip files whose name
matches `glob', same as --exclude='glob'. When `glob' contains a
`/', full pathnames are matched. Otherwise basenames are matched.
When `glob' ends with a `/', directories are matched, same as
--include-dir='glob' and --exclude-dir='glob'. A leading `/'
matches the working directory. This option may be repeated and may
be combined with options -M, -O and -t to expand searches. See
`ugrep --help globs' and `man ugrep' section GLOBBING for details.
-O EXTENSIONS, --file-extension=EXTENSIONS
Search only files whose filename extensions match the specified
comma-separated list of EXTENSIONS, same as --include='*.ext' for
each `ext' in EXTENSIONS. When `ext' is preceded by a `!' or a
`^', skip files whose filename extensions matches `ext', same as
--exclude='*.ext'. This option may be repeated and may be combined
with options -g, -M and -t to expand the recursive search.
-t TYPES, --file-type=TYPES
Search only files associated with TYPES, a comma-separated list of
file types. Each file type corresponds to a set of filename
extensions passed to option -O and filenames passed to option -g.
For capitalized file types, the search is expanded to include files
with matching file signature magic bytes, as if passed to option
-M. When a type is preceded by a `!' or a `^', excludes files of
the specified type. This option may be repeated.
--stats
Output statistics on the number of files and directories searched,
and the inclusion and exclusion constraints applied.
Die Dateitypen sind mit ugrep -tlist aufgeführt. Die Liste basiert auf etablierten Dateiname -Erweiterungen und "magischen Bytes". Wenn Sie einen Dateityp haben, der nicht aufgeführt ist, verwenden Sie Optionen -O und/oder -M . Möglicherweise möchten Sie einen Alias definieren, z. B. alias ugft='ugrep -Oft' als Kurzschrift, um Dateien mit Dateiname -Suffix zu durchsuchen .ft
Um Funktionsdefinitionen in C/C ++ -Dateien ( .h , .hpp , .c , .cpp usw.) rekursiv anzuzeigen, mit Zeilennummern mit -tc++ , -o , -n und -f c++/functions :
ug -on -tc++ -f c++/functions
Funktionsfunktionsdefinitionen in .c und .cpp -Dateien mit Zeilennummern mit -Oc,cpp , -o , -n und -f c++/functions rekursiv anzeigen:
ug -on -Oc,cpp -f c++/functions
So rekursiv alle Shell -Dateien mit -tShell auf die Dateiname -Erweiterungen und -Dateien mit Shell Shebangs auflisten, mit Ausnahme von Dateien mit Suffix .sh :
ug -l -tShell -O^sh ''
So rekursiv alle Nicht -Schalen -Dateien mit -t^Shell auflisten:
ug -l -t^Shell ''
So rekursiv alle Shell -Dateien mit Shell Shebangs auflisten, die keine Shell -Dateinamen -Erweiterungen haben:
ug -l -tShell -t^shell ''
So suchen Sie nach Zeilen mit FIXME in C/C ++-Kommentaren, ohne FIXME in Multi-Line-Zeichenfolgen:
ug -n 'FIXME' -f c++/zap_strings myfile.cpp
So lesen Sie Muster TODO und FIXME von Standardeingaben zu Übereinstimmungen in der Eingabe, während Sie Übereinstimmungen in C ++ - Zeichenfolgen ausschließen:
ug -on -f - -f c++/zap_strings myfile.cpp <<END
TODO
FIXME
END
So anzeigen XML -Element- und Attribut -Tags in einer XML -Datei angezeigt, die auf den passenden Teil mit -o beschränkt ist, ausgenommen Tags, die in (Multi -Line -Kommentaren) platziert sind:
ug -o -f xml/tags -f xml/zap_comments myfile.xml
? Zurück zum Inhaltsverzeichnis
-z, --decompress
Search compressed files and archives. Archives (.cpio, .pax, .tar)
and compressed archives (e.g. .zip, .7z, .taz, .tgz, .tpz, .tbz,
.tbz2, .tb2, .tz2, .tlz, .txz, .tzst) are searched and matching
pathnames of files in archives are output in braces. When used
with option --zmax=NUM, searches the contents of compressed files
and archives stored within archives up to NUM levels. If -g, -O,
-M, or -t is specified, searches files stored in archives whose
filenames match globs, match filename extensions, match file
signature magic bytes, or match file types, respectively.
Supported compression formats: gzip (.gz), compress (.Z), zip, 7z,
bzip2 (requires suffix .bz, .bz2, .bzip2, .tbz, .tbz2, .tb2, .tz2),
lzma and xz (requires suffix .lzma, .tlz, .xz, .txz),
lz4 (requires suffix .lz4),
zstd (requires suffix .zst, .zstd, .tzst),
brotli (requires suffix .br),
bzip3 (requires suffix .bz3).
--zmax=NUM
When used with option -z (--decompress), searches the contents of
compressed files and archives stored within archives by up to NUM
expansion stages. The default --zmax=1 only permits searching
uncompressed files stored in cpio, pax, tar, zip and 7z archives;
compressed files and archives are detected as binary files and are
effectively ignored. Specify --zmax=2 to search compressed files
and archives stored in cpio, pax, tar, zip and 7z archives. NUM
may range from 1 to 99 for up to 99 decompression and de-archiving
steps. Increasing NUM values gradually degrades performance.
Dateien, die mit GZIP ( .gz ), Compress ( .Z ), BZIP2 ( .bz , .bz2 , .bzip2 ), LZMMA ( .lzma ), xz ( .xz ), lz4 ( .lz4 ), ZSTD (.zst, .ZST, komprimiert wurden .zst komprimiert. .zstd ), brotli ( .br ) und bzip3 ( .bz3 ) werden mit Option durchsucht -z Wenn die entsprechenden Bibliotheken mit UGREP installiert und kompiliert werden. Bei dieser Option müssen keine Dateien komprimiert werden. Unkomprimierte Dateien werden auch durchsucht, obwohl langsamer.
Andere Komprimierungsformate können mit UGREP -Filtern durchsucht werden.
Archive (CPIO, JAR, PAX, TAR, ZIP und 7Z) werden mit Option -z durchsucht. Regelmäßige Dateien in einem Archiv, das übereinstimmt, werden mit den Archiv -Pfadnamen ausgegeben, die in { und } Klammern eingeschlossen sind. Unterstützte Teerformate sind V7, Ustar, GNU, Oldgnu und Pax. Unterstützte CPIO -Formate sind ODC, NewC und CRC. Nicht unterstützt ist das veraltete nicht portable alte binäre CPIO-Format. Archivformate CPIO, TAR und PAX werden automatisch mit Option -z anhand ihres Inhalts erkannt, unabhängig von ihrem Dateinamen -Suffix.
Standardmäßig werden unkomprimierte Archive, die in ZIP -Archiven gespeichert sind, auch durchsucht: Alle in ZIP- und 7Z -Archive gespeicherten CPIO-, PAX- und TAR -Dateien werden automatisch erkannt und gesucht. Standardmäßig werden komprimierte Dateien, die in Archiven gespeichert sind, nicht erkannt, z. B. in TAR -Dateien gespeicherte ZIP -Dateien werden nicht durchsucht, sondern alle komprimierten Dateien und Archive werden so durchsucht, als ob sie Binärdateien sind, ohne sie zu dekomprimieren.
Geben Sie --zmax=NUM an Sucharchive an, die komprimierte Dateien und Archive für bis zu NUM Ebenen enthalten. Der Wert der NUM kann zwischen 1 und 99 für bis zu 99 Dekompressionen und de-alchivierende Schritte reichen, um bis zu 99 verschachtelte Archive zu erweitern. Größer --zmax=NUM beeinträchtigen die Leistung. Es ist unwahrscheinlich, dass Sie jemals 99 als --zmax=2 für die meisten praktischen Anwendungsfälle benötigen, z. B. in TAR -Dateien gesucht werden.
Wenn Option -z mit Optionen -g , -O , -M oder -t verwendet wird, werden Archive und komprimierte und unkomprimierte Dateien, die den Dateinamen -Auswahlkriterien (GLOB, Erweiterung, magische Bytes oder Dateityp) übereinstimmen, nur durchsucht. Beispielsweise sucht ugrep -r -z -tc++ C ++ -Dateien wie main.cpp und ZIP- und TAR -Archive, die C ++ -Dateien wie main.cpp enthalten. Ebenfalls in der Suche enthalten sind C ++ - Dateien wie main.cpp.gz und main.cpp.xz , wenn sie vorhanden sind. Auch jeder CPIO-, PAX-, TAR-, ZIP- und 7Z -Archive, wenn sie vorhanden sind, werden nach C ++ - Dateien gesucht, die sie enthalten, wie z. B. main.cpp . Verwenden Sie die Option --stats , um eine Liste der auf Filterdatei -Pfadnamen angewendeten Glob -Muster in der rekursiven Suche und beim Durchsuchen von Archivinhalten anzuzeigen.
Wenn Option -z mit Optionen -g , -O , -M oder -t verwendet wird, um CPIO-, JAR-, PAX-, TAR-, ZIP- und 7Z -Archive zu durchsuchen, werden archivierte Dateien, die den Dateinamenauswahlkriterien entsprechen, nur durchsucht.
Die GZIP-, Komprimierungs- und ZIP-Formate werden automatisch erkannt, was beim Lesen von gzip-komprimierten Daten aus Standardeingaben nützlich ist, z. B. aus einem Rohr umgeleitet. Andere Komprimierungsformate erfordern ein Dateiname -Suffix: .bz , .bz2 , oder .bzip2 für bzip2, .lzma für lzma, .xz für xz, .lz4 für lz4, .zst oder .zstd für zstd, .br für brotli und .bz3 für BZIP3. Auch das komprimierte Teerarchiv -Verurteilungen .taz , .tgz und .tpz für gzip, .tbz , .tbz2 , .tb2 und .tz2 für bzip2, .tlz für lzma, .txz für xz und .tzst für zstd werden erkannt. Um diese Formate mit UGREP aus Standardeingang zu durchsuchen, verwenden Sie die Option --label='stdin.bz2' für BZIP2, --label='stdin.lzma' für LZMA, --label='stdin.xz' für XZ, -für XZ, --label='stdin.lz4 für LZ4 und --label='stdin.zst für ZSTD und so weiter. Der Name stdin ist willkürlich und kann weggelassen werden:
| Format | Dateiname -Suffix | TAR/PAX -Archiv -Kurzsuffix | Suffix erforderlich? | Ugrep von Stdin | Bibliothek |
|---|---|---|---|---|---|
| gzip | .gz | .taz , .tgz , .tpz | NEIN | automatisch | libz |
| Kompresse | .Z | .taZ , .tZ | NEIN | automatisch | eingebaut |
| Reißverschluss | .zip , .zipx , .ZIP | NEIN | automatisch | libz | |
| 7zip | .7z | Ja | --label=.7z | eingebaut | |
| BZIP2 | .bz , .bz2 , .bzip2 | .tb2 , .tbz , .tbz2 , .tz2 | Ja | --label=.bz2 | libbz2 |
| Lzma | .lzma | .tlz | Ja | --label=.lzma | LIBLZMA |
| xz | .xz | .txz | Ja | --label=.xz | LIBLZMA |
| LZ4 | .lz4 | Ja | --label=.lz4 | liblz4 | |
| ZSTD | .zst , .zstd | .tzst | Ja | --label=.zst | libzstd |
| Brotli | .br | Ja | --label=.br | libbrotlidec | |
| BZIP3 | .bz3 | Ja | --label=.bz3 | libbzip3 |
Die Formate GZIP-, BZIP2-, XZ-, LZ4- und ZSTD -Formate unterstützen verkettete komprimierte Dateien. Verkettete komprimierte Dateien werden als eine einzige Datei durchsucht.
Unterstützte Zip -Komprimierungsmethoden werden (0), Deflate (8), BZIP2 (12), LZMA (14), XZ (95) und ZSTD (93) gespeichert. Die Methoden BZIP2-, LZMA-, XZ- und ZSTD -Methoden erfordern, dass UGREP mit den entsprechenden Kompressionsbibliotheken kompiliert wird.
Die Suche nach verschlüsselten Zip -Archiven wird nicht unterstützt (möglicherweise in zukünftigen Veröffentlichungen, abhängig von Anfragen nach Verbesserungen).
Durch die Suche nach 7zip -Archiven ist viel mehr RAM und mehr Zeit im Vergleich zu anderen Methoden erforderlich. Die 7ZIP -LZMMA -SDK -Implementierung unterstützt kein Streaming und erfordert eine physische 7Z -Datei. Dies bedeutet, dass 7Z -Dateien nicht durchsucht werden können, wenn sie innerhalb der Archive verschachtelt sind. Am besten vermeiden 7zip. Die Unterstützung für 7zip kann mit ./build.sh --disable-7zip deaktiviert werden, um UGREP zu erstellen.
Option -z verwendet Threads für die Aufgabeparallelität, um die Suche nach größeren Dateien zu beschleunigen, indem der Dekompressor gleichzeitig mit einer Suche nach dem dekomprimierten Stream ausgeführt wird.
So auflisten Sie alle nicht leeren Dateien auf, die in einem package.zip Archiv gespeichert sind, einschließlich des Inhalts aller CPIO-, PAX-, TAR-, ZIP- und 7Z-Dateien, die darin gespeichert sind:
ug --zmax=2 -z -l '' package.zip
Gleiches, aber listet nur die Python -Quellcode -Dateien auf, einschließlich Skripten, die Python aufrufen, mit Option -tPython ( ugrep -tlist FÜR DENTAION):
ug --zmax=2 -z -l -tPython '' package.zip
So suchen Sie Python -Anwendungen, die als TAR -Datei mit ihren Abhängigkeiten als Räder (ZIP -Dateien mit Python -Code) verteilt sind, nach dem Wort my_class in app.tgz :
ug --zmax=2 -z -tPython -w my_class app.tgz
Um rekursiv C ++ - Dateien einschließlich komprimierter Dateien nach dem Wort my_function zu durchsuchen, während Sie C- und C ++ - Kommentare überspringen:
ug -z -r -tc++ -Fw my_function -f cpp/zap_comments
So durch die Suche nach BZIP2-, LZMA-, XZ-, LZ4- und ZSTD -Komprimierungsdaten zur Standardeingabe, Option --label können verwendet werden, um die Erweiterung anzugeben, die dem Komprimierungsformat entspricht, um Dekompression zu erzwingen, wenn die BZIP2 -Erweiterung nicht für UGREP verfügbar ist: z.
cat myfile.bz2 | ugrep -z --label='stdin.bz2' 'xyz'
So durchsuchen Sie die Datei main.cpp in project.zip für TODO und FIXME -Zeilen:
ug -z -g main.cpp -w -e 'TODO' -e 'FIXME' project.zip
So durchsuchen Sie Tarball project.tar.gz nach C ++ - Dateien mit TODO und FIXME -Zeilen:
ug -z -tc++ -w -e 'TODO' -e 'FIXME' project.tar.gz
Um Dateien zu durchsuchen, die dem Glob *.txt in project.zip nach der Word license in jedem Fall entsprechen (Beachten Sie, dass das Argument -g Glob zitiert werden muss):
ug -z -g '*.txt' -w -i 'license' project.zip
So anzeigen und durch alle C ++ - Dateien in Tarball project.tgz anzeigen:
ug --pager -z -tc++ '' project.tgz
So listen die Dateien auf, die mit dem Gitignore-Stil GLIB /**/projects/project1.* in projects.tgz übereinstimmen, indem Dateien im Archiv des Textes December 12 ausgewählt werden:
ug -z -l -g '/**/projects/project1.*' -F 'December 12' projects.tgz
So sehen Sie die Daten meta -inf/Manifest.mf in einer JAR -Datei mit -Ojar und -OMF an, um die JAR -Datei und die darin -Ojar MF Standardeingabe stattdessen):
ug -z -h -OMF,jar '' my.jar
Um C ++ -Dateien zu extrahieren, die FIXME aus project.tgz enthalten, verwenden wir -m1 mit --format="'%z '" um eine platz getrennte Liste von Pathnames der Datei zu generieren, die sich im Archiv befinden, das mit dem Wort FIXME übereinstimmt:
tar xzf project.tgz `ugrep -z -l -tc++ --format='%z ' -w FIXME project.tgz`
Um eine Tiefe-First-Suche mit find durchzuführen, verwenden Sie cpio und ugrep um die Dateien zu durchsuchen:
find . -depth -print | cpio -o | ugrep -z 'xyz'
? Zurück zum Inhaltsverzeichnis
--ignore-files[=FILE]
Ignore files and directories matching the globs in each FILE that
is encountered in recursive searches. The default FILE is
`.gitignore'. Matching files and directories located in the
directory of the FILE and in subdirectories below are ignored.
Globbing syntax is the same as the --exclude-from=FILE gitignore
syntax, but files and directories are excluded instead of only
files. Directories are specifically excluded when the glob ends in
a `/'. Files and directories explicitly specified as command line
arguments are never ignored. This option may be repeated to
specify additional files.
-M MAGIC, --file-magic=MAGIC
Only files matching the signature pattern MAGIC are searched. The
signature "magic bytes" at the start of a file are compared to
the MAGIC regex pattern. When matching, the file will be searched.
When MAGIC is preceded by a `!' or a `^', skip files with matching
MAGIC signatures. This option may be repeated and may be combined
with options -O and -t to expand the search. Every file on the
search path is read, making searches potentially more expensive.
-O EXTENSIONS, --file-extension=EXTENSIONS
Search only files whose filename extensions match the specified
comma-separated list of EXTENSIONS, same as --include='*.ext' for
each `ext' in EXTENSIONS. When `ext' is preceded by a `!' or a
`^', skip files whose filename extensions matches `ext', same as
--exclude='*.ext'. This option may be repeated and may be combined
with options -g, -M and -t to expand the recursive search.
-t TYPES, --file-type=TYPES
Search only files associated with TYPES, a comma-separated list of
file types. Each file type corresponds to a set of filename
extensions passed to option -O and filenames passed to option -g.
For capitalized file types, the search is expanded to include files
with matching file signature magic bytes, as if passed to option
-M. When a type is preceded by a `!' or a `^', excludes files of
the specified type. This option may be repeated.
-g GLOBS, --glob=GLOBS
Search only files whose name matches the specified comma-separated
list of GLOBS, same as --include='glob' for each `glob' in GLOBS.
When a `glob' is preceded by a `!' or a `^', skip files whose name
matches `glob', same as --exclude='glob'. When `glob' contains a
`/', full pathnames are matched. Otherwise basenames are matched.
When `glob' ends with a `/', directories are matched, same as
--include-dir='glob' and --exclude-dir='glob'. A leading `/'
matches the working directory. This option may be repeated and may
be combined with options -M, -O and -t to expand searches. See
`ugrep --help globs' and `man ugrep' section GLOBBING for details.
--stats
Output statistics on the number of files and directories searched,
and the inclusion and exclusion constraints applied.
So rekursiv alle Dateien auflisten, die mit #! Shebangs:
ug -l -M'#!' ''
So rekursiv alle Dateien auflisten, die mit # beginnen, aber nicht mit #! Shebangs:
ug -l -M'#' -M'^#!' ''
So rekursiv alle Python -Dateien (Erweiterung .py oder ein Schebang) mit -tPython auflisten:
ug -l -tPython ''
So rekursiv alle Nicht -Schalen -Dateien mit -t^Shell auflisten:
ug -l -t^Shell ''
To recursively list Python files (extension .py or a shebang) that have import statements, including hidden files with -. :
ug -l. -tPython -f python/imports
? Back to table of contents
-Z[best][+-~][MAX], --fuzzy=[best][+-~][MAX]
Fuzzy mode: report approximate pattern matches within MAX errors.
The default is -Z1: one deletion, insertion or substitution is
allowed. If `+`, `-' and/or `~' is specified, then `+' allows
insertions, `-' allows deletions and `~' allows substitutions. For
example, -Z+~3 allows up to three insertions or substitutions, but
no deletions. If `best' is specified, then only the best matching
lines are output with the lowest cost per file. Option -Zbest
requires two passes over a file and cannot be used with standard
input or Boolean queries. Option --sort=best orders matching files
by best match. The first character of an approximate match always
matches a character at the beginning of the pattern. To fuzzy
match the first character, replace it with a `.' or `.?'. Option
-U applies fuzzy matching to ASCII and bytes instead of Unicode
text. No whitespace may be given between -Z and its argument.
The beginning of a pattern always matches the first character of an approximate match as a practical strategy to prevent many false "randomized" matches for short patterns. This also greatly improves search speed. Make the first character optional to optionally match it, eg p?attern or use a dot as the start of the pattern to match any wide character (but this is slow).
Line feed ( n ) and NUL ( ) characters are never deleted or substituted to ensure that fuzzy matches do not extend the pattern match beyond the number of lines specified by the regex pattern.
Option -U ( --ascii or --binary ) restricts fuzzy matches to ASCII and binary only with edit distances measured in bytes. Otherwise, fuzzy pattern matching is performed with Unicode patterns and edit distances are measured in Unicode characters.
Option --sort=best orders files by best match. Files with at least one exact match anywhere in the file are shown first, followed by files with approximate matches in increasing minimal edit distance order. That is, ordered by the minimum error (edit distance) found among all approximate matches per file.
To recursively search for approximate matches of the word foobar with -Z , ie approximate matching with one error, eg Foobar , foo_bar , foo bar , fobar and other forms with one missing, one extra or one deleted character:
ug -Z 'foobar'
Same, but matching words only with -w and ignoring case with -i :
ug -Z -wi 'foobar'
Same, but permit up to 2 insertions with -Z+2 , no deletions/substitutions (matches up to 2 extra characters, such as foos bar ), insertions-only offers the fastest fuzzy matching method:
ug -Z+3 -wi 'foobar'
Same, but sort matches from best (at least one exact match or fewest fuzzy match errors) to worst:
ug -Z+3 -wi --sort=best 'foobar'
Note: because sorting by best match requires two passes over the input files, the efficiency of concurrent searching is significantly reduced.
Same, but with customized formatting to show the edit distance "cost" of the approximate matches with format field %Z and %F to show the pathname:
ug -Z+3 -wi --format='%F%Z:%O%~' --sort=best 'foobar'
Same, but this time count the matches with option -c and display them with a custom format using %m , where %Z is the average cost per match:
ug -c -Z+3 -wi --format='%F%Z:%m%~' --sort=best 'foobar'
Note: options -c and -l do not report a meaningful %Z value in the --format output, because %Z is the edit distance cost of a single match.
? Back to table of contents
--hidden, -.
Search hidden files and directories.
To recursively search the working directory, including hidden files and directories, for the word login in shell scripts:
ug -. -tShell 'login'
? Back to table of contents
--filter=COMMANDS
Filter files through the specified COMMANDS first before searching.
COMMANDS is a comma-separated list of `exts:command [option ...]',
where `exts' is a comma-separated list of filename extensions and
`command' is a filter utility. Files matching one of `exts' are
filtered. When `exts' is a `*', all files are filtered. One or
more `option' separated by spacing may be specified, which are
passed verbatim to the command. A `%' as `option' expands into the
pathname to search. For example, --filter='pdf:pdftotext % -'
searches PDF files. The `%' expands into a `-' when searching
standard input. When a `%' is not specified, a filter utility
should read from standard input and write to standard output.
Option --label=.ext may be used to specify extension `ext' when
searching standard input. This option may be repeated.
--filter-magic-label=LABEL:MAGIC
Associate LABEL with files whose signature "magic bytes" match the
MAGIC regex pattern. Only files that have no filename extension
are labeled, unless +LABEL is specified. When LABEL matches an
extension specified in --filter=COMMANDS, the corresponding command
is invoked. This option may be repeated.
The --filter option associates one or more filter utilities with specific filename extensions. A filter utility is selected based on the filename extension and executed by forking a process: the utility's standard input reads the open input file and the utility's standard output is searched. When a % is specified as an option to the utility, the % is expanded to the pathname of the file to open and read by the utility.
When a specified utility is not found on the system, an error message is displayed. When a utility fails to produce output, eg when the specified options for the utility are invalid, the search is silently skipped.
Filtering does not apply to files stored in archives and compressed files. A filter is usually applied to a file that is physically stored in the file system. Archived files are not physically stored.
Common filter utilities are cat (concat, pass through), head (select first lines or bytes) tr (translate), iconv and uconv (convert), and more advanced utilities, such as:
pdftotext to convert pdf to textantiword to convert doc to textpandoc to convert .docx, .epub, and other document formatsexiftool to read meta information embedded in image and video media formats.soffice to convert office documentscsvkit to convert spreadsheetsopenssl to convert certificates and key files to text and other formats The ugrep+ and ug+ commands use the pdftotext , antiword , pandoc and exiftool filters, when installed, to search pdfs, documents, e-books, and image metadata.
Also decompressors may be used as filter utilities, such as unzip , gunzip , bunzip2 , unlzma , unxz , lzop and 7z that decompress files to standard output when option --stdout is specified. Zum Beispiel:
ug --filter='lzo:lzop -d --stdout -' ...
ug --filter='gz:gunzip -d --stdout -' ...
ug --filter='7z:7z x -so %' ...
The --filter='lzo:lzop -d --stdout -' option decompresses files with extension lzo to standard output with --stdout with the compressed stream being read from standard input with - . The --filter='7z:7z x -so -si option decompresses files with extension 7z to standard output -so while reading standard input -si with the compressed file contents.
Note that ugrep option -z is typically faster to search compressed files compared to --filter .
The --filter option may also be used to run a user-defined shell script to filter files. For example, to invoke an action depending on the filename extension of the % argument. Another use case is to pass a file to more than one filter, which can be accomplished with a shell script containing the line tool1 $1; tool2 $1 . This filters the file argument $1 with tool1 followed by tool2 to produce combined output to search for pattern matches. Likewise, we can use a script with the line tool1 $1 | tool2 to stack two filters tool1 and tool2 .
The --filter option may also be used as a predicate to skip certain files from the search. As the most basic example, consider the false utility that exits with a nonzero exit code without reading input or producing output. Therefore, --filter='swp: false' skips all .swp files from recursive searches. The same can be done more efficiently with -O^swp . However, the --filter option could invoke a script that determines if the filename passed as a % argument meets certain constraints. If the constraint is met the script copies standard input to standard output with cat . If not, the script exits.
Warning: option --filter should not be used with utilities that modify files. Otherwise searches may be unpredicatable. In the worst case files may be lost, for example when the specified utility replaces or deletes the file passed to the command with --filter option % .
To recursively search files including PDF files in the working directory without recursing into subdirectories (with -1 ), for matches of drink me using the pdftotext filter to convert PDF to text without preserving page breaks:
ug -r -1 --filter='pdf:pdftotext -nopgbrk % -' 'drink me'
To recursively search text files for eat me while converting non-printable characters in .txt and .md files using the cat -v filter:
ug -r -ttext --filter='txt,md:cat -v' 'eat me'
The same, but specifying the .txt and .md filters separately:
ug -r -ttext --filter='txt:cat -v, md:cat -v' 'eat me'
To search the first 8K of a text file:
ug --filter='txt:head -c 8192' 'eat me' wonderland.txt
To recursively search and list the files that contain the word Alice , including .docx and .epub documents using the pandoc filter:
ug -rl -w --filter='docx,epub:pandoc --wrap=preserve -t plain % -o -' 'Alice'
Important: the pandoc utility requires an input file and will not read standard input. Option % expands into the full pathname of the file to search. The output format specified is markdown , which is close enough to text to be searched.
To recursively search and list the files that contain the word Alice , including .odt, .doc, .docx, .rtf, .xls, .xlsx, .ppt, .pptx documents using the soffice filter:
ug -rl -w --filter='odt,doc,docx,rtf,xls,xlsx,ppt,pptx:soffice --headless --cat %' 'Alice'
Important: the soffice utility will not output any text when one or more LibreOffice GUIs are open. Make sure to quit all LibreOffice apps first. This looks like a bug, but the LibreOffice developers do not appear to fix this any time soon (unless perhaps more people complain?). You can work around this problem by specifying a specific user profile for soffice with the following semi-documented argument passed to soffice : -env:UserInstallation=file:///home/user/.libreoffice-alt .
To recursively search and display rows of .csv, .xls, and .xlsx spreadsheets that contain 10/6 using the in2csv filter of csvkit:
ug -r -Ocsv,xls,xlsx --filter='xls,xlsx:in2csv %' '10/6'
To search .docx, .xlsx, and .pptx files converted to XML for a match with 10/6 using unzip as a filter:
ug -lr -Odocx,xlsx,pptx --filter='docx,xlsx,pptx:unzip -p %' '10/6'
Important: unzipping docx, xlxs, pptx files produces extensive XML output containing meta information and binary data such as images. By contrast, ugrep option -z with -Oxml selects the XML components only:
ug -z -lr -Odocx,xlsx,pptx,xml '10/6'
Note: docx, xlsx, and pptx are zip files containing multiple components. When selecting the XML components with option -Oxml in docx, xlsx, and pptx documents, we should also specify -Odocx,xlsx,pptx to search these type of files, otherwise these files will be ignored.
To recurssively search X509 certificate files for lines with Not After (eg to find expired certificates), using openssl as a filter:
ug -r 'Not After' -Ocer,der,pem --filter='pem:openssl x509 -text,cer,crt,der:openssl x509 -text -inform der'
Note that openssl warning messages are displayed on standard error. If a file cannot be converted it is probably in a different format. This can be resolved by writing a shell script that executes openssl with options based on the file content. Then write a script with ugrep --filter .
To search PNG files by filename extension with -tpng using exiftool :
ug -r -i 'copyright' -tpng --filter='*:exiftool %'
Same, but also include files matching PNG "magic bytes" with -tPng and --filter-magic-label='+png:x89pngx0dx0ax1ax0a' to select the png filter:
ug -r -i 'copyright' -tPng --filter='png:exiftool %' --filter-magic-label='+png:x89pngx0dx0ax1ax0a'
Note that +png overrides any filename extension match for --filter . Otherwise, without a + , the filename extension, when present, takes priority over labelled magic patterns to invoke the corresponding filter command. The LABEL used with --filter-magic-label and --filter has no specific meaning; any name or string that does not contain a : or , may be used.
? Back to table of contents
--hexdump[=[1-8][a][bch][A[NUM]][B[NUM]][C[NUM]]]
Output matches in 1 to 8 columns of 8 hexadecimal octets. The
default is 2 columns or 16 octets per line. Argument `a' outputs a
`*' for all hex lines that are identical to the previous hex line,
`b' removes all space breaks, `c' removes the character column, `h'
removes hex spacing, `A' includes up to NUM hex lines after a
match, `B' includes up to NUM hex lines before a match and `C'
includes up to NUM hex lines before and after a match. Arguments
`A', `B' and `C' are the same as options -A, -B and -C when used
with --hexdump. See also options -U, -W and -X.
-U, --ascii, --binary
Disables Unicode matching for binary file matching, forcing PATTERN
to match bytes, not Unicode characters. For example, -U 'xa3'
matches byte A3 (hex) instead of the Unicode code point U+00A3
represented by the UTF-8 sequence C2 A3. See also --dotall.
-W, --with-hex
Output binary matches in hexadecimal, leaving text matches alone.
This option is equivalent to the --binary-files=with-hex option.
To omit the matching line from the hex output, use both options -W
and --hexdump. See also options -U.
-X, --hex
Output matches and matching lines in hexadecimal. This option is
equivalent to the --binary-files=hex option. To omit the matching
line from the hex output use option --hexdump. See also option -U.
--dotall
Dot `.' in regular expressions matches anything, including newline.
Note that `.*' matches all input and should not be used.
Note that --hexdump differs from -X by omitting the matching line from the hex output, showing only the matching pattern using a minimal number of hex lines. Additional match context hex lines are output with the -ABC context options or with --hexdump=C3 to output 3 hex lines as context, for example.
To search a file for ASCII words, displaying text lines as usual while binary content is shown in hex with -U and -W :
ug -UW 'w+' myfile
To hexdump an entire file as a match with -X :
ug -X '' myfile
To hexdump an entire file with -X , displaying line numbers and byte offsets with -nb (here with -y to display all line numbers):
ug -Xynb '' myfile
To hexdump lines containing one or more in a (binary) file using a non-Unicode pattern with -U and -X :
ug -UX 'x00+' myfile
Same, but hexdump the entire file as context with -y (note that this line-based option does not permit matching patterns with newlines):
ug -UX -y 'x00+' myfile
Same, compacted to 32 bytes per line without the character column:
ug -UX -y 'x00+' myfile
To match the binary pattern A3..A3. (hex) in a binary file without Unicode pattern matching (which would otherwise match xaf as a Unicode character U+00A3 with UTF-8 byte sequence C2 A3) and display the results in compact hex with --hexdump with pager:
ug --pager --hexdump -U 'xa3[x00-xff]{2}xa3[x00-xff]' a.out
Same, but using option --dotall to let . match any byte, including newline that is not matched by dot (the default as required by grep):
ug --dotall --pager --hexdump -U 'xa3.{2}xa3.' a.out
To list all files containing a RPM signature, located in the rpm directory and recursively below (see for example list of file signatures):
ug -RlU 'Axedxabxeexdb' rpm
? Back to table of contents
-I Ignore matches in binary files. This option is equivalent to the
--binary-files=without-match option.
To recursively search without following symlinks and ignoring binary files:
ug -rl -I 'xyz'
To ignore specific binary files with extensions such as .exe, .bin, .out, .a, use --exclude or --exclude-from :
ug -rl --exclude-from=ignore_binaries 'xyz'
where ignore_binaries is a file containing a glob on each line to ignore matching files, eg *.exe , *.bin , *.out , *.a . Because the command is quite long to type, an alias for this is recommended, for example ugs (ugrep source):
alias ugs="ugrep --exclude-from=~/ignore_binaries"
ugs -rl 'xyz'
? Back to table of contents
--ignore-files[=FILE]
Ignore files and directories matching the globs in each FILE that
is encountered in recursive searches. The default FILE is
`.gitignore'. Matching files and directories located in the
directory of the FILE and in subdirectories below are ignored.
Globbing syntax is the same as the --exclude-from=FILE gitignore
syntax, but files and directories are excluded instead of only
files. Directories are specifically excluded when the glob ends in
a `/'. Files and directories explicitly specified as command line
arguments are never ignored. This option may be repeated to
specify additional files.
Option --ignore-files looks for .gitignore , or the specified FILE , in recursive searches. When .gitignore , or the specified FILE , is found while traversing directory tree branches down, the .gitignore file is used to temporarily extend the previous exclusions with the additional globs in .gitignore to apply the combined exclusions to the directory tree rooted at the .gitignore location. Use --stats to show the selection criteria applied to the search results and the locations of each FILE found. To avoid confusion, files and directories specified as command-line arguments to ugrep are never ignored.
Note that exclude glob patterns take priority over include glob patterns when specified with command line options. By contrast, negated glob patterns specified with ! in --ignore-files files take priority. This effectively overrides the exclusions and resolves conflicts in favor of listing matching files that are explicitly specified as exceptions and should be included in the search.
See also Using gitignore-style globs to select directories and files to search.
To recursively search without following symlinks, while ignoring files and directories ignored by .gitignore (when present), use option --ignore-files . Note that -r is the default when no FILE arguments are specified, we use it here to make the examples easier to follow.
ug -rl --ignore-files 'xyz'
Same, but includes hidden files with -. rather than ignoring them:
ug -rl. --ignore-files 'xyz'
To recursively list all files that are not ignored by .gitignore (when present) with --ignore-files :
ug -rl --ignore-files ''
Same, but list shell scripts that are not ignored by .gitignore, when present:
ug -rl -tShell '' --ignore-files
To recursively list all files that are not ignored by .gitignore and are also not excluded by .git/info/exclude :
ug -rl '' --ignore-files --exclude-from=.git/info/exclude
Same, but by creating a symlink to .git/info/exclude to make the exclusions implicit:
ln -s .git/info/exclude .ignore
ug -rl '' --ignore-files --ignore-files=.ignore
? Back to table of contents
-g GLOBS, --glob=GLOBS
Search only files whose name matches the specified comma-separated
list of GLOBS, same as --include='glob' for each `glob' in GLOBS.
When a `glob' is preceded by a `!' or a `^', skip files whose name
matches `glob', same as --exclude='glob'. When `glob' contains a
`/', full pathnames are matched. Otherwise basenames are matched.
When `glob' ends with a `/', directories are matched, same as
--include-dir='glob' and --exclude-dir='glob'. A leading `/'
matches the working directory. This option may be repeated and may
be combined with options -M, -O and -t to expand searches. See
`ugrep --help globs' and `man ugrep' section GLOBBING for details.
--exclude=GLOB
Skip files whose name matches GLOB using wildcard matching, same as
-g ^GLOB. GLOB can use **, *, ?, and [...] as wildcards, and \ to
quote a wildcard or backslash character literally. When GLOB
contains a `/', full pathnames are matched. Otherwise basenames
are matched. When GLOB ends with a `/', directories are excluded
as if --exclude-dir is specified. Otherwise files are excluded.
Note that --exclude patterns take priority over --include patterns.
GLOB should be quoted to prevent shell globbing. This option may
be repeated.
--exclude-dir=GLOB
Exclude directories whose name matches GLOB from recursive
searches, same as -g ^GLOB/. GLOB can use **, *, ?, and [...] as
wildcards, and \ to quote a wildcard or backslash character
literally. When GLOB contains a `/', full pathnames are matched.
Otherwise basenames are matched. Note that --exclude-dir patterns
take priority over --include-dir patterns. GLOB should be quoted
to prevent shell globbing. This option may be repeated.
--exclude-from=FILE
Read the globs from FILE and skip files and directories whose name
matches one or more globs. A glob can use **, *, ?, and [...] as
wildcards, and to quote a wildcard or backslash character
literally. When a glob contains a `/', full pathnames are matched.
Otherwise basenames are matched. When a glob ends with a `/',
directories are excluded as if --exclude-dir is specified.
Otherwise files are excluded. A glob starting with a `!' overrides
previously-specified exclusions by including matching files. Lines
starting with a `#' and empty lines in FILE are ignored. When FILE
is a `-', standard input is read. This option may be repeated.
--ignore-files[=FILE]
Ignore files and directories matching the globs in each FILE that
is encountered in recursive searches. The default FILE is
`.gitignore'. Matching files and directories located in the
directory of the FILE and in subdirectories below are ignored.
Globbing syntax is the same as the --exclude-from=FILE gitignore
syntax, but files and directories are excluded instead of only
files. Directories are specifically excluded when the glob ends in
a `/'. Files and directories explicitly specified as command line
arguments are never ignored. This option may be repeated to
specify additional files.
--include=GLOB
Search only files whose name matches GLOB using wildcard matching,
same as -g GLOB. GLOB can use **, *, ?, and [...] as wildcards,
and \ to quote a wildcard or backslash character literally. When
GLOB contains a `/', full pathnames are matched. Otherwise
basenames are matched. When GLOB ends with a `/', directories are
included as if --include-dir is specified. Otherwise files are
included. Note that --exclude patterns take priority over
--include patterns. GLOB should be quoted to prevent shell
globbing. This option may be repeated.
--include-dir=GLOB
Only directories whose name matches GLOB are included in recursive
searches, same as -g GLOB/. GLOB can use **, *, ?, and [...] as
wildcards, and \ to quote a wildcard or backslash character
literally. When GLOB contains a `/', full pathnames are matched.
Otherwise basenames are matched. Note that --exclude-dir patterns
take priority over --include-dir patterns. GLOB should be quoted
to prevent shell globbing. This option may be repeated.
--include-from=FILE
Read the globs from FILE and search only files and directories
whose name matches one or more globs. A glob can use **, *, ?, and
[...] as wildcards, and to quote a wildcard or backslash
character literally. When a glob contains a `/', full pathnames
are matched. Otherwise basenames are matched. When a glob ends
with a `/', directories are included as if --include-dir is
specified. Otherwise files are included. A glob starting with a
`!' overrides previously-specified inclusions by excluding matching
files. Lines starting with a `#' and empty lines in FILE are
ignored. When FILE is a `-', standard input is read. This option
may be repeated.
-O EXTENSIONS, --file-extension=EXTENSIONS
Search only files whose filename extensions match the specified
comma-separated list of EXTENSIONS, same as --include='*.ext' for
each `ext' in EXTENSIONS. When `ext' is preceded by a `!' or a
`^', skip files whose filename extensions matches `ext', same as
--exclude='*.ext'. This option may be repeated and may be combined
with options -g, -M and -t to expand the recursive search.
--stats
Output statistics on the number of files and directories searched,
and the inclusion and exclusion constraints applied.
See also Including or excluding mounted file systems from searches.
Gitignore-style glob syntax and conventions:
| Muster | Streichhölzer |
|---|---|
* | anything except / |
? | any one character except / |
[abc-e] | one character a , b , c , d , e |
[^abc-e] | one character not a , b , c , d , e , / |
[!abc-e] | one character not a , b , c , d , e , / |
/ | when used at the start of a glob, matches working directory |
**/ | zero or more directories |
/** | when at the end of a glob, matches everything after the / |
? | A ? or any other character specified after the backslash |
When a glob pattern contains a path separator / , the full pathname is matched. Otherwise the basename of a file or directory is matched in recursive searches. For example, *.h matches foo.h and bar/foo.h . bar/*.h matches bar/foo.h but not foo.h and not bar/bar/foo.h .
When a glob pattern begins with a / , files and directories are matched at the working directory, not recursively. For example, use a leading / to force /*.h to match foo.h but not bar/foo.h .
When a glob pattern ends with a / , directories are matched instead of files, same as --include-dir .
When a glob starts with a ! as specified with -g!GLOB , or specified in a FILE with --include-from=FILE or --exclude-from=FILE , it is negated.
To view a list of inclusions and exclusions that were applied to a search, use option --stats .
To list only readable files with names starting with foo in the working directory, that contain xyz , without producing warning messages with -s and -l :
ug -sl 'xyz' foo*
The same, but using deep recursion with inclusion constraints (note that -g'/foo* is the same as --include='/foo*' and -g'/foo*/' is the same as --include-dir='/foo*' , ie immediate subdirectories matching /foo* only):
ug -rl 'xyz' -g'/foo*' -g'/foo*/'
Note that -r is the default, we use it here to make the examples easier to follow.
To exclude directory bak located in the working directory:
ug -rl 'xyz' -g'^/bak/'
To exclude all directoies bak at any directory level deep:
ug -rl 'xyz' -g'^bak/'
To only list files in the working directory and its subdirectory doc , that contain xyz (note that -g'/doc/' is the same as --include-dir='/doc' , ie immediate subdirectory doc only):
ug -rl 'xyz' -g'/doc/'
To only list files that are on a subdirectory path doc that includes subdirectory html anywhere, that contain xyz :
ug -rl 'xyz' -g'doc/**/html/'
To only list files in the working directory and in the subdirectories doc and doc/latest but not below, that contain xyz :
ug -rl 'xyz' -g'/doc/' -g'/doc/latest/'
To recursively list .cpp files in the working directory and any subdirectory at any depth, that contain xyz :
ug -rl 'xyz' -g'*.cpp'
The same, but using a .gitignore-style glob that matches pathnames (globs with / ) instead of matching basenames (globs without / ) in the recursive search:
ug -rl 'xyz' -g'**/*.cpp'
Same, but using option -Ocpp to match file name extensions:
ug -rl -Ocpp 'xyz'
To recursively list all files in the working directory and below that are not ignored by a specific .gitignore file:
ug -rl '' --exclude-from=.gitignore
To recursively list all files in the working directory and below that are not ignored by one or more .gitignore files, when any are present:
ug -rl '' --ignore-files
? Back to table of contents
--exclude-fs=MOUNTS
Exclude file systems specified by MOUNTS from recursive searches.
MOUNTS is a comma-separated list of mount points or pathnames to
directories. When MOUNTS is not specified, only descends into the
file systems associated with the specified file and directory
search targets, i.e. excludes all other file systems. Note that
--exclude-fs=MOUNTS take priority over --include-fs=MOUNTS. This
option may be repeated.
--include-fs=MOUNTS
Only file systems specified by MOUNTS are included in recursive
searches. MOUNTS is a comma-separated list of mount points or
pathnames to directories. When MOUNTS is not specified, restricts
recursive searches to the file system of the working directory,
same as --include-fs=. (dot). Note that --exclude-fs=MOUNTS take
priority over --include-fs=MOUNTS. This option may be repeated.
These options control recursive searches across file systems by comparing device numbers. Mounted devices and symbolic links to files and directories located on mounted file systems may be included or excluded from recursive searches by specifying a mount point or a pathname of any directory on the file system to specify the applicable file system.
Note that a list of mounted file systems is typically stored in /etc/mtab .
To restrict recursive searches to the file system(s) of the search targets only, without crossing into other file systems (similar to find option -x ):
ug -rl --exclude-fs 'xyz' /sys /var
To restrict recursive searches to the file system of the working directory only, without crossing into other file systems:
ug -l --include-fs 'xyz'
In fact, for this case we can use --exclude-fs because we search the working directory as the target and we want to exclude all other file systems:
ug -l --exclude-fs 'xyz'
To exclude the file systems mounted at /dev and /proc from recursive searches:
ug -l --exclude-fs=/dev,/proc 'xyz'
To only include the file system associated with drive d: in recursive searches:
ug -l --include-fs=d:/ 'xyz'
To exclude fuse and tmpfs type file systems from recursive searches:
exfs=`ugrep -w -e fuse -e tmpfs /etc/mtab | ugrep -P '^S+ (S+)' --format='%,%1'`
ug -l --exclude-fs="$exfs" 'xyz'
? Back to table of contents
-c, --count
Only a count of selected lines is written to standard output.
If -o or -u is specified, counts the number of patterns matched.
If -v is specified, counts the number of non-matching lines. If
-m1, (with a comma or --min-count=1) is specified, counts only
matching files without outputting zero matches.
To count the number of lines in a file:
ug -c '' myfile.txt
To count the number of lines with TODO :
ug -c -w 'TODO' myfile.cpp
To count the total number of TODO in a file, use -c and -o :
ug -co -w 'TODO' myfile.cpp
To count the number of ASCII words in a file:
ug -co '[[:word:]]+' myfile.txt
To count the number of ASCII and Unicode words in a file:
ug -co 'w+' myfile.txt
To count the number of Unicode characters in a file:
ug -co 'p{Unicode}' myfile.txt
To count the number of zero bytes in a file:
ug -UX -co 'x00' image.jpg
? Back to table of contents
-b, --byte-offset
The offset in bytes of a matched line is displayed in front of the
respective matched line. When used with option -u, displays the
offset in bytes of each pattern matched. Byte offsets are exact
for ASCII, UTF-8, and raw binary input. Otherwise, the byte offset
in the UTF-8 converted input is displayed.
-H, --with-filename
Always print the filename with output lines. This is the default
when there is more than one file to search.
-k, --column-number
The column number of a matched pattern is displayed in front of the
respective matched line, starting at column 1. Tabs are expanded
when columns are counted, see option --tabs.
-n, --line-number
Each output line is preceded by its relative line number in the
file, starting at line 1. The line number counter is reset for
each file processed.
-T, --initial-tab
Add a tab space to separate the file name, line number, column
number, and byte offset with the matched line.
To display the file name -H , line -n , and column -k numbers of matches in myfile.cpp , with spaces and tabs to space the columns apart with -T :
ug -THnk 'main' myfile.cpp
To display the line with -n of word main in myfile.cpp :
ug -nw 'main' myfile.cpp
To display the entire file myfile.cpp with line -n numbers:
ug -n '' myfile.cpp
To recursively search for C++ files with main , showing the line and column numbers of matches with -n and -k :
ug -r -nk -tc++ 'main'
To display the byte offset of matches with -b :
ug -r -b -tc++ 'main'
To display the line and column numbers of matches in XML with --xml :
ug -r -nk --xml -tc++ 'main'
? Back to table of contents
--color[=WHEN], --colour[=WHEN]
Mark up the matching text with the expression stored in the
GREP_COLOR or GREP_COLORS environment variable. The possible
values of WHEN can be `never', `always', or `auto', where `auto'
marks up matches only when output on a terminal. The default is
`auto'.
--colors=COLORS, --colours=COLORS
Use COLORS to mark up text. COLORS is a colon-separated list of
one or more parameters `sl=' (selected line), `cx=' (context line),
`mt=' (matched text), `ms=' (match selected), `mc=' (match
context), `fn=' (file name), `ln=' (line number), `cn=' (column
number), `bn=' (byte offset), `se=' (separator), `qp=' (TUI
prompt), `qe=' (TUI errors), `qr=' (TUI regex), `qm=' (TUI regex
meta characters), `ql=' (TUI regex lists and literals), `qb=' (TUI
regex braces). Parameter values are ANSI SGR color codes or `k'
(black), `r' (red), `g' (green), `y' (yellow), `b' (blue), `m'
(magenta), `c' (cyan), `w' (white), or leave empty for no color.
Upper case specifies background colors. A `+' qualifies a color as
bright. A foreground and a background color may be combined with
font properties `n' (normal), `f' (faint), `h' (highlight), `i'
(invert), `u' (underline). Parameter `hl' enables file name
hyperlinks. Parameter `rv' reverses the `sl=' and `cx=' parameters
when option -v is specified. Selectively overrides GREP_COLORS.
Legacy grep single parameter codes may be specified, for example
--colors='7;32' or --colors=ig to set ms (match selected).
--tag[=TAG[,END]]
Disables colors to mark up matches with TAG. END marks the end of
a match if specified, otherwise TAG. The default is `___'.
--pager[=COMMAND]
When output is sent to the terminal, uses COMMAND to page through
the output. COMMAND defaults to environment variable PAGER when
defined or `less'. Enables --heading and --line-buffered.
--pretty[=WHEN]
When output is sent to a terminal, enables --color, --heading, -n,
--sort, --tree and -T when not explicitly disabled. WHEN can be
`never', `always', or `auto'. The default is `auto'.
--tree, -^
Output directories with matching files in a tree-like format for
option -c or --count, -l or --files-with-matches, -L or
--files-without-match. This option is enabled by --pretty when the
output is sent to a terminal.
To change the color palette, set the GREP_COLORS environment variable or use --colors=COLORS . The value is a colon-separated list of ANSI SGR parameters that defaults to cx=33:mt=1;31:fn=1;35:ln=1;32:cn=1;32:bn=1;32:se=36 :
| param | Ergebnis |
|---|---|
sl= | selected lines |
cx= | context lines |
rv | Swaps the sl= and cx= capabilities when -v is specified |
mt= | matching text in any matching line |
ms= | matching text in a selected line. The substring mt= by default |
mc= | matching text in a context line. The substring mt= by default |
fn= | file names |
ln= | line numbers |
cn= | column numbers |
bn= | byte offsets |
se= | Trennzeichen |
hl | hyperlink file names, same as --hyperlink |
qp= | TUI prompt |
qe= | TUI errors |
qr= | TUI regex |
qm= | TUI regex meta characters |
ql= | TUI regex lists and literals |
qb= | TUI regex braces |
Multiple SGR codes may be specified for a single parameter when separated by a semicolon, eg mt=1;31 specifies bright red. The following SGR codes are available on most color terminals:
| Code | C | Wirkung | Code | C | Wirkung |
|---|---|---|---|---|---|
| 0 | N | normal font and color | 2 | F | faint (not widely supported) |
| 1 | H | highlighted bold font | 21 | H | highlighted bold off |
| 4 | u | unterstreichen | 24 | U | underline off |
| 7 | ich | invert video | 27 | ICH | invert off |
| 30 | k | black text | 90 | +k | bright gray text |
| 31 | R | red text | 91 | +r | bright red text |
| 32 | G | green text | 92 | +g | bright green text |
| 33 | j | yellow text | 93 | +y | bright yellow text |
| 34 | B | blue text | 94 | +b | bright blue text |
| 35 | M | magenta text | 95 | +m | bright magenta text |
| 36 | C | cyan text | 96 | +c | bright cyan text |
| 37 | w | white text | 97 | +w | bright white text |
| 40 | K | schwarzer Hintergrund | 100 | +K | bright gray background |
| 41 | R | dark red background | 101 | +R | bright red background |
| 42 | G | dark green background | 102 | +G | bright green background |
| 43 | Y | dark yellow backgrounda | 103 | +Y | bright yellow background |
| 44 | B | dunkelblauer Hintergrund | 104 | +B | bright blue background |
| 45 | M | dark magenta background | 105 | +M | bright magenta background |
| 46 | C | dark cyan background | 106 | +C | bright cyan background |
| 47 | W | dark white background | 107 | +W | bright white background |
See Wikipedia ANSI escape code - SGR parameters
For quick and easy color specification, the corresponding single-letter color names may be used in place of numeric SGR codes and semicolons are not required to separate color names. Color names and numeric codes may be mixed.
For example, to display matches in underlined bright green on bright selected lines, aiding in visualizing white space in matches and file names:
export GREP_COLORS='sl=1:cx=33:ms=1;4;32;100:mc=1;4;32:fn=1;32;100:ln=1;32:cn=1;32:bn=1;32:se=36'
The same, but with single-letter color names:
export GREP_COLORS='sl=h:cx=y:ms=hug+K:mc=hug:fn=hg+K:ln=hg:cn=hg:bn=hg:se=c'
Another color scheme that works well:
export GREP_COLORS='cx=hb:ms=hiy:mc=hic:fn=hi+y+K:ln=hg:cn=hg:bn=hg:se='
Modern Windows command interpreters support ANSI escape codes. Named or numeric colors can be set with SET GREP_COLORS , for example:
SET GREP_COLORS=sl=1;37:cx=33:mt=1;31:fn=1;35:ln=1;32:cn=1;32:bn=1;32:se=36
To disable colors on Windows:
SET GREP_COLORS=""
Color intensities may differ per platform and per terminal program used, which affects readability.
Option -y outputs every line of input, including non-matching lines as context. The use of color helps distinguish matches from non-matching context.
To copy silver searcher's color palette:
export GREP_COLORS='mt=30;43:fn=1;32:ln=1;33:cn=1;33:bn=1;33'
To produce color-highlighted results ( --color is redundance since it is the default):
ug --color -r -n -k -tc++ 'FIXME.*'
To page through the results with pager ( less -R by default):
ug --pager -r -n -k -tc++ 'FIXME'
To display a hexdump of a zip file itself (ie without decompressing), with color-highlighted matches of the zip magic bytes PKx03x04 ( --color is redundant since it is the default):
ug --color -y -UX 'PKx03x04' some.zip
To use predefined patterns to list all #include and #define in C++ files:
ug --pretty -r -n -tc++ -f c++/includes -f c++/defines
Same, but overriding the color of matches as inverted yellow (reverse video) and headings with yellow on blue using --pretty :
ug --pretty --colors="ms=yi:fn=hyB" -r -n -tc++ -f c++/includes -f c++/defines
To list all #define FOO... macros in C++ files, color-highlighted:
ug --color=always -r -n -tc++ -f c++/defines | ug 'FOO.*'
Same, but restricted to .cpp files only:
ug --color=always -r -n -Ocpp -f c++/defines | ug 'FOO.*'
To search tarballs for matching names of PDF files (assuming bash is our shell):
for tb in *.tar *.tar.gz *.tgz; do echo "$tb"; tar tfz "$tb" | ugrep '.*.pdf$'; done
? Back to table of contents
--cpp Output file matches in C++. See also options --format and -u.
--csv Output file matches in CSV. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
--json Output file matches in JSON. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
--xml Output file matches in XML. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
To recursively search for lines with TODO and display C++ file matches in JSON with line number properties:
ug -tc++ -n --json 'TODO'
To recursively search for lines with TODO and display C++ file matches in XML with line and column number attributes:
ug -tc++ -nk --xml 'TODO'
To recursively search for lines with TODO and display C++ file matches in CSV format with file pathname, line number, and column number fields:
ug -tc++ --csv -Hnk 'TODO'
To extract a table from an HTML file and put it in C/C++ source code using -o :
ug -o --cpp '<tr>.*</tr>' index.html > table.cpp
? Back to table of contents
--format=FORMAT
Output FORMAT-formatted matches. For example --format='%f:%n:%O%~'
outputs matching lines `%O' with filename `%f` and line number `%n'
followed by a newline `%~'. If -P is specified, FORMAT may include
`%1' to `%9', `%[NUM]#' and `%[NAME]#' to output group captures. A
`%%' outputs `%'. See `ugrep --help format' and `man ugrep'
section FORMAT for details. When option -o is specified, option -u
is also enabled. Context options -A, -B, -C and -y are ignored.
-P, --perl-regexp
Interpret PATTERN as a Perl regular expression.
Use option -P to use group captures and backreferences. Capturing groups in regex patterns are parenthesized expressions (pattern) . The first group is referenced in FORMAT by %1 , the second by %2 and so on. Named captures are of the form (?<NAME>pattern) and are referenced in FORMAT by %[NAME]# .
The following output formatting options may be used. The FORMAT string % -fields are listed in a table further below:
| Option | Ergebnis |
|---|---|
--format-begin=FORMAT | FORMAT beginning the search |
--format-open=FORMAT | FORMAT opening a file and a match was found |
--format=FORMAT | FORMAT for each match in a file |
--format-close=FORMAT | FORMAT closing a file and a match was found |
--format-end=FORMAT | FORMAT ending the search |
The following tables show the formatting options corresponding to --csv , --json , and --xml .
--csv| Option | format string (within quotes) |
|---|---|
--format-open | '%+' |
--format | '%[,]$%H%N%K%B%V%~%u' |
--json| Option | format string (within quotes) |
|---|---|
--format-begin | '[' |
--format-open | '%,%~ {%~ %[,%~ ]$%["file": ]H"matches": [' |
--format | '%,%~ { %[, ]$%["line": ]N%["column": ]K%["offset": ]B"match": %J }%u' |
--format-close | '%~ ]%~ }' |
--format-end | '%~]%~' |
--xml| Option | format string (within quotes) |
|---|---|
--format-begin | '<grep>%~' |
--format-open | ' <file%["]$%[ name="]I>%~' |
--format | ' <match%["]$%[ line="]N%[ column="]K%[ offset="]B>%X</match>%~%u' |
--format-close | ' </file>%~' |
--format-end | '</grep>%~' |
--only-line-number| Option | format string (within quotes) |
|---|---|
--format-open | '%+' |
--format | '%F%n%s%K%B%~%u' |
The following fields may be used in the FORMAT string:
| Feld | Ausgabe |
|---|---|
%% | the percentage sign |
%~ | a newline (LF or CRLF in Windows) |
%F | if option -H is used: the file pathname and separator |
%[TEXT]F | if option -H is used: TEXT , the file pathname and separator |
%f | the file pathname |
%a | the file basename without directory path |
%p | the directory path to the file |
%z | the pathname in a (compressed) archive, without { and } |
%H | if option -H is used: the quoted pathname and separator, " and \ replace " and |
%+ | if option -+ or --heading is used: %F and a newline character, suppress all %F and %H afterward |
%[TEXT]H | if option -H is used: TEXT , the quoted pathname and separator, " and \ replace " and |
%h | the quoted file pathname, " and \ replace " and |
%I | if option -H is used: the pathname in XML and separator |
%[TEXT]I | if option -H is used: TEXT , the pathname as XML and separator |
%i | the file pathnames as XML |
%N | if option -n is used: the line number and separator |
%[TEXT]N | if option -n is used: TEXT , the line number and separator |
%n | the line number of the match |
%l | the last line number of the match (multi-line matching) |
%L | the number of lines matched (multi-line matching) |
%K | if option -k is used: the column number and separator |
%[TEXT]K | if option -k is used: TEXT , the column number and separator |
%k | the column number of the match |
%A | byte range (offset and end) of a match in hex |
%B | if option -b is used: the byte offset and separator |
%[TEXT]B | if option -b is used: TEXT , the byte offset and separator |
%b | the byte offset of the match |
%T | if option -T is used: TEXT and a tab character |
%[TEXT]T | if option -T is used: TEXT and a tab character |
%t | a tab character |
%[SEP]$ | set field separator to SEP for the rest of the format fields |
%[TEXT]< | if the first match: TEXT |
%[TEXT]> | if not the first match: TEXT |
%, | if not the first match: a comma, same as %[,]> |
%: | if not the first match: a colon, same as %[:]> |
%; | if not the first match: a semicolon, same as %[;]> |
%│ | if not the first match: a vertical bar, same as %[│]> |
%S | if not the first match: separator, see also %[SEP]$ |
%[TEXT]S | if not the first match: TEXT and separator, see also %[SEP]$ |
%s | the separator, see also %[TEXT]S and %[SEP]$ |
%R | if option --break or --heading is used: a newline |
%m | the number of matches, sequential (or number of matching files with --format-end ) |
%M | the number of matching lines (or number of matching files with --format-end ) |
%O | the matching line is output as is (a raw string of bytes) |
%o | the match is output as is (a raw string of bytes) |
%Q | the matching line as a quoted string, " and \ replace " and |
%q | the match as a quoted string, " and \ replace " and |
%C | the matching line formatted as a quoted C/C++ string |
%c | the match formatted as a quoted C/C++ string |
%J | the matching line formatted as a quoted JSON string |
%j | the match formatted as a quoted JSON string |
%V | the matching line formatted as a quoted CSV string |
%v | the match formatted as a quoted CSV string |
%X | the matching line formatted as XML character data |
%x | the match formatted as XML character data |
%Y | the matching line formatted in hex |
%y | the match formatted in hex |
%A | byte range of the match in hex |
%w | the width of the match, counting (wide) characters |
%d | the size of the match, counting bytes |
%e | the ending byte offset of the match |
%Z | the edit distance cost of an approximate match with option -Z |
%u | select unique lines only unless option -u is used |
%[hhhh]U | U+hhhh Unicode code point |
%[CODE]= | a color CODE, such as ms , see colors |
%= | turn color off |
%1 %2 ... %9 | the first regex group capture of the match, and so on up to group %9 , requires option -P |
%[NUM]# | the group capture NUM ; requires option -P |
%[NUM]b | the byte offset of the group capture NUM ; requires option -P |
%[NUM]e | the ending byte offset of the group capture NUM ; requires option -P |
%[NUM]d | the byte length of the group capture NUM ; requires option -P |
%[NUM]j | the group capture NUM as JSON; requires option -P |
%[NUM]q | the group capture NUM quoted; requires option -P |
%[NUM]x | the group capture NUM as XML; requires option -P |
%[NUM]y | the group capture NUM as hex; requires option -P |
%[NUM]v | the group capture NUM as CSV; requires option -P |
%[NUM1|NUM2|...]# | the first group capture NUM that matched; requires option -P |
%[NUM1|NUM2|...]b | the byte offset of the first group capture NUM that matched; requires option -P . |
%[NUM1|NUM2|...]e | the ending byte offset of the first group capture NUM that matched; requires option -P . |
%[NUM1|NUM2|...]d | the byte length of the first group capture NUM that matched; requires option -P . |
%[NUM1|NUM2|...]j | the first group capture NUM that matched, as JSON; requires option -P |
%[NUM1|NUM2|...]q | the first group capture NUM that matched, quoted; requires option -P |
%[NUM1|NUM2|...]x | the first group capture NUM that matched, as XML; requires option -P |
%[NUM1|NUM2|...]y | the first group capture NUM that matched, as hex; requires option -P |
%[NUM1|NUM2|...]v | the first group capture NUM that matched, as CSV; requires option -P |
%[NAME]# | the NAME d group capture; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME]b | the byte offset of the NAME d group capture; requires option -P and capturing pattern (?<NAME>PATTERN) . |
%[NAME]e | the ending byte offset of the NAME d group capture; requires option -P and capturing pattern (?<NAME>PATTERN) . |
%[NAME]d | the byte length of the NAME d group capture; requires option -P and capturing pattern (?<NAME>PATTERN) . |
%[NAME]j | the NAME d group capture as JSON; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME]q | the NAME d group capture quoted; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME]x | the NAME d group capture as XML; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME]y | the NAME d group capture as hex; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME]v | the NAME d group capture as CSV; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]# | the first NAME d group capture that matched; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]b | the byte offset of the first NAME d group capture that matched; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]e | the ending byte offset of the first NAME d group capture that matched; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]d | the byte length of the first NAME d group capture that matched; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]j | the first NAME d group capture that matched, as JSON; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]q | the first NAME d group capture that matched, quoted; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]x | the first NAME d group capture that matched, as XML; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]y | the first NAME d group capture that matched, as hex; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]v | the first NAME d group capture that matched, as CSV; requires option -P and capturing pattern (?<NAME>PATTERN) |
%G | list of group capture indices/names of the match (see note) |
%[TEXT1|TEXT2|...]G | list of TEXT indexed by group capture indices that matched; requires option -P |
%g | the group capture index of the match or 1 (see note) |
%[TEXT1|TEXT2|...]g | the first TEXT indexed by the first group capture index that matched; requires option -P |
Notiz:
%~ is explicitly specified in the format string.-o changes the output of the %O and %Q fields to output the match only.-c , -l and -o change the output of %C , %J , %X and %Y accordingly[TEXT] part of a field is optional and may be omitted. When present, the argument must be placed in [] brackets, for example %[,]F to output a comma, the pathname, and a separator, when option -H is used.%n are padded with spaces when %{width}n is specified.%O are cut to width when %{width}O is specified or when %{-width}O is specified to cut from the end of the line.%{-width}o or %{+width}o is specified for match fields such as %o , where %{width}o without a +/- sign cuts the match to the specified width.%[SEP]$ and %u are switches and do not write anything to the output.%F , %H , %N , %K , %B , %S , and %G may be changed by preceding the field with a %[SEP]$ . When [SEP] is not provided, reverts the separator to the default separator or the separator specified by --separator .%u is found anywhere in the specified format string, matching lines are output only once unless option -u , --ungroup is used or when a newline is matched.%g corresponds to the index of the sub-pattern matched among the alternations in the pattern when option -P is not used. For example foo|bar matches foo with index 1 and bar with index 2. With option -P , the index corresponds to the number of the first group captured in the specified pattern.%[TEXT1|TEXT2|...]G and %[TEXT1|TEXT2|...]g should correspond to the group capture index (see the note above), ie TEXT1 is output for index 1, TEXT2 is output for index 2, and so on. If the list is too short, the index value is output or the name of a named group capture is output.-T and --pretty add right-justifying spacing to fields %N and %K if no leading [TEXT] part is specified.%+ may be used in --format-open to output the pathname heading and a newline break, respectively. Field %+ suppresses %a , %F , %f , %H , %h and %p output. To output matching lines faster by omitting the header output and binary match checks, using --format with field %O (output matching line as is) and field %~ (output newline):
ug --format='%O%~' 'href=' index.html
Same, but also displaying the line and column numbers:
ug --format='%n%k: %O%~' 'href=' index.html
Same, but display a line at most once when matching multiple patterns, unless option -u is used:
ug --format='%u%n%k: %O%~' 'href=' index.html
To string together a list of unique line numbers of matches, separated by commas with field %, :
ug --format='%u%,%n' 'href=' index.html
To output the matching part of a line only with field %o (or option -o with field %O ):
ug --format='%o%~' "href=["'][^"']["']" index.html
To string together the pattern matches as CSV-formatted strings with field %v separated by commas with field %, :
ug --format='%,%v' "href=["'][^"']["']" index.html
To output matches in CSV (comma-separated values), the same as option --csv (works with options -H , -n , -k , -b to add CSV values):
ug --format='"%[,]$%H%N%K%B%V%~%u"' 'href=' index.html
To output matches in AckMate format:
ug --format=":%f%~%n;%k %w:%O%~" 'href=' index.html
To output the sub-pattern indices 1, 2, and 3 on the left to the match for the three patterns foo , bar , and baz in file foobar.txt :
ug --format='%g: %o%~' 'foo|bar|baz' foobar.txt
Same, but using a file foos containing three lines with foo , bar , and baz , where option -F is used to match strings instead of regex:
ug -F -f foos --format='%g: %o%~' foobar.txt
To output one , two , and a word for the sub-patterns [fF]oo , [bB]ar , and any other word w+ , respectively, using argument [one|two|a word] with field %g indexed by sub-pattern (or group captures with option -P ):
ug --format='%[one|two|a word]g%~' '([fF]oo)|([bB]ar)|(w+)' foobar.txt
To output a list of group capture indices with %G separated by the word and instead of the default colons with %[ and ]$ , followed by the matching line:
ug -P --format='%[ and ]$%G%$%s%O%~' '(foo)|(ba((r)|(z)))' foobar.txt
Same, but showing names instead of numbers:
ug -P --format='%[ and ]$%[foo|ba|r|z]G%$%s%O%~' '(foo)|(ba(?:(r)|(z)))' foobar.txt
Note that option -P is required for general use of group captures for sub-patterns. Named sub-pattern matches may be used with PCRE2 and shown in the output:
ug -P --format='%[ and ]$%G%$%s%O%~' '(?P<foo>foo)|(?P<ba>ba(?:(?P<r>r)|(?P<z>z)))' foobar.txt
? Back to table of contents
--replace=FORMAT
Replace matching patterns in the output by the specified FORMAT
with `%' fields. If -P is specified, FORMAT may include `%1' to
`%9', `%[NUM]#' and `%[NAME]#' to output group captures. A `%%'
outputs `%' and `%~' outputs a newline. See option --format,
`ugrep --help format' and `man ugrep' section FORMAT for details.
-y, --any-line
Any line is output (passthru). Non-matching lines are output as
context with a `-' separator. See also options -A, -B, and -C.
-P, --perl-regexp
Interpret PATTERN as a Perl regular expression.
--format=FORMAT
Output FORMAT-formatted matches. For example --format='%f:%n:%O%~'
outputs matching lines `%O' with filename `%f` and line number `%n'
followed by a newline `%~'. If -P is specified, FORMAT may include
`%1' to `%9', `%[NUM]#' and `%[NAME]#' to output group captures. A
`%%' outputs `%'. See `ugrep --help format' and `man ugrep'
section FORMAT for details. When option -o is specified, option -u
is also enabled. Context options -A, -B, -C and -y are ignored.
See customized output with --format for details on the FORMAT fields.
For option -o , the replacement is not automatically followed by a newline to allow for more flexibility in replacements. To output a newline, use %~ in the FORMAT string.
Use option -P to use group captures and backreferences. Capturing groups in regex patterns are parenthesized expressions (pattern) and the first is referenced in FORMAT by %1 , the second by %2 and so on. Named captures are of the form (?<NAME>pattern) and are referenced in FORMAT by %[NAME]# .
To display pattern matches with their sequential match number using --replace='%m:%o' where %m is the sequential match number and %o is the pattern matched:
ug --replace='%m:%o' pattern myfile.txt
Same, but passing the file through with option -y , while applying the replacements to the output:
ug -y --replace='%m:%o' pattern myfile.txt
To extract table cells from an HTML file using Perl matching ( -P ) to support group captures with lazy quantifier (.*?) , and translate the matches to a comma-separated list with format %,%1 (conditional comma and group capture ):
ug -P -o '<td>(.*?)</td>' --replace='%,%1' index.html
Same, but using --format='%,%1' instead and we do not need -o (note that --replace color-highlights matches shown on a terminal but --format does not):
ug -P '<td>(.*?)</td>' --format='%,%1' index.html
Same, but displaying the formatted matches line-by-line, with --replace or with --format :
ug -P -o '<td>(.*?)</td>' --replace='%,%1' index.html
ug -P '<td>(.*?)</td>' --format='%1%~' index.html
To collect all href URLs from all HTML and PHP files down the working directory, then sort them:
ug -r -thtml,php -P '<[^<>]+hrefh*=h*.([^x27"]+).' --format='%1%~' | sort -u
Same, but much easier by using the predefined html/href pattern:
ug -r -thtml,php -P -f html/href --format='%1%~' | sort -u
Same, but in this case select <script> src URLs when referencing http and https sites:
ug -r -thtml,php -P '<script.*srch*=h*.(https?:[^x27"]+).' --format='%1%~' | sort -u
? Back to table of contents
--depth=[MIN,][MAX], -1, -2, -3, ... -9, -10, -11, -12, ...
Restrict recursive searches from MIN to MAX directory levels deep,
where -1 (--depth=1) searches the specified path without recursing
into subdirectories. Note that -3 -5, -3-5, and -35 search 3 to 5
levels deep. Enables -r if -R or -r is not specified.
-K [MIN,][MAX], --range=[MIN,][MAX], --min-line=MIN, --max-line=MAX
Start searching at line MIN, stop at line MAX when specified.
-m [MIN,][MAX], --min-count=MIN, --max-count=MAX
Require MIN matches, stop after MAX matches when specified. Output
MIN to MAX matches. For example, -m1 outputs the first match and
-cm1, (with a comma) counts nonzero matches. If -u is specified,
each individual match counts. See also option -K.
--max-files=NUM
Restrict the number of files matched to NUM. Note that --sort or
-J1 may be specified to produce replicable results. If --sort is
specified, the number of threads spawned is limited to NUM.
--sort[=KEY]
Displays matching files in the order specified by KEY in recursive
searches. Normally the ug command sorts by name whereas the ugrep
batch command displays matches in no particular order to improve
performance. The sort KEY can be `name' to sort by pathname
(default), `best' to sort by best match with option -Z (sort by
best match requires two passes over files, which is expensive),
`size' to sort by file size, `used' to sort by last access time,
`changed' to sort by last modification time and `created' to sort
by creation time. Sorting is reversed with `rname', `rbest',
`rsize', `rused', `rchanged', or `rcreated'. Archive contents are
not sorted. Subdirectories are sorted and displayed after matching
files. FILE arguments are searched in the same order as specified.
To show only up to the first 10 matching lines with FIXME in C++ files in the working directory and all subdirectories below:
ug -r -m10 -tc++ FIXME
Same, but recursively search up to two directory levels, meaning that ./ and ./sub/ are visited but not deeper:
ug -2 -m10 -tc++ FIXME
To show only the first two files that have one or more matches of FIXME in the list of files sorted by pathname, using --max-files=2 :
ug --sort -r --max-files=2 -tc++ FIXME
To search file install.sh for the occurrences of the word make after the first line, we use -K with line number 2 to start searching, where -n shows the line numbers in the output:
ug -n -K2 -w make install.sh
Same, but restricting the search to lines 2 to 40 (inclusive):
ug -n -K2,40 -w make install.sh
Same, but showing all lines 2 to 40 with -y :
ug -y -n -K2,40 -w make install.sh
Same, but showing only the first four matching lines after line 2, with one line of context:
ug -n -C1 -K2 -m4 -w make install.sh
? Back to table of contents
-Y, --empty
Permits empty matches. By default, empty matches are disabled,
unless a pattern begins with `^' or ends with `$'. Note that -Y
when specified with an empty-matching pattern, such as x? and x*,
match all input, not only lines containing the character `x'.
Option -Y permits empty pattern matches, like GNU/BSD grep. This option is introduced by ugrep to prevent accidental matching with empty patterns: empty-matching patterns such as x? and x* match all input, not only lines with x . By default, without -Y , patterns match lines with at least one x as intended.
This option is automatically enabled when a pattern starts with ^ or ends with $ is specified. For example, ^h*$ matches blank lines, including empty lines.
To recursively list files in the working directory with blank lines, ie lines with white space only, including empty lines (note that option -Y is implicitly enabled since the pattern starts with ^ and ends with $ ):
ug -l '^h*$'
? Back to table of contents
-i, --ignore-case
Perform case insensitive matching. By default, ugrep is case
sensitive. By default, this option applies to ASCII letters only.
Use options -P and -i for Unicode case insensitive matching.
-j, --smart-case
Perform case insensitive matching like option -i, unless a pattern
is specified with a literal ASCII upper case letter.
To match todo in myfile.cpp regardless of case:
ug -i 'todo' myfile.txt
To match todo XXX with todo in any case but XXX as given, with pattern (?i:todo) to match todo ignoring case:
ug '(?i:todo) XXX' myfile.cpp
? Back to table of contents
--sort[=KEY]
Displays matching files in the order specified by KEY in recursive
searches. Normally the ug command sorts by name whereas the ugrep
batch command displays matches in no particular order to improve
performance. The sort KEY can be `name' to sort by pathname
(default), `best' to sort by best match with option -Z (sort by
best match requires two passes over files, which is expensive),
`size' to sort by file size, `used' to sort by last access time,
`changed' to sort by last modification time and `created' to sort
by creation time. Sorting is reversed with `rname', `rbest',
`rsize', `rused', `rchanged', or `rcreated'. Archive contents are
not sorted. Subdirectories are sorted and displayed after matching
files. FILE arguments are searched in the same order as specified.
Matching files are displayed in the order specified by --sort per directory searched. By default, the ug command sorts by name whereas the output of the ugrep command is not sorted to improve performance, unless option -Q is used which sorts files by name. An optimized sorting method and strategy are implemented in the asynchronous output class to keep the overhead of sorting very low. Directories are displayed after files are displayed first, when recursing, which visually aids the user in finding the "closest" matching files first at the top of the displayed results.
To recursively search for C++ files that match main and sort them by date created:
ug --sort=created -tc++ 'main'
Same, but sorted by time changed from most recent to oldest:
ug --sort=rchanged -tc++ 'main'
? Back to table of contents
When searching non-binary files only, the binary content check is disabled with option -a ( --text ) to speed up searching and displaying pattern matches. For example, searching for lines with int in C++ source code:
ug -r -a -Ocpp -w 'int'
If a file has potentially many pattern matches, but each match is only one a single line, then option -u ( --ungroup ) can speed this up:
ug -r -a -u -Opython -w 'def'
Even greater speeds can be achieved with --format when searching files with many matches. For example, --format='%O%~' displays matching lines for each match on that line, while --format='%o%~' displays the matching part only. Note that the --format option does not check for binary matches, so the output is always "as is". To match text and binary, you can use --format='%C%~' to display matches formatted as quoted C++ strings with escapes. To display a line at most once (unless option -u is used), add the %u (unique) field to the format string, eg --format='%u%O%~' .
For example, to match all words recursively in the working directory with line and column numbers, where %n is the line number, %k is the column number, %o is the match (only matching), and %~ is a newline:
ug -r --format='%n,%k:%o%~' 'w+'
? Back to table of contents
To search for pattern -o in script.sh using -e to explicitly specify a pattern to prevent pattern -o from being interpreted as an option:
ug -n -e '-o' script.sh
Alternatively, using -- to end the list of command arguments:
ug -n -- '-o' script.sh
To recursively list all text files (.txt and .md) that do not properly end with a n ( -o is required to match n or z ):
ug -L -o -Otext 'nz'
To list all markdown sections in text files (.text, .txt, .TXT, and .md):
ug -o -ttext -e '^.*(?=r?n(===|---))' -e '^#{1,6}h+.*'
To display multi-line backtick and indented code blocks in markdown files with their line numbers, using a lazy quantifier *? to make the pattern compact:
ug -n -ttext -e '^```(.|n)*?n```' -e '^(t|[ ]{4}).*'
To find mismatched code (a backtick without matching backtick on the same line) in markdown:
ug -n -ttext -e '`[^`]+' -N '`[^`]*`'
? Back to table of contents
UGREP(1) User Commands UGREP(1)
NAME
ugrep, ug -- file pattern searcher
SYNOPSIS
ugrep [OPTIONS] [-i] [-Q|PATTERN] [-e PATTERN] [-N PATTERN] [-f FILE]
[-F|-G|-P|-Z] [-U] [-m [MIN,][MAX]] [--bool [--files|--lines]]
[-r|-R|-1|...|-9|-10|...] [-t TYPES] [-g GLOBS] [--sort[=KEY]]
[-l|-c] [-o] [-n] [-k] [-b] [-A NUM] [-B NUM] [-C NUM] [-y]
[--color[=WHEN]|--colour[=WHEN]] [--pretty] [--pager[=COMMAND]]
[--hexdump|--csv|--json|--xml] [-I] [-z] [--zmax=NUM] [FILE ...]
DESCRIPTION
The ugrep utility searches any given input files, selecting files and
lines that match one or more patterns specified as regular expressions or
as fixed strings. A pattern matches multiple input lines when the
pattern's regular expression matches one or more newlines. An empty
pattern matches every line. Each input line that matches at least one of
the patterns is written to the standard output.
The ug command is intended for interactive searching, using a .ugrep
configuration file located in the working directory or home directory,
see CONFIGURATION. ug is equivalent to ugrep --config --pretty --sort to
load a .ugrep file, enhance the terminal output, and sort files by name.
The ugrep+ and ug+ commands are the same as the ugrep and ug commands,
but also use filters to search pdfs, documents, e-books, and image
metadata, when the corresponding filter tools are installed.
A list of matching files is produced with option -l (--files-with-
matches). Option -c (--count) counts the number of matching lines. When
combined with option -o, counts the total number of matches. When
combined with option -m1, (--min-count=1), skips files with zero matches.
The default pattern syntax is an extended form of the POSIX ERE syntax,
same as option -E (--extended-regexp). Try ug --help regex for help with
pattern syntax and how to use logical connectives to specify Boolean
search queries with option -% (--bool) to match lines and -%% (--bool
--files) to match files. Options -F (--fixed-strings), -G (--basic-
regexp) and -P (--perl-regexp) specify other pattern syntaxes.
Option -i (--ignore-case) ignores case in ASCII patterns. When combined
with option -P, ignores case in Unicode patterns. Option -j (--smart-
case) enables -i only if the search patterns are specified in lower case.
Fuzzy (approximate) search is specified with option -Z (--fuzzy) with an
optional argument to control character insertions, deletions, and/or
substitutions. Try ug --help fuzzy for help with fuzzy search.
Note that pattern `.' matches any non-newline character. Pattern `n'
matches a newline character. Multiple lines may be matched with patterns
that match one or more newline characters.
The empty pattern "" matches all lines. Other empty-matching patterns do
not. For example, the pattern `a*' will match one or more a's. Option
-Y forces empty matches for compatibility with other grep tools.
Option -f FILE matches patterns specified in FILE.
By default Unicode patterns are matched. Option -U (--ascii or --binary)
disables Unicode matching for ASCII and binary pattern matching. Non-
Unicode matching is more efficient.
ugrep accepts input of various encoding formats and normalizes the output
to UTF-8. When a UTF byte order mark is present in the input, the input
is automatically normalized. An input encoding format may be specified
with option --encoding.
If no FILE arguments are specified and standard input is read from a
terminal, recursive searches are performed as if -r is specified. To
force reading from standard input, specify `-' as a FILE argument.
Directories specified as FILE arguments are searched without recursing
deeper into subdirectories, unless -R, -r, or -2...-9 is specified to
search subdirectories recursively (up to the specified depth.)
Option -I (--ignore-binary) ignores binary files. A binary file is a
file with non-text content. A file with zero bytes or invalid UTF
formatting is considered binary.
Hidden files and directories are ignored in recursive searches. Option
-. (--hidden) includes hidden files and directories in recursive
searches.
To match the names of files to search and the names of directories to
recurse, one or more of the following options may be specified. Option
-O specifies one or more filename extensions to match. Option -t
specifies one or more file types to search (-t list outputs a list of
types.) Option -g specifies a gitignore-style glob pattern to match
filenames. Option --ignore-files specifies a file with gitignore-style
globs to ignore directories and files. Try ug --help globs for help with
filename and directory name matching. See also section GLOBBING.
Compressed files and archives are searched with option -z (--decompress).
When used with option --zmax=NUM, searches the contents of compressed
files and archives stored within archives up to NUM levels.
A query terminal user interface (TUI) is opened with -Q (--query) to
interactively specify search patterns and view search results. A PATTERN
argument requires -e PATTERN to start the query TUI with the specified
pattern.
Output to a terminal for viewing is enhanced with --pretty, which is
enabled by default with the ug command.
A terminal output pager is enabled with --pager.
Customized output is produced with option --format or --replace. Try ug
--help format for help with custom formatting of the output. Predefined
formats include CSV with option --csv, JSON with option --json, and XML
with option --xml. Hexdumps are output with option -X (--hex) or with
option --hexdump to customize hexdumps. See also section FORMAT.
A `--' signals the end of options; the rest of the parameters are FILE
arguments, allowing filenames to begin with a `-' character.
Long options may start with `--no-' to disable, when applicable.
ug --help WHAT displays help on options related to WHAT.
The following options are available:
-A NUM, --after-context=NUM
Output NUM lines of trailing context after matching lines. Places
a --group-separator between contiguous groups of matches. If -o
is specified, output the match with context to fit NUM columns
after the match or shortens the match. See also options -B, -C
and -y.
-a, --text
Process a binary file as if it were text. This is equivalent to
the --binary-files=text option. This option might output binary
garbage to the terminal, which can have problematic consequences
if the terminal driver interprets some of it as commands.
--all, -@
Search all files except hidden: cancel previous file and directory
search restrictions and cancel --ignore-binary and --ignore-files
when specified. Restrictions specified after this option, i.e. to
the right, are still applied. For example, -@I searches all
non-binary files and -@. searches all files including hidden
files. Note that hidden files and directories are never searched,
unless option -. or --hidden is specified.
--and [-e] PATTERN
Specify additional PATTERN that must match. Additional -e PATTERN
following this option is considered an alternative pattern to
match, i.e. each -e is interpreted as an OR pattern enclosed
within the AND. For example, -e A -e B --and -e C -e D matches
lines with (`A' or `B') and (`C' or `D'). Note that multiple -e
PATTERN are alternations that bind more tightly together than
--and. Option --stats displays the search patterns applied. See
also options --not, --andnot, --bool, --files and --lines.
--andnot [-e] PATTERN
Combines --and --not. See also options --and, --not and --bool.
-B NUM, --before-context=NUM
Output NUM lines of leading context before matching lines. Places
a --group-separator between contiguous groups of matches. If -o
is specified, output the match with context to fit NUM columns
before the match or shortens the match. See also options -A, -C
and -y.
-b, --byte-offset
The offset in bytes of a pattern match is displayed in front of
the respective matched line. When -u is specified, displays the
offset for each pattern matched on the same line. Byte offsets
are exact for ASCII, UTF-8 and raw binary input. Otherwise, the
byte offset in the UTF-8 normalized input is displayed.
--binary-files=TYPE
Controls searching and reporting pattern matches in binary files.
TYPE can be `binary', `without-match`, `text`, `hex` and
`with-hex'. The default is `binary' to search binary files and to
report a match without displaying the match. `without-match'
ignores binary matches. `text' treats all binary files as text,
which might output binary garbage to the terminal, which can have
problematic consequences if the terminal driver interprets some of
it as commands. `hex' reports all matches in hexadecimal.
`with-hex' only reports binary matches in hexadecimal, leaving
text matches alone. A match is considered binary when matching a
zero byte or invalid UTF. Short options are -a, -I, -U, -W and
-X.
--bool, -%, -%%
Specifies Boolean query patterns. A Boolean query pattern is
composed of `AND', `OR', `NOT' operators and grouping with `('
`)'. Spacing between subpatterns is the same as `AND', `|' is the
same as `OR' and a `-' is the same as `NOT'. The `OR' operator
binds more tightly than `AND'. For example, --bool 'A|B C|D'
matches lines with (`A' or `B') and (`C' or `D'), --bool 'A -B'
matches lines with `A' and not `B'. Operators `AND', `OR', `NOT'
require proper spacing. For example, --bool 'A OR B AND C OR D'
matches lines with (`A' or `B') and (`C' or `D'), --bool 'A AND
NOT B' matches lines with `A' without `B'. Quoted subpatterns are
matched literally as strings. For example, --bool 'A "AND"|"OR"'
matches lines with `A' and also either `AND' or `OR'. Parentheses
are used for grouping. For example, --bool '(A B)|C' matches
lines with `A' and `B', or lines with `C'. Note that all
subpatterns in a Boolean query pattern are regular expressions,
unless -F is specified. Options -E, -F, -G, -P and -Z can be
combined with --bool to match subpatterns as strings or regular
expressions (-E is the default.) This option does not apply to -f
FILE patterns. The double short option -%% enables options --bool
--files. Option --stats displays the Boolean search patterns
applied. See also options --and, --andnot, --not, --files and
--lines.
--break
Adds a line break between results from different files. This
option is enabled by --heading.
-C NUM, --context=NUM
Output NUM lines of leading and trailing context surrounding each
matching line. Places a --group-separator between contiguous
groups of matches. If -o is specified, output the match with
context to fit NUM columns before and after the match or shortens
the match. See also options -A, -B and -y.
-c, --count
Only a count of selected lines is written to standard output. If
-o or -u is specified, counts the number of patterns matched. If
-v is specified, counts the number of non-matching lines. If -m1,
(with a comma or --min-count=1) is specified, counts only matching
files without outputting zero matches.
--color[=WHEN], --colour[=WHEN]
Mark up the matching text with the colors specified with option
--colors or the GREP_COLOR or GREP_COLORS environment variable.
WHEN can be `never', `always', or `auto', where `auto' marks up
matches only when output on a terminal. The default is `auto'.
--colors=COLORS, --colours=COLORS
Use COLORS to mark up text. COLORS is a colon-separated list of
one or more parameters `sl=' (selected line), `cx=' (context
line), `mt=' (matched text), `ms=' (match selected), `mc=' (match
context), `fn=' (file name), `ln=' (line number), `cn=' (column
number), `bn=' (byte offset), `se=' (separator), `qp=' (TUI
prompt), `qe=' (TUI errors), `qr=' (TUI regex), `qm=' (TUI regex
meta characters), `ql=' (TUI regex lists and literals), `qb=' (TUI
regex braces). Parameter values are ANSI SGR color codes or `k'
(black), `r' (red), `g' (green), `y' (yellow), `b' (blue), `m'
(magenta), `c' (cyan), `w' (white), or leave empty for no color.
Upper case specifies background colors. A `+' qualifies a color
as bright. A foreground and a background color may be combined
with font properties `n' (normal), `f' (faint), `h' (highlight),
`i' (invert), `u' (underline). Parameter `hl' enables file name
hyperlinks. Parameter `rv' reverses the `sl=' and `cx='
parameters when option -v is specified. Selectively overrides
GREP_COLORS. Legacy grep single parameter codes may be specified,
for example --colors='7;32' or --colors=ig to set ms (match
selected).
--config[=FILE], ---[FILE]
Use configuration FILE. The default FILE is `.ugrep'. The
working directory is checked first for FILE, then the home
directory. The options specified in the configuration FILE are
parsed first, followed by the remaining options specified on the
command line. The ug command automatically loads a `.ugrep'
configuration file, unless --config=FILE or --no-config is
specified.
--no-config
Do not automatically load the default .ugrep configuration file.
--no-confirm
Do not confirm actions in -Q query TUI. The default is confirm.
--cpp Output file matches in C++. See also options --format and -u.
--csv Output file matches in CSV. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
-D ACTION, --devices=ACTION
If an input file is a device, FIFO or socket, use ACTION to
process it. By default, ACTION is `skip', which means that
devices are silently skipped. If ACTION is `read', devices read
just as if they were ordinary files.
-d ACTION, --directories=ACTION
If an input file is a directory, use ACTION to process it. By
default, ACTION is `skip', i.e., silently skip directories unless
specified on the command line. If ACTION is `read', warn when
directories are read as input. If ACTION is `recurse', read all
files under each directory, recursively, following symbolic links
only if they are on the command line. This is equivalent to the
-r option. If ACTION is `dereference-recurse', read all files
under each directory, recursively, following symbolic links. This
is equivalent to the -R option.
--delay=DELAY
Set the default -Q key response delay. Default is 3 for 300ms.
--depth=[MIN,][MAX], -1, -2, -3, ... -9, -10, -11, ...
Restrict recursive searches from MIN to MAX directory levels deep,
where -1 (--depth=1) searches the specified path without recursing
into subdirectories. The short forms -3 -5, -3-5 and -3,5 search
3 to 5 levels deep. Enables -r if -R or -r is not specified.
--dotall
Dot `.' in regular expressions matches anything, including
newline. Note that `.*' matches all input and should not be used.
-E, --extended-regexp
Interpret patterns as extended regular expressions (EREs). This is
the default.
-e PATTERN, --regexp=PATTERN
Specify a PATTERN to search the input. An input line is selected
if it matches any of the specified patterns. This option is
useful when multiple -e options are used to specify multiple
patterns, or when a pattern begins with a dash (`-'), or to
specify a pattern after option -f or after the FILE arguments.
--encoding=ENCODING
The encoding format of the input. The default ENCODING is binary
and UTF-8 which are the same. Note that option -U specifies
binary PATTERN matching (text matching is the default.) ENCODING
can be: `binary', `ASCII', `UTF-8', `UTF-16', `UTF-16BE',
`UTF-16LE', `UTF-32', `UTF-32BE', `UTF-32LE', `LATIN1',
`ISO-8859-1', `ISO-8859-2', `ISO-8859-3', `ISO-8859-4',
`ISO-8859-5', `ISO-8859-6', `ISO-8859-7', `ISO-8859-8',
`ISO-8859-9', `ISO-8859-10', `ISO-8859-11', `ISO-8859-13',
`ISO-8859-14', `ISO-8859-15', `ISO-8859-16', `MAC', `MACROMAN',
`EBCDIC', `CP437', `CP850', `CP858', `CP1250', `CP1251', `CP1252',
`CP1253', `CP1254', `CP1255', `CP1256', `CP1257', `CP1258',
`KOI8-R', `KOI8-U', `KOI8-RU'.
--exclude=GLOB
Exclude files whose name matches GLOB, same as -g ^GLOB. GLOB can
use **, *, ?, and [...] as wildcards and to quote a wildcard or
backslash character literally. When GLOB contains a `/', full
pathnames are matched. Otherwise basenames are matched. When
GLOB ends with a `/', directories are excluded as if --exclude-dir
is specified. Otherwise files are excluded. Note that --exclude
patterns take priority over --include patterns. GLOB should be
quoted to prevent shell globbing. This option may be repeated.
--exclude-dir=GLOB
Exclude directories whose name matches GLOB from recursive
searches, same as -g ^GLOB/. GLOB can use **, *, ?, and [...] as
wildcards and to quote a wildcard or backslash character
literally. When GLOB contains a `/', full pathnames are matched.
Otherwise basenames are matched. Note that --exclude-dir patterns
take priority over --include-dir patterns. GLOB should be quoted
to prevent shell globbing. This option may be repeated.
--exclude-from=FILE
Read the globs from FILE and skip files and directories whose name
matches one or more globs. A glob can use **, *, ?, and [...] as
wildcards and to quote a wildcard or backslash character
literally. When a glob contains a `/', full pathnames are
matched. Otherwise basenames are matched. When a glob ends with
a `/', directories are excluded as if --exclude-dir is specified.
Otherwise files are excluded. A glob starting with a `!'
overrides previously-specified exclusions by including matching
files. Lines starting with a `#' and empty lines in FILE are
ignored. When FILE is a `-', standard input is read. This option
may be repeated.
--exclude-fs=MOUNTS
Exclude file systems specified by MOUNTS from recursive searches.
MOUNTS is a comma-separated list of mount points or pathnames to
directories. When MOUNTS is not specified, only descends into the
file systems associated with the specified file and directory
search targets, i.e. excludes all other file systems. Note that
--exclude-fs=MOUNTS take priority over --include-fs=MOUNTS. This
option may be repeated.
-F, --fixed-strings
Interpret pattern as a set of fixed strings, separated by
newlines, any of which is to be matched. This makes ugrep behave
as fgrep. If a PATTERN is specified, or -e PATTERN or -N PATTERN,
then this option has no effect on -f FILE patterns to allow -f
FILE patterns to narrow or widen the scope of the PATTERN search.
-f FILE, --file=FILE
Read newline-separated patterns from FILE. White space in
patterns is significant. Empty lines in FILE are ignored. If
FILE does not exist, the GREP_PATH environment variable is used as
path to FILE. If that fails, looks for FILE in
/usr/local/share/ugrep/patterns. When FILE is a `-', standard
input is read. Empty files contain no patterns; thus nothing is
matched. This option may be repeated.
--filter=COMMANDS
Filter files through the specified COMMANDS first before
searching. COMMANDS is a comma-separated list of `exts:command
arguments', where `exts' is a comma-separated list of filename
extensions and `command' is a filter utility. Files matching one
of `exts' are filtered. A `*' matches any file. The specified
`command' may include arguments separated by spaces. An argument
may be quoted to include spacing, commas or a `%'. A `%' argument
expands into the pathname to search. For example,
--filter='pdf:pdftotext % -' searches PDF files. The `%' expands
into a `-' when searching standard input. When a `%' is not
specified, the filter command should read from standard input and
write to standard output. Option --label=.ext may be used to
specify extension `ext' when searching standard input. This
option may be repeated.
--filter-magic-label=[+]LABEL:MAGIC
Associate LABEL with files whose signature "magic bytes" match the
MAGIC regex pattern. Only files that have no filename extension
are labeled, unless +LABEL is specified. When LABEL matches an
extension specified in --filter=COMMANDS, the corresponding
command is invoked. This option may be repeated.
--format=FORMAT
Output FORMAT-formatted matches. For example
--format='%f:%n:%O%~' outputs matching lines `%O' with filename
`%f` and line number `%n' followed by a newline `%~'. If -P is
specified, FORMAT may include `%1' to `%9', `%[NUM]#' and
`%[NAME]#' to output group captures. A `%%' outputs `%'. See
`ugrep --help format' and `man ugrep' section FORMAT for details.
When option -o is specified, option -u is also enabled. Context
options -A, -B, -C and -y are ignored.
--free-space
Spacing (blanks and tabs) in regular expressions are ignored.
-G, --basic-regexp
Interpret patterns as basic regular expressions (BREs).
-g GLOBS, --glob=GLOBS, --iglob=GLOBS
Only search files whose name matches the specified comma-separated
list of GLOBS, same as --include=glob for each `glob' in GLOBS.
When a `glob' is preceded by a `!' or a `^', skip files whose name
matches `glob', same as --exclude='glob'. When `glob' contains a
`/', full pathnames are matched. Otherwise basenames are matched.
When `glob' ends with a `/', directories are matched, same as
--include-dir='glob' and --exclude-dir='glob'. A leading `/'
matches the working directory. Option --iglob performs
case-insensitive name matching. This option may be repeated and
may be combined with options -M, -O and -t to expand searches.
See `ugrep --help globs' and `man ugrep' section GLOBBING for
details.
--glob-ignore-case
Perform case-insensitive glob matching in general.
--group-separator[=SEP]
Use SEP as a group separator for context options -A, -B and -C.
The default is a double hyphen (`--').
--no-group-separator
Removes the group separator line from the output for context
options -A, -B and -C.
-H, --with-filename
Always print the filename with output lines. This is the default
when there is more than one file to search.
-h, --no-filename
Never print filenames with output lines. This is the default when
there is only one file (or only standard input) to search.
--heading, -+
Group matches per file. Adds a heading and a line break between
results from different files. This option is enabled by --pretty
when the output is sent to a terminal.
--help [WHAT], -? [WHAT]
Display a help message on options related to WHAT when specified.
In addition, `--help regex' displays an overview of regular
expressions, `--help globs' displays an overview of glob syntax
and conventions. `--help fuzzy' displays details of fuzzy search
with option -Z and `--help format' displays a list of --format
fields.
--hexdump[=[1-8][a][bch][A[NUM]][B[NUM]][C[NUM]]]
Output matches in 1 to 8 columns of 8 hexadecimal octets. The
default is 2 columns or 16 octets per line. Argument `a' outputs
a `*' for all hex lines that are identical to the previous hex
line, `b' removes all space breaks, `c' removes the character
column, `h' removes hex spacing, `A' includes up to NUM hex lines
after a match, `B' includes up to NUM hex lines before a match and
`C' includes up to NUM hex lines before and after a match.
Arguments `A', `B' and `C' are the same as options -A, -B and -C
when used with --hexdump. See also options -U, -W and -X.
--hidden, -.
Search hidden files and directories.
--hyperlink[=[PREFIX][+]]
Hyperlinks are enabled for file names when colors are enabled.
Same as --colors=hl. When PREFIX is specified, replaces file://
with PREFIX:// in the hyperlink. A `+' includes the line number
in the hyperlink and when option -k is specified, the column
number.
-I, --ignore-binary
Ignore matches in binary files. This option is equivalent to the
--binary-files=without-match option.
-i, --ignore-case
Perform case insensitive matching. By default, ugrep is case
sensitive. By default, this option applies to ASCII letters only.
Use options -P and -i for Unicode case insensitive matching.
--ignore-files[=FILE]
Ignore files and directories matching the globs in each FILE that
is encountered in recursive searches. The default FILE is
`.gitignore'. Matching files and directories located in the
directory of the FILE and in subdirectories below are ignored.
Globbing syntax is the same as the --exclude-from=FILE gitignore
syntax, but files and directories are excluded instead of only
files. Directories are specifically excluded when the glob ends
in a `/'. Files and directories explicitly specified as command
line arguments are never ignored. This option may be repeated to
specify additional files.
--no-ignore-files
Do not ignore files, i.e. cancel --ignore-files when specified.
--include=GLOB
Only search files whose name matches GLOB, same as -g GLOB. GLOB
can use **, *, ?, and [...] as wildcards and to quote a wildcard
or backslash character literally. When GLOB contains a `/', full
pathnames are matched. Otherwise basenames are matched. When
GLOB ends with a `/', directories are included as if --include-dir
is specified. Otherwise files are included. Note that --exclude
patterns take priority over --include patterns. GLOB should be
quoted to prevent shell globbing. This option may be repeated.
--include-dir=GLOB
Only directories whose name matches GLOB are included in recursive
searches, same as -g GLOB/. GLOB can use **, *, ?, and [...] as
wildcards and to quote a wildcard or backslash character
literally. When GLOB contains a `/', full pathnames are matched.
Otherwise basenames are matched. Note that --exclude-dir patterns
take priority over --include-dir patterns. GLOB should be quoted
to prevent shell globbing. This option may be repeated.
--include-from=FILE
Read the globs from FILE and search only files and directories
whose name matches one or more globs. A glob can use **, *, ?,
and [...] as wildcards and to quote a wildcard or backslash
character literally. When a glob contains a `/', full pathnames
are matched. Otherwise basenames are matched. When a glob ends
with a `/', directories are included as if --include-dir is
specified. Otherwise files are included. A glob starting with a
`!' overrides previously-specified inclusions by excluding
matching files. Lines starting with a `#' and empty lines in FILE
are ignored. When FILE is a `-', standard input is read. This
option may be repeated.
--include-fs=MOUNTS
Only file systems specified by MOUNTS are included in recursive
searches. MOUNTS is a comma-separated list of mount points or
pathnames to directories. When MOUNTS is not specified, restricts
recursive searches to the file system of the working directory,
same as --include-fs=. (dot). Note that --exclude-fs=MOUNTS take
priority over --include-fs=MOUNTS. This option may be repeated.
--index
Perform fast index-based recursive search. This option assumes,
but does not require, that files are indexed with ugrep-indexer.
This option also enables option -r or --recursive. Skips indexed
non-matching files, archives and compressed files. Significant
acceleration may be achieved on cold (not file-cached) and large
file systems, or any file system that is slow to search. Note
that the start-up time to search may be increased when complex
search patterns are specified that contain large Unicode character
classes combined with `*' or `+' repeats, which should be avoided.
Option -U (--ascii) improves performance. Option --stats displays
an index search report.
-J NUM, --jobs=NUM
Specifies the number of threads spawned to search files. By
default an optimum number of threads is spawned to search files
simultaneously. -J1 disables threading: files are searched in the
same order as specified.
-j, --smart-case
Perform case insensitive matching, unless a pattern is specified
with a literal upper case ASCII letter.
--json Output file matches in JSON. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
-K [MIN,][MAX], --range=[MIN,][MAX], --min-line=MIN, --max-line=MAX
Start searching at line MIN, stop at line MAX when specified.
-k, --column-number
The column number of a pattern match is displayed in front of the
respective matched line, starting at column 1. Tabs are expanded
in counting columns, see also option --tabs.
-L, --files-without-match
Only the names of files not containing selected lines are written
to standard output. Pathnames are listed once per file searched.
If the standard input is searched, the string ``(standard input)''
is written.
-l, --files-with-matches
Only the names of files containing selected lines are written to
standard output. ugrep will only search a file until a match has
been found, making searches potentially less expensive. Pathnames
are listed once per file searched. If the standard input is
searched, the string ``(standard input)'' is written.
--label=LABEL
Displays the LABEL value when input is read from standard input
where a file name would normally be printed in the output.
Associates a filename extension with standard input when LABEL has
a suffix. The default value is `(standard input)'.
--line-buffered
Force output to be line buffered instead of block buffered.
--lines
Boolean line matching mode for option --bool, the default mode.
-M MAGIC, --file-magic=MAGIC
Only search files matching the magic signature pattern MAGIC. The
signature "magic bytes" at the start of a file are compared to the
MAGIC regex pattern. When matching, the file will be searched.
When MAGIC is preceded by a `!' or a `^', skip files with matching
MAGIC signatures. This option may be repeated and may be combined
with options -O and -t to expand the search. Every file on the
search path is read, making searches potentially more expensive.
-m [MIN,][MAX], --min-count=MIN, --max-count=MAX
Require MIN matches, stop after MAX matches when specified.
Output MIN to MAX matches. For example, -m1 outputs the first
match and -cm1, (with a comma) counts nonzero matches. If -u is
specified, each individual match counts. See also option -K.
--match
Match all input. Same as specifying an empty pattern to search.
--max-files=NUM
Restrict the number of files matched to NUM. Note that --sort or
-J1 may be specified to produce replicable results. If --sort is
specified, the number of threads spawned is limited to NUM.
--mmap[=MAX]
Use memory maps to search files. By default, memory maps are used
under certain conditions to improve performance. When MAX is
specified, use up to MAX mmap memory per thread.
-N PATTERN, --neg-regexp=PATTERN
Specify a negative PATTERN to reject specific -e PATTERN matches
with a counter pattern. Note that longer patterns take precedence
over shorter patterns, i.e. a negative pattern must be of the same
length or longer to reject matching patterns. Option -N cannot be
specified with -P. This option may be repeated.
-n, --line-number
Each output line is preceded by its relative line number in the
file, starting at line 1. The line number counter is reset for
each file processed.
--not [-e] PATTERN
Specifies that PATTERN should not match. Note that -e A --not -e
B matches lines with `A' or lines without a `B'. To match lines
with `A' that have no `B', specify -e A --andnot -e B. Option
--stats displays the search patterns applied. See also options
--and, --andnot, --bool, --files and --lines.
-O EXTENSIONS, --file-extension=EXTENSIONS
Only search files whose filename extensions match the specified
comma-separated list of EXTENSIONS, same as -g '*.ext' for each
`ext' in EXTENSIONS. When an `ext' is preceded by a `!' or a `^',
skip files whose filename extensions matches `ext', same as -g
'^*.ext'. This option may be repeated and may be combined with
options -g, -M and -t to expand the recursive search.
-o, --only-matching
Only the matching part of a pattern match is output. If -A, -B or
-C is specified, fits the match and its context on a line within
the specified number of columns.
--only-line-number
Only the line number of a matching line is output. The line
number counter is reset for each file processed.
--files, -%%
Boolean file matching mode, the opposite of --lines. When
combined with option --bool, matches a file if all Boolean
conditions are satisfied. For example, --bool --files 'A B|C -D'
matches a file if some lines match `A', and some lines match
either `B' or `C', and no line matches `D'. See also options
--and, --andnot, --not, --bool and --lines. The double short
option -%% enables options --bool --files.
-P, --perl-regexp
Interpret PATTERN as a Perl regular expression using PCRE2. Note
that Perl pattern matching differs from the default grep POSIX
pattern matching.
-p, --no-dereference
If -R or -r is specified, do not follow symbolic links, even when
symbolic links are specified on the command line.
--pager[=COMMAND]
When output is sent to the terminal, uses COMMAND to page through
the output. COMMAND defaults to environment variable PAGER when
defined or `less'. Enables --heading and --line-buffered.
--pretty[=WHEN]
When output is sent to a terminal, enables --color, --heading, -n,
--sort, --tree and -T when not explicitly disabled. WHEN can be
`never', `always', or `auto'. The default is `auto'.
-Q[=DELAY], --query[=DELAY]
Query mode: start a TUI to perform interactive searches. This
mode requires an ANSI capable terminal. An optional DELAY
argument may be specified to reduce or increase the response time
to execute searches after the last key press, in increments of
100ms, where the default is 3 (300ms delay). No whitespace may be
given between -Q and its argument DELAY. Initial patterns may be
specified with -e PATTERN, i.e. a PATTERN argument requires option
-e. Press F1 or CTRL-Z to view the help screen. Press F2 or
CTRL-Y to invoke a command to view or edit the file shown at the
top of the screen. The command can be specified with option
--view and defaults to environment variable PAGER when defined, or
VISUAL or EDITOR. Press Tab or Shift-Tab to navigate directories
and to select a file to search. Press Enter to select lines to
output. Press ALT-l for option -l to list files, ALT-n for -n,
etc. Non-option commands include ALT-] to increase context and
ALT-} to increase fuzzyness. See also options --no-confirm,
--delay, --split and --view.
-q, --quiet, --silent
Quiet mode: suppress all output. Only search a file until a match
has been found.
-R, --dereference-recursive
Recursively read all files under each directory, following
symbolic links to files and directories, unlike -r.
-r, --recursive
Recursively read all files under each directory, following
symbolic links only if they are on the command line. Note that
when no FILE arguments are specified and input is read from a
terminal, recursive searches are performed as if -r is specified.
--replace=FORMAT
Replace matching patterns in the output by FORMAT with `%' fields.
If -P is specified, FORMAT may include `%1' to `%9', `%[NUM]#' and
`%[NAME]#' to output group captures. A `%%' outputs `%' and `%~'
outputs a newline. See also option --format, `ugrep --help
format' and `man ugrep' section FORMAT for details.
-S, --dereference-files
When -r is specified, follow symbolic links to files, but not to
directories. The default is not to follow symbolic links.
-s, --no-messages
Silent mode: nonexistent and unreadable files are ignored and
their error messages and warnings are suppressed.
--save-config[=FILE] [OPTIONS]
Save configuration FILE to include OPTIONS. Update FILE when
first loaded with --config=FILE. The default FILE is `.ugrep',
which is automatically loaded by the ug command. When FILE is a
`-', writes the configuration to standard output. Only part of
the OPTIONS are saved that do not cause searches to fail when
combined with other options. Additional options may be specified
by editing the saved configuration file. A configuration file may
be modified manually to specify one or more config[=FILE] to
indirectly load the specified FILE, but recursive config loading
is not allowed.
--separator[=SEP], --context-separator=SEP
Use SEP as field separator between file name, line number, column
number, byte offset and the matched line. The default separator
is a colon (`:') and a bar (`|') for multi-line pattern matches,
and a dash (`-') for context lines. See also option
--group-separator.
--split
Split the -Q query TUI screen on startup.
--sort[=KEY]
Displays matching files in the order specified by KEY in recursive
searches. Normally the ug command sorts by name whereas the ugrep
batch command displays matches in no particular order to improve
performance. The sort KEY can be `name' to sort by pathname
(default), `best' to sort by best match with option -Z (sort by
best match requires two passes over files, which is expensive),
`size' to sort by file size, `used' to sort by last access time,
`changed' to sort by last modification time and `created' to sort
by creation time. Sorting is reversed with `rname', `rbest',
`rsize', `rused', `rchanged', or `rcreated'. Archive contents are
not sorted. Subdirectories are sorted and displayed after
matching files. FILE arguments are searched in the same order as
specified.
--stats
Output statistics on the number of files and directories searched
and the inclusion and exclusion constraints applied.
-T, --initial-tab
Add a tab space to separate the file name, line number, column
number and byte offset with the matched line.
-t TYPES, --file-type=TYPES
Search only files associated with TYPES, a comma-separated list of
file types. Each file type corresponds to a set of filename
extensions passed to option -O and filenames passed to option -g.
For capitalized file types, the search is expanded to include
files with matching file signature magic bytes, as if passed to
option -M. When a type is preceded by a `!' or a `^', excludes
files of the specified type. Specifying the initial part of a
type name suffices when the choice is unambiguous. This option
may be repeated. The possible file types can be (-tlist displays
a list): `actionscript', `ada', `asm', `asp', `aspx', `autoconf',
`automake', `awk', `Awk', `basic', `batch', `bison', `c', `c++',
`clojure', `cpp', `csharp', `css', `csv', `dart', `Dart',
`delphi', `elisp', `elixir', `erlang', `fortran', `gif', `Gif',
`go', `groovy', `gsp', `haskell', `html', `jade', `java', `jpeg',
`Jpeg', `js', `json', `jsp', `julia', `kotlin', `less', `lex',
`lisp', `lua', `m4', `make', `markdown', `matlab', `node', `Node',
`objc', `objc++', `ocaml', `parrot', `pascal', `pdf', `Pdf',
`perl', `Perl', `php', `Php', `png', `Png', `prolog', `python',
`Python', `r', `rpm', `Rpm', `rst', `rtf', `Rtf', `ruby', `Ruby',
`rust', `scala', `scheme', `shell', `Shell', `smalltalk', `sql',
`svg', `swift', `tcl', `tex', `text', `tiff', `Tiff', `tt',
`typescript', `verilog', `vhdl', `vim', `xml', `Xml', `yacc',
`yaml', `zig'.
--tabs[=NUM]
Set the tab size to NUM to expand tabs for option -k. The value
of NUM may be 1 (no expansion), 2, 4, or 8. The default size is
8.
--tag[=TAG[,END]]
Disables colors to mark up matches with TAG. END marks the end of
a match if specified, otherwise TAG. The default is `___'.
--tree, -^
Output directories with matching files in a tree-like format for
option -c or --count, -l or --files-with-matches, -L or
--files-without-match. This option is enabled by --pretty when
the output is sent to a terminal.
-U, --ascii, --binary
Disables Unicode matching for ASCII and binary matching. PATTERN
matches bytes, not Unicode characters. For example, -U 'xa3'
matches byte A3 (hex) instead of the Unicode code point U+00A3
represented by the UTF-8 sequence C2 A3. See also option
--dotall.
-u, --ungroup
Do not group multiple pattern matches on the same matched line.
Output the matched line again for each additional pattern match.
-V, --version
Display version with linked libraries and exit.
-v, --invert-match
Selected lines are those not matching any of the specified
patterns.
--view[=COMMAND]
Use COMMAND to view/edit a file in -Q query TUI by pressing
CTRL-Y.
-W, --with-hex
Output binary matches in hexadecimal, leaving text matches alone.
This option is equivalent to the --binary-files=with-hex option.
To omit the matching line from the hex output, use both options -W
and --hexdump. See also options -U.
-w, --word-regexp
The PATTERN is searched for as a word, such that the matching text
is preceded by a non-word character and is followed by a non-word
character. Word-like characters are Unicode letters, digits and
connector punctuations such as underscore.
--width[=NUM]
Truncate the output to NUM visible characters per line. The width
of the terminal window is used if NUM is not specified. Note that
double wide characters in the output may result in wider lines.
-X, --hex
Output matches and matching lines in hexadecimal. This option is
equivalent to the --binary-files=hex option. To omit the matching
line from the hex output use option --hexdump. See also option
-U.
-x, --line-regexp
Select only those matches that exactly match the whole line, as if
the patterns are surrounded by ^ and $.
--xml Output file matches in XML. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
-Y, --empty
Permits empty matches. By default, empty matches are disabled,
unless a pattern begins with `^' or ends with `$'. With this
option, empty-matching patterns such as x? and x*, match all
input, not only lines containing the character `x'.
-y, --any-line, --passthru
Any line is output (passthru). Non-matching lines are output as
context with a `-' separator. See also options -A, -B and -C.
-Z[best][+-~][MAX], --fuzzy[=[best][+-~][MAX]]
Fuzzy mode: report approximate pattern matches within MAX errors.
The default is -Z1: one deletion, insertion or substitution is
allowed. If `+`, `-' and/or `~' is specified, then `+' allows
insertions, `-' allows deletions and `~' allows substitutions.
For example, -Z+~3 allows up to three insertions or substitutions,
but no deletions. If `best' is specified, then only the best
matching lines are output with the lowest cost per file. Option
-Zbest requires two passes over a file and cannot be used with
standard input or Boolean queries. Option --sort=best orders
matching files by best match. The first character of an
approximate match always matches a character at the beginning of
the pattern. To fuzzy match the first character, replace it with
a `.' or `.?'. Option -U applies fuzzy matching to ASCII and
bytes instead of Unicode text. No whitespace may be given between
-Z and its argument.
-z, --decompress
Search compressed files and archives. Archives (.cpio, .pax,
.tar) and compressed archives (e.g. .zip, .7z, .taz, .tgz, .tpz,
.tbz, .tbz2, .tb2, .tz2, .tlz, .txz, .tzst) are searched and
matching pathnames of files in archives are output in braces.
When used with option --zmax=NUM, searches the contents of
compressed files and archives stored within archives up to NUM
levels. If -g, -O, -M, or -t is specified, searches files stored
in archives whose filenames match globs, match filename
extensions, match file signature magic bytes, or match file types,
respectively. Supported compression formats: gzip (.gz), compress
(.Z), zip, 7z, bzip2 (requires suffix .bz, .bz2, .bzip2, .tbz,
.tbz2, .tb2, .tz2), lzma and xz (requires suffix .lzma, .tlz, .xz,
.txz), lz4 (requires suffix .lz4), zstd (requires suffix .zst,
.zstd, .tzst), brotli (requires suffix .br).
--zmax=NUM
When used with option -z (--decompress), searches the contents of
compressed files and archives stored within archives by up to NUM
expansion stages. The default --zmax=1 only permits searching
uncompressed files stored in cpio, pax, tar, zip and 7z archives;
compressed files and archives are detected as binary files and are
effectively ignored. Specify --zmax=2 to search compressed files
and archives stored in cpio, pax, tar, zip and 7z archives. NUM
may range from 1 to 99 for up to 99 decompression and de-archiving
steps. Increasing NUM values gradually degrades performance.
-0, --null
Output a zero-byte (NUL) after the file name. This option can be
used with commands such as `find -print0' and `xargs -0' to
process arbitrary file names.
EXIT STATUS
The ugrep utility exits with one of the following values:
0 One or more lines were selected.
1 No lines were selected.
>1 An error occurred.
If -q or --quiet or --silent is used and a line is selected, the exit
status is 0 even if an error occurred.
CONFIGURATION
The ug command is intended for context-dependent interactive searching
and is equivalent to the ugrep --config --pretty --sort command to load
the default configuration file `.ugrep' when present in the working
directory or in the home directory.
A configuration file contains `NAME=VALUE' pairs per line, where `NAME`
is the name of a long option (without `--') and `=VALUE' is an argument,
which is optional and may be omitted depending on the option. Empty
lines and lines starting with a `#' are ignored.
The --config=FILE option and its abbreviated form ---FILE load the
specified configuration file located in the working directory or, when
not found, located in the home directory. An error is produced when FILE
is not found or cannot be read.
Command line options are parsed in the following order: the configuration
file is loaded first, followed by the remaining options and arguments on
the command line.
The --save-config option saves a `.ugrep' configuration file to the
working directory with a subset of the options specified on the command
line. The --save-config=FILE option saves the configuration to FILE.
The configuration is written to standard output when FILE is a `-'.
GLOBBING
Globbing is used by options -g, --include, --include-dir, --include-from,
--exclude, --exclude-dir, --exclude-from and --ignore-files to match
pathnames and basenames in recursive searches. Glob arguments for these
options should be quoted to prevent shell globbing.
Globbing supports gitignore syntax and the corresponding matching rules,
except that a glob normally matches files but not directories. If a glob
ends in a path separator `/', then it matches directories but not files,
as if --include-dir or --exclude-dir is specified. When a glob contains
a path separator `/', the full pathname is matched. Otherwise the
basename of a file or directory is matched. For example, *.h matches
foo.h and bar/foo.h. bar/*.h matches bar/foo.h but not foo.h and not
bar/bar/foo.h. Use a leading `/' to force /*.h to match foo.h but not
bar/foo.h.
When a glob starts with a `^' or a `!' as in -g^GLOB, the match is
negated. Likewise, a `!' (but not a `^') may be used with globs in the
files specified --include-from, --exclude-from, and --ignore-files to
negate the glob match. Empty lines or lines starting with a `#' are
ignored.
Glob Syntax and Conventions
* Matches anything except /.
? Matches any one character except /.
[abc-e]
Matches one character a,b,c,d,e.
[^abc-e]
Matches one character not a,b,c,d,e,/.
[!abc-e]
Matches one character not a,b,c,d,e,/.
/ When used at the start of a glob, matches if pathname has no /.
When used at the end of a glob, matches directories only.
**/ Matches zero or more directories.
/** When used at the end of a glob, matches everything after the /.
? Matches a ? or any other character specified after the backslash.
Glob Matching Examples
* Matches a, b, x/a, x/y/b
a Matches a, x/a, x/y/a, but not b, x/b, a/a/b
/* Matches a, b, but not x/a, x/b, x/y/a
/a Matches a, but not x/a, x/y/a
a?b Matches axb, ayb, but not a, b, ab, a/b
a[xy]b Matches axb, ayb but not a, b, azb
a[a-z]b
Matches aab, abb, acb, azb, but not a, b, a3b, aAb, aZb
a[^xy]b
Matches aab, abb, acb, azb, but not a, b, axb, ayb
a[^a-z]b
Matches a3b, aAb, aZb but not a, b, aab, abb, acb, azb
a/*/b Matches a/x/b, a/y/b, but not a/b, a/x/y/b
**/a Matches a, x/a, x/y/a, but not b, x/b.
a/**/b Matches a/b, a/x/b, a/x/y/b, but not x/a/b, a/b/x
a/** Matches a/x, a/y, a/x/y, but not a, b/x
a?b Matches a?b, but not a, b, ab, axb, a/b
Note that exclude glob patterns take priority over include glob patterns
when specified with options -g, --exclude, --exclude-dir, --include and
include-dir.
Glob patterns specified with prefix `!' in any of the files associated
with --include-from, --exclude-from and --ignore-files will negate a
previous glob match. That is, any matching file or directory excluded by
a previous glob pattern specified in the files associated with --exclude-
from or --ignore-file will become included again. Likewise, any matching
file or directory included by a previous glob pattern specified in the
files associated with --include-from will become excluded again.
ENVIRONMENT
GREP_PATH
May be used to specify a file path to pattern files. The file
path is used by option -f to open a pattern file, when the pattern
file does not exist.
GREP_COLOR
May be used to specify ANSI SGR parameters to highlight matches
when option --color is used, e.g. 1;35;40 shows pattern matches in
bold magenta text on a black background. Deprecated in favor of
GREP_COLORS, but still supported.
GREP_COLORS
May be used to specify ANSI SGR parameters to highlight matches
and other attributes when option --color is used. Its value is a
colon-separated list of ANSI SGR parameters that defaults to
cx=33:mt=1;31:fn=1;35:ln=1;32:cn=1;32:bn=1;32:se=36 with
additional parameters for TUI colors
:qp=1;32:qe=1;37;41:qm=1;32:ql=36:qb=1;35. The mt=, ms=, and mc=
capabilities of GREP_COLORS take priority over GREP_COLOR. Option
--colors takes priority over GREP_COLORS.
GREP_COLORS
Colors are specified as string of colon-separated ANSI SGR parameters of
the form `what=substring', where `substring' is a semicolon-separated
list of ANSI SGR codes or `k' (black), `r' (red), `g' (green), `y'
(yellow), `b' (blue), `m' (magenta), `c' (cyan), `w' (white). Upper case
specifies background colors. A `+' qualifies a color as bright. A
foreground and a background color may be combined with one or more font
properties `n' (normal), `f' (faint), `h' (highlight), `i' (invert), `u'
(underline). Substrings may be specified for:
sl= selected lines.
cx= context lines.
rv swaps the sl= and cx= capabilities when -v is specified.
mt= matching text in any matching line.
ms= matching text in a selected line. The substring mt= by default.
mc= matching text in a context line. The substring mt= by default.
fn= filenames.
ln= line numbers.
cn= column numbers.
bn= byte offsets.
se= separators.
rv a Boolean parameter, switches sl= and cx= with option -v.
hl a Boolean parameter, enables filename hyperlinks (33]8;;link).
ne a Boolean parameter, disables ``erase in line'' 33[K.
qp= TUI prompt.
qe= TUI errors.
qr= TUI regex.
qm= TUI regex meta characters.
ql= TUI regex lists and literals.
qb= TUI regex braces.
FORMAT
Option --format=FORMAT specifies an output format for file matches.
Fields may be used in FORMAT, which expand into the following values:
%[TEXT]F
if option -H is used: TEXT, the file pathname and separator.
%f the file pathname.
%a the file basename without directory path.
%p the directory path to the file.
%z the file pathname in a (compressed) archive.
%[TEXT]H
if option -H is used: TEXT, the quoted pathname and separator, "
and \ replace " and .
%h the quoted file pathname, " and \ replace " and .
%[TEXT]I
if option -H is used: TEXT, the pathname as XML character data and
separator.
%i the file pathname as XML character data.
%[TEXT]N
if option -n is used: TEXT, the line number and separator.
%n the line number of the match.
%[TEXT]K
if option -k is used: TEXT, the column number and separator.
%k the column number of the match.
%[TEXT]B
if option -b is used: TEXT, the byte offset and separator.
%b the byte offset of the match.
%[TEXT]T
if option -T is used: TEXT and a tab character.
%t a tab character.
%[SEP]$
set field separator to SEP for the rest of the format fields.
%[TEXT]<
if the first match: TEXT.
%[TEXT]>
if not the first match: TEXT.
%, if not the first match: a comma, same as %[,]>.
%: if not the first match: a colon, same as %[:]>.
%; if not the first match: a semicolon, same as %[;]>.
%| if not the first match: a vertical bar, same as %[|]>.
%[TEXT]S
if not the first match: TEXT and separator, see also %[SEP]$.
%s the separator, see also %[TEXT]S and %[SEP]$.
%~ a newline character.
%M the number of matching lines
%m the number of matches
%O the matching line is output as a raw string of bytes.
%o the match is output as a raw string of bytes.
%Q the matching line as a quoted string, " and \ replace " and .
%q the match as a quoted string, " and \ replace " and .
%C the matching line formatted as a quoted C/C++ string.
%c the match formatted as a quoted C/C++ string.
%J the matching line formatted as a quoted JSON string.
%j the match formatted as a quoted JSON string.
%V the matching line formatted as a quoted CSV string.
%v the match formatted as a quoted CSV string.
%X the matching line formatted as XML character data.
%x the match formatted as XML character data.
%w the width of the match, counting wide characters.
%d the size of the match, counting bytes.
%e the ending byte offset of the match.
%Z the edit distance cost of an approximate match with option -Z
%u select unique lines only, unless option -u is used.
%1 the first regex group capture of the match, and so on up to group
%9, same as %[1]#; requires option -P.
%[NUM]#
the regex group capture NUM; requires option -P.
%[NUM]b
the byte offset of the group capture NUM; requires option -P. Use
e for the ending byte offset and d for the byte length.
%[NUM1|NUM2|...]#
the first group capture NUM that matched; requires option -P.
%[NUM1|NUM2|...]b
the byte offset of the first group capture NUM that matched;
requires option -P. Use e for the ending byte offset and d for
the byte length.
%[NAME]#
the NAMEd group capture; requires option -P and capturing pattern
`(?<NAME>PATTERN)', see also %G.
%[NAME]b
the byte offset of the NAMEd group capture; requires option -P and
capturing pattern `(?<NAME>PATTERN)'. Use e for the ending byte
offset and d for the byte length.
%[NAME1|NAME2|...]#
the first NAMEd group capture that matched; requires option -P and
capturing pattern `(?<NAME>PATTERN)', see also %G.
%[NAME1|NAME2|...]b
the byte offset of the first NAMEd group capture that matched;
requires option -P and capturing pattern `(?<NAME>PATTERN)'. Use
e for the ending byte offset and d for the byte length.
%G list of group capture indices/names that matched; requires option
-P.
%[TEXT1|TEXT2|...]G
list of TEXT indexed by group capture indices that matched;
requires option -P.
%g the group capture index/name matched or 1; requires option -P.
%[TEXT1|TEXT2|...]g
the first TEXT indexed by the first group capture index that
matched; requires option -P.
%% the percentage sign.
Formatted output is written without a terminating newline, unless %~ or
`n' is explicitly specified in the format string.
The [TEXT] part of a field is optional and may be omitted. When present,
the argument must be placed in [] brackets, for example %[,]F to output a
comma, the pathname, and a separator.
%[SEP]$ and %u are switches and do not send anything to the output.
The separator used by the %F, %H, %I, %N, %K, %B, %S and %G fields may be
changed by preceding the field by %[SEP]$. When [SEP] is not provided,
this reverts the separator to the default separator or the separator
specified with --separator.
Formatted output is written for each matching pattern, which means that a
line may be output multiple times when patterns match more than once on
the same line. If field %u is specified anywhere in a format string,
matching lines are output only once, unless option -u, --ungroup is
specified or when more than one line of input matched the search pattern.
Additional formatting options:
--format-begin=FORMAT
the FORMAT when beginning the search.
--format-open=FORMAT
the FORMAT when opening a file and a match was found.
--format-close=FORMAT
the FORMAT when closing a file and a match was found.
--format-end=FORMAT
the FORMAT when ending the search.
The context options -A, -B, -C, -y, and display options --break,
--heading, --color, -T, and --null have no effect on formatted output.
EXAMPLES
Display lines containing the word `patricia' in `myfile.txt':
$ ugrep -w patricia myfile.txt
Display lines containing the word `patricia', ignoring case:
$ ugrep -wi patricia myfile.txt
Display lines approximately matching the word `patricia', ignoring case
and allowing up to 2 spelling errors using fuzzy search:
$ ugrep -Z2 -wi patricia myfile.txt
Count the number of lines containing `patricia', ignoring case:
$ ugrep -cwi patricia myfile.txt
Count the number of words `patricia', ignoring case:
$ ugrep -cowi patricia myfile.txt
List lines with `amount' and a decimal, ignoring case (space is AND):
$ ugrep -i -% 'amount +(.+)?' myfile.txt
Alternative query:
$ ugrep -wi -e amount --and '+(.+)?' myfile.txt
List all Unicode words in a file:
$ ugrep -o 'w+' myfile.txt
List the laughing face emojis (Unicode code points U+1F600 to U+1F60F):
$ ugrep -o '[x{1F600}-x{1F60F}]' myfile.txt
Check if a file contains any non-ASCII (i.e. Unicode) characters:
$ ugrep -q '[^[:ascii:]]' myfile.txt && echo "contains Unicode"
Display the line and column number of `FIXME' in C++ files using
recursive search, with one line of context before and after a matched
line:
$ ugrep -C1 -R -n -k -tc++ FIXME
Display the line and column number of `FIXME' in long Javascript files
using recursive search, showing only matches with up to 10 characters of
context before and after:
$ ugrep -o -C20 -R -n -k -tjs FIXME
Find blocks of text between lines matching BEGIN and END by using a lazy
quantifier `*?' to match only what is necessary and pattern `n' to match
newlines:
$ ugrep -n 'BEGIN.*n(.*n)*?.*END' myfile.txt
Likewise, list the C/C++ comments in a file and line numbers:
$ ugrep -n -e '//.*' -e '/*(.*n)*?.**+/' myfile.cpp
The same, but using predefined pattern c++/comments:
$ ugrep -n -f c++/comments myfile.cpp
List the lines that need fixing in a C/C++ source file by looking for the
word `FIXME' while skipping any `FIXME' in quoted strings:
$ ugrep -e FIXME -N '"(\.|\r?n|[^\n"])*"' myfile.cpp
The same, but using predefined pattern cpp/zap_strings:
$ ugrep -e FIXME -f cpp/zap_strings myfile.cpp
Find lines with `FIXME' or `TODO', showing line numbers:
$ ugrep -n -e FIXME -e TODO myfile.cpp
Find lines with `FIXME' that also contain `urgent':
$ ugrep -n -e FIXME --and urgent myfile.cpp
The same, but with a Boolean query pattern (a space is AND):
$ ugrep -n -% 'FIXME urgent' myfile.cpp
Find lines with `FIXME' that do not also contain `later':
$ ugrep -n -e FIXME --andnot later myfile.cpp
The same, but with a Boolean query pattern (a space is AND, - is NOT):
$ ugrep -n -% 'FIXME -later' myfile.cpp
Output a list of line numbers of lines with `FIXME' but not `later':
$ ugrep -e FIXME --andnot later --format='%,%n' myfile.cpp
Recursively list all files with both `FIXME' and `LICENSE' anywhere in
the file, not necessarily on the same line:
$ ugrep -l -%% 'FIXME LICENSE'
Find lines with `FIXME' in the C/C++ files stored in a tarball:
$ ugrep -z -tc++ -n FIXME project.tgz
Recursively find lines with `FIXME' in C/C++ files, but do not search any
`bak' and `old' directories:
$ ugrep -n FIXME -tc++ -g^bak/,^old/
Recursively search for the word `copyright' in cpio, jar, pax, tar, zip,
7z archives, compressed and regular files, and in PDFs using a PDF
filter:
$ ugrep -z -w --filter='pdf:pdftotext % -' copyright
Match the binary pattern `A3hhhhA3' (hex) in a binary file without
Unicode pattern matching -U (which would otherwise match `xaf' as a
Unicode character U+00A3 with UTF-8 byte sequence C2 A3) and display the
results in hex with --hexdump with C1 to output one hex line before and
after each match:
$ ugrep -U --hexdump=C1 'xa3[x00-xff]{2}xa3' a.out
Hexdump an entire file using a pager for viewing:
$ ugrep -X --pager '' a.out
List all files that are not ignored by one or more `.gitignore':
$ ugrep -l '' --ignore-files
List all files containing a RPM signature, located in the `rpm' directory
and recursively below up to two levels deeper (3 levels total):
$ ugrep -3 -l -tRpm '' rpm/
Monitor the system log for bug reports and ungroup multiple matches on a
line:
$ tail -f /var/log/system.log | ugrep -u -i -w bug
Interactive fuzzy search with Boolean search queries:
$ ugrep -Q -l -% -Z3 --sort=best
Display all words in a MacRoman-encoded file that has CR newlines:
$ ugrep --encoding=MACROMAN 'w+' mac.txt
Display options related to "fuzzy" searching:
$ ugrep --help fuzzy
COPYRIGHT
Copyright (c) 2021,2024 Robert A. van Engelen <[email protected]>
ugrep is released under the BSD-3 license. All parts of the software
have reasonable copyright terms permitting free redistribution. This
includes the ability to reuse all or parts of the ugrep source tree.
SEE ALSO
ugrep-indexer(1), grep(1), zgrep(1).
BUGS
Report bugs at: <https://github.com/Genivia/ugrep/issues>
ugrep 7.1.1 November 29, 2024 UGREP(1)
? Back to table of contents
For PCRE regex patterns with option -P , please see the PCRE documentation https://www.pcre.org/original/doc/html/pcrepattern.html. The pattern syntax has more features than the pattern syntax described below. For the patterns in common the syntax and meaning are the same.
Note that [[:space:]] and s and inverted bracket lists [^...] are modified in ugrep to prevent matching newlines n . This modification is done to replicate the behavior of grep.
An empty pattern is a special case that matches everything except empty files, ie does not match zero-length files, as per POSIX.1 grep standard.
A regex pattern is an extended set of regular expressions (ERE), with nested sub-expression patterns φ and ψ :
| Muster | Matches |
|---|---|
x | matches the character x , where x is not a special character |
. | matches any single character except newline (unless in dotall mode) |
. | matches . (dot), special characters are escaped with a backslash |
n | matches a newline, others are a (BEL), b (BS), t (HT), v (VT), f (FF), and r (CR) |
| matches the NUL character |
cX | matches the control character X mod 32 (eg cA is x01 ) |
141 | matches an 8-bit character with octal value 141 , ie a |
x7f | matches an 8-bit character with hexadecimal value 7f |
x{3B1} | matches Unicode character U+03B1, ie α |
u{3B1} | matches Unicode character U+03B1, ie α |
o{141} | matches Unicode character U+0061, ie a , in octal |
p{C} | matches a character in Unicode category C |
Q...E | matches the quoted content between Q and E literally |
[abc] | matches one of a , b , or c |
[0-9] | matches a digit 0 to 9 |
[^0-9] | matches any character except a digit and excluding n |
φ? | matches φ zero or one time (optional) |
φ* | matches φ zero or more times (repetition) |
φ+ | matches φ one or more times (repetition) |
φ{2,5} | matches φ two to five times (repetition) |
φ{2,} | matches φ at least two times (repetition) |
φ{2} | matches φ exactly two times (repetition) |
φ?? | matches φ zero or once as needed (lazy optional) |
φ*? | matches φ a minimum number of times as needed (lazy repetition) |
φ+? | matches φ a minimum number of times at least once as needed (lazy repetition) |
φ{2,5}? | matches φ two to five times as needed (lazy repetition) |
φ{2,}? | matches φ at least two times or more as needed (lazy repetition) |
φψ | matches φ then matches ψ (concatenation) |
φ⎮ψ | matches φ or matches ψ (alternation) |
(φ) | matches φ as a group |
(?:φ) | matches φ as a group without capture |
(?=φ) | matches φ without consuming it, ie lookahead (without option -P : nothing may occur after (?=φ) ) |
(?^φ) | matches φ and ignores it, marking everything in the pattern as a non-match |
^φ | matches φ at the start of input or start of a line (nothing may occur before ^ ) |
φ$ | matches φ at the end of input or end of a line (nothing may occur after $ ) |
Aφ | matches φ at the start of input (nothing may occur before A ) |
φz | matches φ at the end of input (nothing may occur after z ) |
bφ | matches φ starting at a word boundary (without option -P : nothing may occur before b ) |
φb | matches φ ending at a word boundary (without option -P : nothing may occur after b ) |
Bφ | matches φ starting at a non-word boundary (without option -P : nothing may occur before B ) |
φB | matches φ ending at a non-word boundary (without option -P : nothing may occur after B ) |
<φ | matches φ that starts a word (without option -P : nothing may occur before < ) |
>φ | matches φ that starts a non-word (without option -P : nothing may occur before > ) |
φ< | matches φ that ends a non-word (without option -P : nothing may occur after < ) |
φ> | matches φ that ends a word (without option -P : nothing may occur after > ) |
(?i:φ) | matches φ ignoring case |
(?s:φ) | . (dot) in φ matches newline |
(?x:φ) | ignore all whitespace and comments in φ |
(?#:X) | all of X is skipped as a comment |
The order of precedence for composing larger patterns from sub-patterns is as follows, from high to low precedence:
(φ) , (?:φ) , (?=φ) , and inline modifiers (?imsux:φ)? , * , + , {n,m}φψ^ , $ , < , > , b , B , A , zφ|ψ(?imsux)φ? Back to table of contents
Character classes in bracket lists represent sets of characters. Sets can be negated (inverted), subtracted, intersected, and merged (not supported by PCRE2 with option -P ):
| Muster | Matches |
|---|---|
[a-zA-Z] | matches a letter |
[^a-zA-Z] | matches a non-letter (character class negation), newlines are not matched |
[az−−[aeiou]] | matches a consonant (character class subtraction) |
[az&&[^aeiou]] | matches a consonant (character class intersection) |
[az⎮⎮[AZ]] | matches a letter (character class union) |
Bracket lists cannot be empty, so [] and [^] are invalid. In fact, the first character after the bracket is always part of the list. So [][] is a list that matches a ] and a [ , [^][] is a list that matches anything but ] and [ , and [-^] is a list that matches a - and a ^ .
Negated character classes such as [^az] do not match newlines for compatibility with traditional grep pattern matching.
? Back to table of contents
The POSIX form can only be used in bracket lists, for example [[:lower:][:digit:]] matches an ASCII lower case letter or a digit.
You can also use the p{C} form for class C and upper case P{C} form that has the same meaning as p{^C} , which matches any character except characters in the class C . For example, P{ASCII} is the same as p{^ASCII} which is the same as [[:^ascii]] .
| POSIX form | Matches |
|---|---|
[:ascii:] | matches an ASCII character U+0000 to U+007F including n |
[:space:] | matches a white space character [ tvfr] excluding n |
[:xdigit:] | matches a hex digit [0-9A-Fa-f] |
[:cntrl:] | matches a control character [x00-tx0b-x1fx7f] excluding n |
[:print:] | matches a printable character [x20-x7e] |
[:alnum:] | matches a alphanumeric character [0-9A-Za-z] |
[:alpha:] | matches a letter [A-Za-z] |
[:blank:] | matches a blank character h same as [ t] |
[:digit:] | matches a digit [0-9] |
[:graph:] | matches a visible character [x21-x7e] |
[:lower:] | matches a lower case letter [az] |
[:punct:] | matches a punctuation character [x21-x2fx3a-x40x5b-x60x7b-x7e] |
[:upper:] | matches an upper case letter [AZ] |
[:word:] | matches a word character [0-9A-Za-z_] |
[:^blank:] | matches a non-blank characater H same as [^ t] |
[:^digit:] | matches a non-digit [^0-9] |
POSIX character categories only cover ASCII, [[:^ascii]] is empty and therefore invalid to use. By contrast, [^[:ascii]] is a Unicode character class that excludes the ASCII character category.
Note that the patterns [[:ascii:]] and negated classes such as [[:^digit:]] match newlines, which is the official definition of these POSIX categories. By contrast, GNU/BSD grep never match newlines. As a consequence, more patterns may match.
Negated character classes of the form [^...] match any Unicode character except the given characters and does not match newlines either. For example [^[:digit:]] matches non-digits (including Unicode) and does not match newlines. By contrast, [[:^digit:]] matches ASCII non-digits, including newlines.
Option -U disables Unicode wide-character matching, ie ASCII matching.
| Unicode category | Matches |
|---|---|
. | matches any single Unicode character except newline n unless with --dotall |
a | matches BEL U+0007 |
d | matches a digit [0-9] or p{Nd} |
D | matches a non-digit including n |
e | matches ESC U+001b |
f | matches FF U+000c |
h | matches a blank [ t] |
H | matches a non-blank [^ t] including n |
l | matches a lower case letter p{Ll} |
n | matches LF U+000a |
N | matches a non-LF character |
r | matches CR U+000d |
R | matches a Unicode line break ( rn , r , v , f , n , U+0085, U+2028 and U+2029) |
s | matches a white space character [ tvfrx85p{Z}] excluding n |
S | matches a non-white space character and excluding n |
t | matches TAB U+0009 |
u | matches an upper case letter p{Lu} |
v | matches VT U+000b or vertical space character with option -P |
w | matches a word character [0-9A-Za-z_] or [p{L}p{Nd}p{Pc}] |
W | matches a non-Unicode word character including n |
X | matches any ISO-8859-1 or Unicode character including n |
p{Space} | matches a white space character [ tvfrx85p{Z}] excluding n |
p{Unicode} | matches any Unicode character U+0000 to U+10FFFF minus U+D800 to U+DFFF |
p{ASCII} | matches an ASCII character U+0000 to U+007F including n |
p{Non_ASCII_Unicode} | matches a non-ASCII character U+0080 to U+10FFFF minus U+D800 to U+DFFF |
p{L&} | matches a character with Unicode property L& (ie property Ll, Lu, or Lt) |
p{Letter} , p{L} | matches a character with Unicode property Letter |
p{Mark} , p{M} | matches a character with Unicode property Mark |
p{Separator} , p{Z} | matches a character with Unicode property Separator |
p{Symbol} , p{S} | matches a character with Unicode property Symbol |
p{Number} , p{N} | matches a character with Unicode property Number |
p{Punctuation} , p{P} | matches a character with Unicode property Punctuation |
p{Other} , p{C} | matches a character with Unicode property Other |
p{Lowercase_Letter} , p{Ll} | matches a character with Unicode sub-property Ll |
p{Uppercase_Letter} , p{Lu} | matches a character with Unicode sub-property Lu |
p{Titlecase_Letter} , p{Lt} | matches a character with Unicode sub-property Lt |
p{Modifier_Letter} , p{Lm} | matches a character with Unicode sub-property Lm |
p{Other_Letter} , p{Lo} | matches a character with Unicode sub-property Lo |
p{Non_Spacing_Mark} , p{Mn} | matches a character with Unicode sub-property Mn |
p{Spacing_Combining_Mark} , p{Mc} | matches a character with Unicode sub-property Mc |
p{Enclosing_Mark} , p{Me} | matches a character with Unicode sub-property Me |
p{Space_Separator} , p{Zs} | matches a character with Unicode sub-property Zs |
p{Line_Separator} , p{Zl} | matches a character with Unicode sub-property Zl |
p{Paragraph_Separator} , p{Zp} | matches a character with Unicode sub-property Zp |
p{Math_Symbol} , p{Sm} | matches a character with Unicode sub-property Sm |
p{Currency_Symbol} , p{Sc} | matches a character with Unicode sub-property Sc |
p{Modifier_Symbol} , p{Sk} | matches a character with Unicode sub-property Sk |
p{Other_Symbol} , p{So} | matches a character with Unicode sub-property So |
p{Decimal_Digit_Number} , p{Nd} | matches a character with Unicode sub-property Nd |
p{Letter_Number} , p{Nl} | matches a character with Unicode sub-property Nl |
p{Other_Number} , p{No} | matches a character with Unicode sub-property No |
p{Dash_Punctuation} , p{Pd} | matches a character with Unicode sub-property Pd |
p{Open_Punctuation} , p{Ps} | matches a character with Unicode sub-property Ps |
p{Close_Punctuation} , p{Pe} | matches a character with Unicode sub-property Pe |
p{Initial_Punctuation} , p{Pi} | matches a character with Unicode sub-property Pi |
p{Final_Punctuation} , p{Pf} | matches a character with Unicode sub-property Pf |
p{Connector_Punctuation} , p{Pc} | matches a character with Unicode sub-property Pc |
p{Other_Punctuation} , p{Po} | matches a character with Unicode sub-property Po |
p{Control} , p{Cc} | matches a character with Unicode sub-property Cc |
p{Format} , p{Cf} | matches a character with Unicode sub-property Cf |
p{UnicodeIdentifierStart} | matches a character in the Unicode IdentifierStart class |
p{UnicodeIdentifierPart} | matches a character in the Unicode IdentifierPart class |
p{IdentifierIgnorable} | matches a character in the IdentifierIgnorable class |
p{JavaIdentifierStart} | matches a character in the Java IdentifierStart class |
p{JavaIdentifierPart} | matches a character in the Java IdentifierPart class |
p{CsIdentifierStart} | matches a character in the C# IdentifierStart class |
p{CsIdentifierPart} | matches a character in the C# IdentifierPart class |
p{PythonIdentifierStart} | matches a character in the Python IdentifierStart class |
p{PythonIdentifierPart} | matches a character in the Python IdentifierPart class |
To specify a Unicode block as a category use p{IsBlockName} with a Unicode BlockName .
To specify a Unicode language script, use p{Language} with a Unicode Language .
Unicode language script character classes differ from the Unicode blocks that have a similar name. For example, the p{Greek} class represents Greek and Coptic letters and differs from the Unicode block p{IsGreek} that spans a specific Unicode block of Greek and Coptic characters only, which also includes unassigned characters.
? Back to table of contents
For the pattern syntax of ugrep option -P (Perl regular expressions), see for example Perl regular expression syntax. However, ugrep enhances the Perl regular expression syntax with all of the features listed in POSIX regular expression syntax.
? Back to table of contents
If something is not working, then please check the tutorial and the man page. If you can't find it there and it looks like a bug, then report an issue on GitHub. Bug reports are quickly addressed.
Copyright (c) Robert van Engelen, 2024
