ugrep
v7.1.1
[ ЧИТАЙТЕ | Руководство пользователя | Индексирование | Тесты | Вопросы и ответы ]
опция -Q открывает запрос TUI для поиска файлов по мере ввода!
Ugrep быстрый, удобный и оснащен множеством новых функций, которые нужны пользователям.
включает в себя интерактивный TUI со встроенной справкой, поиск в стиле Google с шаблонами И/ИЛИ/НЕ, нечеткий поиск, поиск (вложенных) архивов zip/7z/tar/pax/cpio, архивов и сжатых файлов gz/Z/bz/ bz2/lzma/xz/lz4/zstd/brotli, поиск двоичных файлов и шестнадцатеричный дамп, поиск документов, таких как PDF, doc, docx, и вывод в формате JSON, XML, CSV или ваш собственный формат.
Расширенный синтаксис шаблона регулярных выражений Unicode с многострочным сопоставлением шаблонов без необходимости использования специальных параметров командной строки.
включает индексатор файлов для ускорения поиска в медленных и холодных файловых системах
настоящая замена GNU grep (при условии, что вы копируете или символизируете ссылку ug на grep , egrep и fgrep ), в отличие от других популярных grep, претендующих на звание «альтернативы grep» или «замен», когда они на самом деле реализуют несовместимую командную строку параметры и использовать несовместимое средство сопоставления регулярных выражений, т. е. только регулярное выражение Perl вместо POSIX BRE (grep) и ERE (egrep), когда ugrep поддерживает все режимы регулярных выражений
тесты показывают, что ugrep является (одним из) самых быстрых grep, использующих высокопроизводительный механизм сопоставления регулярных выражений на основе DFA RE/flex.
если что-то надо улучшить или добавить в ugrep, то дайте знать!
Приоритетом №1 является обеспечение качества, чтобы гарантировать отсутствие ошибок и надежность Ugrep.
заставить ugrep работать еще быстрее, см., например, #432, #421
делиться воспроизводимыми результатами производительности
ug предназначен для интерактивного использования, при котором загружается дополнительный файл конфигурации .ugrep с вашими предпочтениями, расположенный в рабочем или домашнем каталоге. ug+ также ищет PDF-файлы, документы, электронные книги, метаданные изображений.
ugrep для пакетного использования, как GNU grep, без файла конфигурации .ugrep, ugrep+ также ищет PDF-файлы, документы, электронные книги, метаданные изображений.
По умолчанию соответствует шаблонам Unicode и автоматически ищет файлы в кодировке UTF-8, UTF-16 и UTF-32.
Соответствует нескольким строкам с n или R в шаблонах регулярных выражений, для этого не требуются специальные параметры!
Встроенная справка: ug --help , где ug --help WHAT отображает параметры, связанные с WHAT вы ищете.
ug --help regex , ug --help globs , ug --help fuzzy , ug --help format .
Удобство для пользователя благодаря настраиваемым файлам конфигурации, используемым командой ug предназначенным для интерактивного использования и загружающим файл конфигурации .ugrep с вашими предпочтениями.
ug PATTERN ... ugrep --config PATTERN ...
ug --save-config ...options-you-want-to-save... сохраняет файл конфигурации .ugrep в рабочем каталоге, чтобы при следующем запуске ug там использовались эти параметры. Сделайте это в своем домашнем каталоге, чтобы сохранить файл конфигурации .ugrep с параметрами, которые вы обычно хотите использовать.
Интерактивный интерфейс запроса, нажмите F1 или CTRL-Z для получения справки и TAB/SHIFT-TAB для перехода к каталогам и файлам.
ug -Q ug -Q -e PATTERN
-Q заменяет PATTERN в командной строке, позволяя вам вводить шаблоны в интерактивном режиме в TUI. В TUI используйте клавиши ALT+буквы для включения/выключения коротких «буквенных опций», например ALT-n (опция -n ), чтобы показать/скрыть номера строк.
Поиск по содержимому архивов (zip, tar, pax, jar, cpio, 7z) и сжатых файлов (gz, Z, bz, bz2, lzma, xz, lz4, zstd, brotli)
ug -z PATTERN ... ug -z --zmax=2 PATTERN ...
укажите -z --zmax=2 для поиска сжатых файлов и архивов, вложенных в архивы. Аргумент --zmax может иметь значение от 1 (по умолчанию) до 99, что дает до 99 шагов распаковки и разархивирования для поиска во вложенных архивах.
Поиск с помощью шаблонов логических запросов, подобных Google, с использованием шаблонов -% с AND (или просто пробелом), OR (или чертой | ), NOT (или тире - ), использованием кавычек для точного соответствия и группировкой с помощью ( ) (показано на левая сторона внизу); или с опциями -e (как «или»), --and , --andnot и --not шаблоны регулярных выражений (показаны справа ниже):
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' ...
где A , B и C — произвольные шаблоны регулярных выражений (используйте опцию -F для поиска строк)
укажите опцию -%% ( --bool --files ), чтобы применить логический запрос к файлам в целом: файл соответствует, если все логические условия удовлетворяются путем сопоставления шаблонов во всем файле. В противном случае логические условия по умолчанию применяются к одиночным строкам, поскольку утилиты grep обычно сопоставляют шаблоны на основе строк. Опция --stats отображает запрос в удобочитаемой форме после завершения поиска.
Выполняйте поиск в PDF-, doc-, docx-, электронных книгах и других документах с помощью ug+ используя фильтры, связанные с расширениями имен файлов:
ug+ PATTERN ...
или укажите --filter с типом файла, чтобы использовать утилиту фильтра:
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 ...
команда ug+ аналогична команде ug , но также использует фильтры для поиска PDF-файлов, документов и метаданных изображений.
Отобразите горизонтальный контекст с помощью опции -o ( --only-matching ) и опций контекста -ABC , например, для поиска совпадений в очень длинных строках, таких как источники Javascript и JSON:
ug -o -C20 -nk PATTERN longlines.js
-o -C20 подбирает все совпадения с контекстом длиной 20 символов до и 20 символов после совпадения (т.е. всего 40 символов Юникода), -nk выводит номера строк и столбцов.
Найдите приблизительные совпадения с образцом с помощью нечеткого поиска в пределах указанного расстояния Левенштейна.
ug -Z PATTERN ... ug -Z3 PATTTERN ...
-Zn соответствует до n дополнительных, отсутствующих или замененных символов, -Z+n соответствует до n дополнительных символов, -Zn соответствует до n пропущенных символов и -Z~n соответствует до n замененных символов. -Z по умолчанию равен -Z1 .
Fzf-подобный поиск с регулярным выражением (или фиксированными строками с -F ), нечеткое сопоставление до 4 дополнительных символов с -Z+4 и только слова с -w , использование -%% для логического поиска по всему файлу
ug -Q -%% -l -w -Z+4 --sort=best
-l выводит список совпадающих файлов в TUI, нажмите TAB затем ALT-y , чтобы просмотреть файл, SHIFT-TAB и Alt-l , чтобы вернуться назад, чтобы просмотреть список совпадающих файлов, упорядоченный по наилучшему совпадению.
Поиск двоичных файлов и отображение шестнадцатеричных дампов с совпадениями с двоичным шаблоном (текст Unicode или -U для байтовых шаблонов)
ug --hexdump -U BYTEPATTERN ... ug --hexdump TEXTPATTERN ...
ug -X -U BYTEPATTERN ... ug -X TEXTPATTERN ...
ug -W -U BYTEPATTERN ... ug -W TEXTPATTERN ...
--hexdump=4chC1 отображает 4 шестнадцатеричных столбца без символьного столбца c , без шестнадцатеричного интервала h и с одной дополнительной шестнадцатеричной строкой C1 до и после совпадения.
Включите файлы для поиска по типам файлов или «магическим байтам» файлов или исключите их с помощью ^
ug -t TYPE PATTERN ... ug -t ^TYPE PATTERN ...
ug -M 'MAGIC' PATTERN ... ug -M '^MAGIC' PATTERN ...
Включите для поиска файлы и каталоги, соответствующие glob в стиле gitignore, или исключите их с помощью ^
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 ...
Включите файлы для поиска по расширениям имен файлов (суффиксу) или исключите их с помощью ^ , сокращения для -g"*.EXT"
ug -O EXT PATTERN ... ug -O ^EXT PATTERN ...
Включить скрытые файлы (точечные файлы) и каталоги для поиска (по умолчанию опущено).
ug -. PATTERN ... ug -g'.*,.*/' PATTERN ...
укажите hidden в вашем .ugrep, чтобы всегда искать скрытые файлы с помощью ug .
Исключить файлы, указанные в .gitignore и т. д.
ug --ignore-files PATTERN ... ug --ignore-files=.ignore PATTERN ...
укажите ignore-files в вашем .ugrep, чтобы всегда игнорировать их с помощью ug . Добавьте дополнительные ignore-files=... по желанию.
Шаблоны поиска, исключая отрицательные шаблоны («соответствует этому, но не этому»)
ug -e PATTERN -N NOTPATTERN ... ug -e '[0-9]+' -N 123 ...
Используйте предопределенные шаблоны регулярных выражений для поиска исходного кода, JavaScript, XML, JSON, HTML, PHP, уценки и т. д.
ug PATTERN -f c++/zap_comments -f c++/zap_strings ...
ug PATTERN -f php/zap_html ...
ug -f js/functions ... | ug PATTERN ...
Сортировка совпадающих файлов по имени, наилучшему совпадению, размеру и времени.
ug --sort PATTERN ... ug --sort=size PATTERN ...
ug --sort=changed PATTERN ... ug --sort=created PATTERN ...
ug -Z --sort=best PATTERN ... ug --no-sort PATTERN ...
Вывод результатов в CSV, JSON, XML и пользовательских форматах.
ug --csv PATTERN ... ug --json PATTERN ...
ug --xml PATTERN ... ug --format='file=%f line=%n match=%O%~' PATTERN ...
ug --help format отображает справку по полям формата % для индивидуального вывода.
Выполняйте поиск с помощью Perl-совместимых шаблонов регулярных выражений PCRE и отображайте или заменяйте совпадения подшаблонов.
ug -P PATTERN ... ug -P --format='%1 and %2%~' 'PATTERN(SUB1)(SUB2)' ...
Замените шаблоны в выводе на -P и --replace заменяющий текст, возможно содержащий поля форматирования % , используя -y для передачи остальной части файла:
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 отображает справку по полям формата % , которые можно дополнительно использовать с --replace .
Поиск файлов с определенным форматом кодировки, например ISO-8859-1–16, CP 437, CP 850, MACROMAN, KOI8 и т. д.
ug --encoding=LATIN1 PATTERN ...
Установите последнюю версию Ugrep с помощью Homebrew:
$ brew install ugrep
или установите с помощью MacPorts:
$ sudo port install ugrep
При этом устанавливаются команды ugrep и ug , где ug — то же самое, что и ugrep но также загружается файл конфигурации .ugrep, если он присутствует в рабочем или домашнем каталоге.
Установить с помощью Winget winget install Genivia.ugrep
Или установите с помощью Chocolatey choco install ugrep
Или установите с помощью Scoop scoop install ugrep
Или загрузите полнофункциональный исполняемый файл ugrep.exe в качестве артефакта выпуска с https://github.com/Genivia/ugrep/releases. Заархивированный выпуск содержит основной двоичный файл ugrep.exe , а также ug.exe . Команда ug , предназначенная для интерактивного использования, загружает и считывает настройки из файла конфигурации .ugrep (если он присутствует в рабочем или домашнем каталоге).
Добавьте ugrep.exe и ug.exe в путь выполнения: перейдите в «Настройки» и найдите «Путь» в разделе «Найти настройку» . Выберите переменные среды -> Путь -> Создать и добавьте каталог, в который вы поместили исполняемые файлы ugrep.exe и ug.exe .
Кончик
Практические советы по использованию ugrep.exe и ug.exe в командной строке Windows:
' кавычки, а вместо них используйте " ; большинство командных утилит Windows считают ' кавычки частью аргумента командной строки!-g/GLOB вместо обычных аргументов командной строки GLOB для выбора файлов и каталогов для поиска, особенно для рекурсивного поиска;"" для соответствия всем входным данным это может игнорироваться некоторыми интерпретаторами команд Windows, такими как Powershell; в этом случае вместо этого необходимо указать параметр --match ;R вместо n для соответствия любым символам новой строки в Юникоде, например парам rn и одиночным r и n . $ apk add ugrep ugrep-doc
Проверьте https://pkgs.alpinelinux.org/packages?name=ugrep для получения информации о версии.
$ pacman -S ugrep
Проверьте https://archlinux.org/packages/extra/x86_64/ugrep для получения информации о версии.
Сначала включите репозиторий EPEL, затем можно будет установить Ugrep.
$ dnf install ugrep
Проверьте https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ для получения информации о версии.
$ apt-get install ugrep
Проверьте https://packages.debian.org/ugrep для получения информации о версии. Чтобы собрать и попробовать ugrep локально, см. этапы сборки «Все платформы» ниже.
$ dnf install ugrep
Проверьте https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ для получения информации о версии.
$ pkg install ugrep
Проверьте https://www.freshports.org/textproc/ugrep для получения информации о версии.
$ pkgman install cmd:ugrep
Проверьте https://github.com/haikuports/haikuports/tree/master/app-text/ugrep для получения информации о версии. Чтобы собрать и попробовать ugrep локально, см. этапы сборки «Все платформы» ниже.
Вы можете использовать стандартный установщик пакетов NetBSD (pkgsrc): http://cdn.netbsd.org/pub/pkgsrc/current/pkgsrc/textproc/ugrep/README.html.
$ pkg_add ugrep
Проверьте https://openports.pl/path/sysutils/ugrep для получения информации о версии.
$ zypper install ugrep
Проверьте https://build.opensuse.org/package/show/utilities/ugrep для получения информации о версии.
Сначала включите репозиторий EPEL, затем можно будет установить Ugrep.
$ dnf install ugrep
Проверьте https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ для получения информации о версии.
Клонировать ugrep с помощью
$ git clone https://github.com/Genivia/ugrep
Или посетите https://github.com/Genivia/ugrep/releases, чтобы загрузить конкретный выпуск.
Вы всегда можете добавить их позже, когда вам понадобятся эти функции:
Для опции -P (регулярные выражения Perl) требуется либо библиотека PCRE2 (рекомендуется), либо библиотека Boost.Regex (необязательный резерв). Если PCRE2 не установлен, установите PCRE2, например, с sudo apt-get install -y libpcre2-dev или загрузите PCRE2 и следуйте инструкциям по установке. Альтернативно загрузите Boost.Regex и запустите ./bootstrap.sh и sudo ./b2 --with-regex install . См. раздел Boost: начало работы.
Опция -z (поиск сжатых файлов и архивов) требует наличия установленной библиотеки zlib. Он установлен в большинстве систем. Если нет, установите его, например, с помощью sudo apt-get install -y libz-dev . Для поиска файлов .bz и .bz2 установите библиотеку bzip2 (рекомендуется), например, с помощью sudo apt-get install -y libbz2-dev . Для поиска файлов .lzma и .xz установите библиотеку lzma (рекомендуется), например, с помощью sudo apt-get install -y liblzma-dev . Для поиска файлов .lz4 установите библиотеку lz4 (необязательно, не обязательно), например, с помощью sudo apt-get install -y liblz4-dev . Для поиска файлов .zst установите библиотеку zstd (необязательно, не обязательно), например, с помощью sudo apt-get install -y libzstd-dev . Для поиска файлов .br установите библиотеку brotli (необязательно, не обязательно), например, с помощью sudo apt-get install -y libbrotli-dev . Для поиска файлов .bz3 установите библиотеку bzip3 (необязательно, не обязательно), например, с помощью sudo apt-get install -y bzip3 .
Кончик
Даже если в вашей системе есть утилиты командной строки, такие как bzip2 , это не обязательно означает, что установлены библиотеки разработки, такие как libbz2 . Должны быть установлены библиотеки разработки .
Некоторые системы Linux могут быть не настроены на загрузку динамических библиотек из /usr/local/lib , что приводит к ошибке загрузки библиотеки при запуске ugrep . Чтобы исправить это, добавьте export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/usr/local/lib" в ваш файл ~/.bashrc . Или запустите sudo ldconfig /usr/local/lib .
Выполните сценарий ./build.sh для сборки ugrep :
$ cd ugrep
$ ./build.sh
При этом исполняемый файл ugrep создается в каталоге ugrep/src с помощью ./configure и make -j , что проверяется с помощью make test . Когда все тесты пройдены, исполняемый файл ugrep копируется в ugrep/bin/ugrep , а для команды ug добавляется символическая ссылка ugrep/bin/ug -> ugrep/bin/ugrep .
Обратите внимание, что ug — это то же самое, что и ugrep , но он также загружает файл конфигурации .ugrep, если он присутствует в рабочем или домашнем каталоге. Это означает, что вы можете определить параметры по умолчанию для ug в .ugrep.
Альтернативные пути к установленным или локальным библиотекам могут быть указаны с помощью ./build.sh . Чтобы получить справку по доступным вариантам сборки:
$ ./build.sh --help
Вы можете создавать статические исполняемые файлы, указав:
$ ./build.sh --enable-static
Это может привести к сбою, если библиотеки не компонуются статически, например brotli. В этом случае попробуйте ./build.sh --enable-static --without-brotli .
Вы можете создать ugrep с включенными настраиваемыми настройками по умолчанию, например пейджер:
$ ./build.sh --enable-pager
Варианты выбора значений по умолчанию для сборок включают:
--help отобразить параметры сборки--enable-static создать статические исполняемые файлы, если это возможно--enable-hidden всегда искать скрытые файлы и каталоги--enable-pager всегда использовать пейджер для отображения вывода на терминалах--enable-pretty раскрасить вывод на терминалы и добавить заголовки имен файлов--disable-auto-color отключить автоматические цвета, для отображения цветов требуется опция ugrep --color=auto--disable-mmap отключить файлы, отображенные в памяти--disable-sse2 отключить оптимизацию SSE2 и AVX--disable-avx2 отключить оптимизацию AVX2 и AVX512BW, но компилировать с SSE2, если он поддерживается--disable-neon отключить оптимизацию ARM NEON/AArch64--with-grep-path путь -f по умолчанию, если GREP_PATH не определен--with-grep-colors цвета по умолчанию, если GREP_COLORS не определен После завершения сборки скопируйте ugrep/bin/ugrep и ugrep/bin/ug в удобное место, например, в каталог ~/bin . Или, если вы захотите установить команды ugrep и ug и справочные страницы:
$ sudo make install
При этом также будут установлены файлы шаблонов с предопределенными шаблонами для опции -f в /usr/local/share/ugrep/patterns/ . Параметр -f сначала проверяет рабочий каталог на наличие файлов шаблонов, если не найден, проверяет переменную среды GREP_PATH для загрузки файлов шаблонов, а если не найден, считывает установленные предопределенные файлы шаблонов.
К сожалению, клоны git не сохраняют временные метки, а это означает, что вы можете столкнуться с сообщением «ВНИМАНИЕ: в вашей системе отсутствует 'aclocal-1.15'». или этот автозаголовок не был найден при запуске make .
Чтобы обойти эту проблему, запустите:
$ autoreconf -fi
$ ./build.sh
GCC 8 и более поздние версии могут выдавать предупреждения типа «примечание: передача параметра для аргумента... изменена в GCC 7.1» . Эти предупреждения следует игнорировать.
Включен файл Dockerfile для сборки ugrep в контейнере Ubuntu.
Разработчики могут захотеть использовать дезинфицирующие средства для проверки кода Ugrep при внесении существенных изменений, например, для обнаружения гонок данных с помощью ThreadSanitizer:
$ ./build.sh CXXFLAGS='-fsanitize=thread -O1 -g'
Мы проверили ugrep с помощью clang AddressSanitizer, MemorySanitizer, ThreadSanitizer и UndefineBehaviorSanitizer. Эти параметры влекут за собой значительные накладные расходы во время выполнения, и их не следует использовать для окончательной сборки.
? Вернуться к оглавлению
Обратите внимание, что команды ugrep и ug по умолчанию ищут двоичные файлы и не игнорируют указанные файлы .gitignore, что не сделает сравнение производительности рекурсивного поиска значимым, если не используются параметры -I и --ignore-files . Чтобы сделать эти параметры значениями по умолчанию для ug , просто добавьте ignore-binary и ignore-files в ваш файл конфигурации .ugrep.
Актуальное сравнение производительности последней версии Ugrep можно найти в тестах производительности Ugrep. Ugrep работает быстрее, чем GNU grep, Silver Searcher, ack, sift. Скорость Ugrep превосходит ripgrep в большинстве тестов.
Во-первых, давайте определим команду :grep в Vim для рекурсивного поиска файлов. Для этого добавьте следующие строки в ваш .vimrc расположенный в корневом каталоге:
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
Это определяет -j поиск без учета регистра с помощью команды Vim :grep . Для поиска с учетом регистра удалите -j из grepprg . Несколько совпадений в одной строке отображаются в окне быстрого исправления отдельно. Если это нежелательно, удалите -u из grepprg . При этом изменении отображается только первое совпадение в строке. Опция --ignore-files пропускает файлы, указанные в файлах .gitignore , если они присутствуют. Чтобы ограничить глубину рекурсивного поиска только текущим каталогом, добавьте -1 к grepprg .
Теперь вы можете вызвать команду Vim :grep в Vim для поиска файлов по указанному PATH на наличие совпадений PATTERN :
:grep PATTERN [PATH]
Если вы опустите PATH , поиск будет осуществляться в рабочем каталоге. Используйте % в качестве PATH для поиска только текущего открытого файла в Vim:
:grep PATTERN %
Команда :grep отображает результаты в окне быстрого исправления, которое позволяет быстро перейти к найденным совпадениям.
Чтобы открыть окно быстрого исправления с последним списком совпадений:
:copen
Дважды щелкните строку в этом окне (или выберите строку и нажмите ENTER), чтобы перейти к файлу и местоположению в файле соответствия. Введите команды :cn и :cp для перехода к следующему или предыдущему совпадению соответственно. Чтобы обновить результаты поиска в окне быстрого исправления, просто выполните команду grep. Например, чтобы рекурсивно выполнить поиск исходного кода C++ с пометкой FIXME в рабочем каталоге:
:grep -tc++ FIXME
Чтобы закрыть окно быстрого исправления:
:cclose
Вы можете использовать параметры ugrep с командой :grep , например, для выбора однострочных и многострочных комментариев в текущем файле:
:grep -f c++/comments %
В целях экономии места в быстром исправлении отображается только первая строка многострочного комментария. Чтобы отобразить все строки многострочного совпадения, удалите %-G из grepformat .
Популярным инструментом Vim является ctrlp.vim, который устанавливается с помощью:
$ cd ~/.vim
$ git clone https://github.com/kien/ctrlp.vim.git bundle/ctrlp.vim
CtrlP использует Ugrep , добавляя следующие строки в ваш .vimrc :
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
где -I пропускает двоичные файлы, опция --ignore-files пропускает файлы, указанные в файлах .gitignore , если они присутствуют, а опция -3 ограничивает поиск в каталогах тремя уровнями (рабочий каталог и до двух уровней ниже).
Запустите Vim и введите команду:
:helptags ~/.vim/bundle/ctrlp.vim/doc
Чтобы просмотреть документацию CtrlP в Vim, введите команду:
:help ctrlp.txt
? Вернуться к оглавлению
Благодаря Мануэлю Уберти теперь вы можете использовать ugrep в Emacs. Чтобы использовать ugrep вместо GNU grep в Emacs, добавьте следующую строку в ваш файл .emacs.d/init.el :
(setq-default xref-search-program ‘ugrep)
Это означает, что команды Emacs, такие как project-find-regexp , которые полагаются на Xref, теперь могут использовать возможности ugrep .
Более того, grep можно использовать в командах grep Emacs. Например, вы можете запустить lgrep с помощью ugrep , настроив grep-template примерно так:
(setq-default grep-template "ugrep --color=always -0Iinr -e <R>")
Если у вас нет Emacs версии 29 (или выше), вы можете загрузить и собрать Emacs из главной ветки Emacs или вручную включить интеграцию Xref с ugrep :
(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))
? Вернуться к оглавлению
Готовая версия ugrep поддерживает все стандартные параметры командной строки GNU/BSD grep, а также улучшает многие из них. Подробности см. в заметных улучшениях по сравнению с grep.
Если вы хотите точно придерживаться шаблонов Unicode GNU/BSD grep ASCII/LATIN1, не относящихся к UTF, используйте опцию -U , чтобы отключить полное сопоставление шаблонов Unicode.
Фактически выполнение ugrep с опциями -U , -Y , -. и --sort заставляет его вести себя точно так же, как egrep , сопоставляя только шаблоны Unicode ASCII/LATIN1, отличные от UTF, позволяя пустым шаблонам сопоставлять и искать скрытые файлы вместо их игнорирования соответственно. См. эквивалентность grep.
Вы можете создавать удобные псевдонимы grep с опциями -U , -Y , -. и --sort или включите другие параметры по желанию.
Или вы можете создать исполняемые файлы grep , egrep и fgrep скопировав ugrep под эти имена. Когда исполняемый файл ugrep (или ugrep.exe ) копируется как grep ( grep.exe ), egrep ( egrep.exe ), fgrep ( fgrep.exe ), тогда используются опции -U , -Y и -. автоматически включаются вместе с -G для grep , -E для egrep и -F для fgrep . Кроме того, при копировании как zgrep , zegrep и zfgrep включается опция -z . Например, когда ugrep копируется как zegrep , параметры -z , -E , -Y , -. и --sort включены.
Аналогично, символические и жесткие ссылки на ugrep также отлично подходят для создания замен grep , egrep и fgrep . Например, чтобы создать символическую ссылку egrep :
sudo ln -s `which ugrep` /opt/local/bin/egrep
/opt/local/bin является лишь примером и может находиться или не находиться в вашем $path и может быть найден или не найден при выполнении egrep в зависимости от вашего $path .
Ugrep эквивалентен GNU/BSD grep, если используются следующие параметры:
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
где:
-U отключает сопоставление шаблонов широких символов Юникода, поэтому, например, шаблон xa3 соответствует байту A3 вместо кодовой точки Юникода U+00A3, представленной последовательностью UTF-8 C2 A3. По умолчанию в ugrep xa3 соответствует U+00A3. Мы не рекомендуем использовать -U для поиска по текстовым шаблонам, только для двоичного поиска или для поиска файлов Latin-1 (iso-8859-1), не сообщая об этих файлах как о двоичных (начиная с ugrep v3.5.0).-Y включает пустые совпадения, поэтому, например, шаблон a* соответствует каждой строке, а не последовательности a . По умолчанию в Ugrep шаблон a* соответствует последовательности символов a . Более того, в ugrep шаблон a*b*c* соответствует тому, что должно соответствовать по умолчанию. Посмотрите улучшения.-. ищет скрытые файлы (точечные файлы). По умолчанию скрытые файлы игнорируются, как и большинство утилит Unix.--sort определяет выходные данные, отсортированные по пути, показывая сначала отсортированные совпадающие файлы, а затем отсортированные рекурсивные совпадения в подкаталогах. В противном случае соответствующие файлы сообщаются в произвольном порядке для повышения производительности;-Dread и -dread — это настройки grep по умолчанию в GNU/BSD, но использовать их не рекомендуется; пояснения см. в разделе «Улучшения».? Вернуться к оглавлению
Часто используемые псевдонимы, добавляемые в .bashrc для повышения производительности:
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)
? Вернуться к оглавлению
-Q .n .-U ).--bool ).--ignore-files .-Z .-z .-z .-z и --zmax=NUM на глубину до NUM уровней.--filter используя сторонние утилиты преобразования форматов в качестве плагинов.-r для рекурсивного поиска в каталогах.-. ).-E используется как egrep, тогда как -G включает BRE).-J1 ).-W (вывод двоичных совпадений в шестнадцатеричном формате, а текст соответствует выводу, как обычно) и -X (вывод всех совпадений в шестнадцатеричном формате).--format ).-f использует переменную среды GREP_PATH или предопределенные шаблоны, установленные в /usr/local/share/ugrep/patterns . Если указан -f , а также указан один или несколько шаблонов -e , то параметры -F , -x и -w не применяются к шаблонам -f . Это сделано для того, чтобы избежать путаницы, когда -f используется с предопределенными шаблонами, которые могут больше не работать должным образом с этими параметрами.-O , -M и -t определяют расширения файлов, шаблоны магических байтов подписи файлов и предопределенные типы файлов соответственно. Это позволяет искать определенные типы файлов в деревьях каталогов, например, с помощью опций рекурсивного поиска -R и -r . Опции -O , -M и -t также применяются к заархивированным файлам в файлах cpio, jar, pax, tar, zip и 7z.-k , --column-number для отображения номера столбца с учетом интервала табуляции путем расширения табуляции, как указано опцией --tabs .-P (регулярные выражения Perl) поддерживает обратные ссылки (с --format ) и просмотр назад, который использует библиотеку PCRE2 или Boost.Regex для быстрого сопоставления регулярных выражений Perl с синтаксисом, подобным PCRE.-b с опцией -o или с опцией -u , ugrep отображает точное смещение в байтах соответствия шаблону вместо смещения в байтах начала совпадающей строки, сообщаемой GNU/BSD grep.-u , --ungroup , чтобы не группировать несколько совпадений в строке. Эта опция снова отображает совпадающую входную строку для каждого дополнительного совпадения с шаблоном в строке. Эта опция особенно полезна вместе с опцией -c , чтобы сообщать общее количество совпадений с шаблоном на файл, а не количество строк, совпавших на файл.-Y включает сопоставление пустых шаблонов. Использование шаблонов с пустыми совпадениями является странным и дает разные результаты при использовании GNU grep и BSD grep. Пустые совпадения по умолчанию не выводятся утилитой ugrep , что позволяет избежать ошибок, которые могут привести к «случайным» результатам. Например, в GNU/BSD grep шаблон a* соответствует каждой строке входных данных и фактически соответствует xyz три раза (пустые переходы до и между x , y и z ). Для разрешения пустых совпадений требуется опция ugrep -Y . Шаблоны, начинающиеся с ^ или заканчивающиеся на $ , например ^h*$ , соответствуют пустым. Эти шаблоны автоматически включают опцию -Y .-D, --devices=ACTION по умолчанию skip вместо read . Это предотвращает неожиданное зависание именованных каналов в каталогах, в которых выполняется рекурсивный поиск, как это может произойти с GNU/BSD grep, который по умолчанию read устройства.-d, --directories=ACTION по умолчанию skip вместо read . По умолчанию поиск осуществляется в каталогах, указанных в командной строке, но не рекурсивно вглубь подкаталогов.-N PATTERN , которые представляют собой шаблоны формы (?^X) , которые пропускают весь ввод X , тем самым удаляя X из поиска. Например, отрицательные шаблоны можно использовать для пропуска строк и комментариев при поиске идентификаторов в исходном коде и поиска совпадений, которых нет в строках и комментариях. Предопределенные шаблоны zap используют отрицательные шаблоны, например, используйте -f cpp/zap_comments , чтобы игнорировать совпадения шаблонов в комментариях C++.GREP_OPTIONS , поскольку поведение ugrep должно быть переносимым и предсказуемым в любой системе. По этой же причине GNU grep отказался от GREP_OPTIONS . Используйте команду ug , которая загружает файл конфигурации .ugrep, расположенный в рабочем каталоге или в домашнем каталоге, если он присутствует, или используйте псевдонимы оболочки для создания новых команд с конкретными параметрами поиска.? Вернуться к оглавлению
Чтобы выполнить поиск с использованием файла конфигурации .ugrep расположенного в рабочем или домашнем каталоге (обратите внимание, что ug — это то же самое, что и ugrep --config ):
ug PATTERN FILE...
Чтобы сохранить файл конфигурации .ugrep в рабочем каталоге, затем отредактируйте этот файл в своем домашнем каталоге, чтобы настроить параметры ug по умолчанию:
ug --save-config
Чтобы выполнить поиск в рабочем каталоге и рекурсивно глубже для main (обратите внимание, что -r рекурсивные символические ссылки включены по умолчанию, если аргументы файла не указаны):
ug main
То же самое, но рекурсивно искать только файлы исходного кода C++, игнорируя все остальные файлы:
ug -tc++ main
То же самое, используя TUI интерактивного запроса, начиная с исходного шаблона поиска main (обратите внимание, что -Q с исходным шаблоном требует опции -e поскольку шаблоны обычно задаются в интерактивном режиме, и все аргументы командной строки считаются файлами/каталогами):
ug -Q -tc++ -e main
Чтобы выполнить поиск #define (и # define и т. д.) с использованием шаблона регулярного выражения в файлах C++ (обратите внимание, что шаблоны должны быть заключены в кавычки, чтобы предотвратить подстановку команд * и ? ):
ug -tc++ '#[t ]*define'
Чтобы выполнить рекурсивный поиск main слова ( -w ) без перехода по символическим ссылкам ( -r ) в каталоге myproject , показывая номера совпадающих строк ( -n ) и столбцов ( -k ) рядом с совпавшими строками:
ug -r -nkw main myproject
То же самое, но ищите только myproject без более глубокой рекурсии (обратите внимание, что аргументы каталога по умолчанию ищутся на одном уровне):
ug -nkw main myproject
То же самое, но выполните поиск myproject и на один уровень подкаталога глубже (два уровня) с -2 :
ug -2 -nkw main myproject
То же самое, но поиск файлов C++ только в myproject и его подкаталогах с помощью -tc++ :
ug -tc++ -2 -nkw main myproject
То же самое, но также поиск внутри архивов (например, файлов zip и tar) и сжатых файлов с помощью -z :
ug -z -tc++ -2 -nkw main myproject
Рекурсивно выполните поиск main рабочего каталога, игнорируя файлы gitignored (например, предполагая, что .gitignore находится в рабочем каталоге или ниже):
ug --ignore-files -tc++ -nkw main
Чтобы вывести список всех файлов в рабочем каталоге и глубже, которые не игнорируются файлами .gitignore :
ug --ignore-files -l ''
Чтобы отобразить список расширений имен файлов и «магических байтов» (шебангов), которые ищутся в соответствии с аргументами -t :
ug -tlist
Чтобы рекурсивно перечислить все файлы оболочки на основе расширений и шебангов с -l (обратите внимание, что '' соответствует любому непустому файлу):
ug -l -tShell ''
? Вернуться к оглавлению
Для поиска main в исходном коде, игнорируя строки и блоки комментариев, вы можете использовать отрицательные шаблоны с опцией -N , чтобы пропускать нежелательные совпадения в строках в кавычках C/C++ и блоках комментариев:
ug -r -nkw -e 'main' -N '"(\.|\r?n|[^\n"])*"|//.*|/*(.*n)*?.**+/' myproject
Это большой труд, чтобы написать правильно! Если вы похожи на меня, я не хочу тратить время на возню с шаблонами регулярных выражений, когда работаю над чем-то более важным. Существует более простой способ, используя предопределенные шаблоны UGREP ( -f ), которые установлены с помощью инструмента ugrep :
ug -r -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
Этот запрос также ищет другие файлы, кроме исходного кода C/C ++, таких как Readmes, Makefiles и так далее. Мы также пропускаем символики с -r . Итак, давайте уточним этот запрос, выбрав файлы C/C ++ только с помощью Option -tc,c++ и включите символики к файлам и каталогам с -R :
ug -R -tc,c++ -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
Что если вы хотите только искать main , но не как main( ? В данном случае используйте негативную шаблон для этого, чтобы пропустить нежелательный mainh*( шаблон соответствует:
ug -R -tc,c++ -nkw -e 'main' -N 'mainh*(' -f c/zap_strings -f c/zap_comments myproject
Это использует параметры -e и -N для явного определения шаблона и негативного шаблона, соответственно, который по существу формирует шаблон main|(?^mainh*() , где h соответствует пространству и вкладке. В общем Негативные шаблоны полезны для фильтрации матчей шаблонов, которые нас не интересуют.
В качестве другого примера, допустим, мы можем искать слово FIXME в блоках комментариев C/C ++. Для этого мы можем сначала выбрать блоки комментариев с предварительно определенным шаблоном c/comments от UGREP , а затем выбрать строки с помощью FIXME используя трубу:
ug -R -tc,c++ -nk -f c/comments myproject | ug -w 'FIXME'
Результаты фильтрации с помощью труб, как правило, проще, чем использование или логика или логики или логики или или логики, которые используют некоторые инструменты поиска. Этот подход следует за духом Unix, чтобы устоять утилиты и использовать их в комбинации для более сложных задач.
Давайте создадим отсортированный список всех идентификаторов, найденных в исходном коде Java, пропуская струны и комментарии:
ug -R -tjava -f java/names myproject | sort -u
Это соответствует идентификаторам java unicode с использованием regex p{JavaIdentifierStart}p{JavaIdentifierPart}* определенного в patterns/java/names .
Благодаря традиционным GREP и GREP инструментам, для повторного поиска исходного файла C/C ++ требуется большие усилия, который определяет функцию qsort , требуя чего-то подобного:
ug -R --include='*.c' --include='*.cpp' '^([ t]*[[:word:]:*&]+)+[ t]+qsort[ t]*([^;n]+$' myproject
К счастью, с UGREP мы можем просто выбрать все определения функций в файлах с расширением .c или .cpp , используя опцию -Oc,cpp и с помощью предопределенных functions шаблона, которые установлены с инструментом для создания всех определений функций. Затем мы выбираем тот, который мы хотим:
ug -R -Oc,cpp -nk -f c/functions | ug 'qsort'
Обратите внимание, что мы могли бы использовать -tc,c++ для выбора файлов C/C ++, но это также включает в себя файлы заголовков, когда мы хотим найти файлы .c и .cpp .
Мы также можем пропустить файлы и каталоги, которые будут искать, которые определены в .gitignore . Для этого мы используем --ignore-files чтобы исключить любые файлы и каталоги из рекурсивных поисков, которые соответствуют глобусам в .gitignore , когда найден один или несколько файлов .gitignore :
ug -R -tc++ --ignore-files -f c++/defines
Это ищет файлы c ++ ( -tc++ ) в рабочем каталоге для строк #define ( -f c++/defines ), в то время как пропуски файлов и каталогов объявлены в .gitignore . Если вы найдете это слишком долго для печати, определите псевдоним для поиска каталогов GitHub:
alias ugit='ugrep -R --ignore-files'
ugit -tc++ -f c++/defines
Чтобы выделить совпадения, когда мы проталкиваемся через цепь труб, мы должны использовать --color=always :
ugit --color=always -tc++ -f c++/defines | ugrep -w 'FOO.*'
Это возвращает заповедный список всех #define FOO... макросов в файлах исходного кода C/C ++, пропуская файлы, определенные в .gitignore .
Обратите внимание, что дополнение --exclude не является --include , потому что исключения всегда имеют приоритет над включениями, поэтому мы не можем надежно перечислить файлы, которые игнорируются --include-from='.gitignore' . Поселяются только файлы, четко указанные с --include и каталоги, указанные в явно указанных с помощью --include-dir . --include-from списков глобусов, которые считаются как файлами, так и каталогами, чтобы добавить к --include и --include-dir , соответственно. Это означает, что когда имена каталогов и пути каталогов не указаны явно в этом файле, то это не будет посещать с использованием --include-from .
Поскольку UGREP проверяет, если вход является допустимым UTF-кодируемым Unicode (если не используется -U ), можно использовать его в качестве фильтра для игнорирования вывода без UTF, создаваемого программой:
program | ugrep -I ''
Если программа создает допустимый выход, то выход проходит через выход, в противном случае вывод отфильтровал опцию -I . Если выход изначально действителен для очень большой части, но сопровождается недействительным выходом, то UGREP может изначально показать выход, но исключая недопустимый выход, после чего блокируется дальнейший выход.
Чтобы отфильтровать линии, которые являются действительными ASCII или UTF, кодируемыми, в то время как линии не удаляют линии:
program | ugrep '[p{Unicode}--[n]]+'
Обратите внимание, что p{Unicode} соответствует n но мы не хотим соответствовать всем файлу! Просто строки с [p{Unicode}--[n]]+ .
? Вернуться к содержимому
Страница UGREP MAN:
man ugrep
Чтобы показать страницу справки:
ug --help
Чтобы показать варианты, которые упоминают WHAT :
ug --help WHAT
Чтобы показать список значений опции -t TYPES :
ug -tlist
В интерактивном запросе TUI нажмите F1 или CTRL-Z для помощи и вариантов:
ug -Q
? Вернуться к содержимому
--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.
Команда ug предназначена для контекста-зависимого интерактивного поиска и эквивалентна команде ugrep --config для загрузки файла конфигурации .ugrep , когда присутствует в рабочем каталоге или, когда он не найден, в домашнем каталоге:
ug PATTERN ...
ugrep --config PATTERN ...
Команда ug также сортирует файлы по имени для поиска в каталоге. Файл конфигурации содержит NAME=VALUE на строку, где NAME является именем длинной опции (без -- ), а =VALUE это аргумент, который является необязательным и может быть пропущено в зависимости от опции. Пустые линии и линии, начиная с # игнорируются:
# 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
Параметры командной строки анализируются в следующем порядке: сначала (по умолчанию или по имени) загружается файл конфигурации), а затем анализируются оставшиеся параметры и аргументы в командной строке.
Опция --stats Отображает файл конфигурации, используемый после поиска.
Именованные файлы конфигурации предназначены для оптимизации пользовательских задач поиска путем уменьшения количества параметров командной строки до одного ---FILE для использования коллекции параметров, указанных в FILE . Опция --config=FILE и его сокращенная форма ---FILE указанный файл конфигурации, расположенный в рабочем каталоге, или, когда он не найден, расположен в домашнем каталоге:
ug ---FILE PATTERN ...
ugrep ---FILE PATTERN ...
Ошибка создается, когда FILE не найден или не может быть прочитал.
Именованные файлы конфигурации могут использоваться для определения сбора опций, которые относятся к требованиям задачи в рабочем процессе разработки проекта. Например, сообщать о неразрешенных вопросах, проверяя исходный код и документацию для комментариев с элементами FixMe и TODO. Такой именованный файл конфигурации может быть локализован в проекте, поместив его в каталог проектов, или он может быть сделан глобальным, поместив его в домашний каталог. Для визуальной обратной связи цветовая схема, специфичная для этой задачи, может быть указана с colors опции в FILE конфигурации, чтобы помочь идентифицировать выход, созданный именованной конфигурацией, в отличие от конфигурации по умолчанию.
Параметр --save-config сохраняет файл конфигурации .ugrep в рабочую каталог, используя текущую конфигурацию, загруженную с помощью --config . Это сохраняет текущую конфигурацию в сочетании с дополнительными параметрами, когда также указано. Только те варианты, которые не могут конфликтовать с другими опциями и опциями, которые не могут отрицательно влиять на результаты поиска, будут сохранены.
Параметр --save-config=FILE сохраняет конфигурацию в указанном FILE . Конфигурация записывается на стандартный выход, когда FILE - - .
В качестве альтернативы, файл конфигурации может быть создан вручную или изменен. Файл конфигурации может включать одну или несколько config[=FILE] для косвенной загрузки специфического FILE , но рекурсивная загрузка конфигурации запрещена. Самый простой способ Manuall создать файл конфигурации - указать config в верхней части файла, за которым следует длинные параметры для переопределения дефолтов.
? Вернуться к содержимому
-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.
Эта опция запускает пользовательский интерфейс для интерактивного ввода шаблонов поиска:
-c для подсчета совпадений. Нажатие Alt -C снова отключает -c . Параметры могут быть переключены с помощью ALT -клавиши во время поиска или при просмотре экрана справки. Если клавиши Alt/Meta не поддерживаются (например, x11 xterm), нажмите Ctrl-O, а затем клавиша, соответствующая опции.-g файл и сопоставление каталогов Globs, разделенный запятой список шаблонов в стиле Gitignore. Нажатие ESC возвращает контроль в подсказку с шаблоном запроса (глобусы сохраняются). Когда глобую предшествует ! или ^ , пропускает файлы, чье имя соответствует глобусу, когда глобус содержит A / , полные имена PathNames соответствуют. В противном случае базовые имена соответствуют. Когда глобус заканчивается с A / , каталоги соответствуют.Q> (нормальным), F> (фиксированные строки), G> (базовое регуляцию), P> (Perl Matching) и Z> (нечеткое сопоставление). Когда показана подсказка --glob= , может быть введен в запятой список шаблонов в стиле Gitignore. Нажатие ESC возвращает контроль в подсказку.--view .--view=COMMAND . В противном случае переменные среды PAGER или EDITOR используются для вызова команды с помощью Ctrl-Y. Имена файлов должны быть включены и видимы на выводе для использования этой функции.--color .DELAY такое как 1. Однако более низкие значения могут увеличить нагрузку на системную нагрузку в результате многократного инициирования и отмены поиска при каждом нажатом клавише.--heading умолчанию включено. Нажмите Alt-+, чтобы выключить заголовки.Запрос Mapping Key:
| Ключ (S) | функция |
|---|---|
Alt-key | Перевернуть вариант командной строки UGREP, соответствующая key |
Alt-/ xxxx / | Вставить шестнадцатеричную точку Unicode u+xxxx |
Esc Ctrl-C | вернуться или выйти |
Ctrl-Q | Быстрый выход и выводит результаты, выбранные в режиме выбора |
Tab | CHDIR в каталог файла, показанный в верхней части экрана, или выберите файл |
Shift-Tab | CHDIR один уровень вверх или Deselect File |
Enter | Введите режим выбора и переключите выбранные линии для вывода на выходе |
Up Ctrl-P | двигаться вверх |
Down Ctrl-N | двигаться вниз |
Left Ctrl-B | двигаться влево |
Right Ctrl-F | двигаться вправо |
PgUp Ctrl-G | Переместите отображение на странице |
PgDn Ctrl-D | Переместите отображение на странице |
Alt-Up | Переместите отображение на 1/2 страницы (MacOS Shift-Up ) |
Alt-Down | Переместите отображение на 1/2 страницы (Macos Shift-Down ) |
Alt-Left | Переместите отображение на 1/2 страницы (MacOS Shift-Left ) |
Alt-Right | Переместите отображение справа на 1/2 страницы (MacOS Shift-Right ) |
Home Ctrl-A | Переместить курсор в начало линии |
End Ctrl-E | Переместить курсор в конце линии |
Ctrl-K | Удалить после курсора |
Ctrl-L | Обновить экран |
Ctrl-O + key | Перевернуть вариант командной строки UGREP, соответствующая key , так же, как Alt-key |
Ctrl-R F4 | прыгнуть в закладки |
Ctrl-S | Перейдите к следующему DIR/FILE/CENTEXT |
Ctrl-T F5 | Переключатель сплит-экрана ( --split запускает сплит-экран TUI) |
Ctrl-U | Удалить перед курсором |
Ctrl-V | дословный характер |
Ctrl-W | Прыгните один Dir/File/Context |
Ctrl-X F3 | установить закладку |
Ctrl-Y F2 | Просмотреть или отредактировать файл, показанный в верхней части экрана |
Ctrl-Z F1 | Посмотреть помощь и варианты |
Ctrl-^ | CHDIR обратно в стартовый рабочий каталог |
Ctrl-] | Перевернуть цвет/моно |
Ctrl- | прекратить процесс |
Для интерактивного поиска файлов в рабочем каталоге и ниже:
ug -Q
То же самое, но ограничены только файлами c ++ и игнорируют .gitignore файлы:
ug -Q -tc++ --ignore-files
Для интерактивного поиска всех Makefiles в рабочем каталоге и ниже:
ug -Q -g 'Makefile*' -g 'makefile*'
То же самое, но для до 2 уровней каталогов (работа и один подкаталог):
ug -Q -2 -g 'Makefile*' -g 'makefile*'
Для интерактивного просмотра содержимого main.cpp и поиска его, где -y показывает любые линии, не являющиеся приспособлением, как контекст:
ug -Q -y main.cpp
Для интерактивного поиска main.cpp , начиная с шаблона поиска TODO и контекста соответствия 5 строк (контекст может быть включен и отключен в интерактивном порядке, это также переопределяет размер контекста по умолчанию 2 строк):
ug -Q -C5 -e TODO main.cpp
Для просмотра и поиска содержимого архива (например, Zip, Tarball):
ug -Q -z archive.tar.gz
Для интерактивного выбора файлов из project.zip для декомпрессации с помощью unzip , используя режим выбора запроса UGREP (нажмите Enter, чтобы выбрать строки):
unzip project.zip `zipinfo -1 project.zip | ugrep -Q`
? Вернуться к содержимому
-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.
Если файловые аргументы не указаны, и ввод считывается из терминала, рекурсивные поиски выполняются так, как если бы -r указан. Чтобы заставлять чтение с стандартного ввода, укажите - как аргумент файла.
Чтобы рекурсивно перечислить все непустые файлы в рабочем каталоге:
ug -r -l ''
Чтобы перечислить все непустые файлы в рабочем каталоге, но не глубже (поскольку аргумент файла дается, в данном случае . Для рабочего каталога):
ug -l '' .
Чтобы перечислить все непустые файлы в каталоге mydir , но не глубже (поскольку аргумент файла дан):
ug -l '' mydir
Чтобы перечислить все непустые файлы в каталоге mydir и глубже, следуя Symlinks:
ug -R -l '' mydir
Чтобы рекурсивно перечислить все непустые файлы на указанном пути, посещая только подкатарии, то есть каталоги mydir/ и Sub -Searctories на одном уровне более глубоко mydir/*/ посещаются (обратите внимание, что -2 -l можно сократить до -l2 ):
ug -2 -l '' mydir
Рекурсивно перечислить все непустые файлы в каталоге mydir , не следуя каким-либо символическим ссылкам (за исключением случаев, когда в командной строке, такой как mydir ):
ug -rl '' mydir
Чтобы рекурсивно перечислить все make -файлы, соответствующие тексту CPP :
ug -l -tmake 'CPP'
Рекурсивно перечислить все Makefile.* Соответствие bin_PROGRAMS :
ug -l -g'Makefile.*' 'bin_PROGRAMS'
Рекурсивно перечислить все непустые файлы с расширением .sh, с -Osh :
ug -l -Osh ''
Рекурсивно перечислить все сценарии оболочки на основе расширений и шебангов с -tShell :
ug -l -tShell ''
Рекурсивно перечислить все сценарии оболочки на основе расширений только с -tshell :
ug -l -tshell ''
? Вернуться к содержимому
--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.
Обратите внимание, что варианты --and , --not и --andnot не требуют -e PATTERN .
Опция -% делает все шаблоны на основе логических данных, поддерживая следующие логические операции, перечисленные с самого высокого уровня приоритета до самого низкого:
| оператор | альтернатива | результат |
|---|---|---|
"x" | Сопоставьте x буквально и точно так же, как указано (используя стандартную режиму выхода Q и E ) | |
( ) | Логическое выражение группировки | |
-x | NOT x | перевернутый матч, т.е. совпадает, если x не совпадает |
x|y | x OR y | соответствует строкам с x или y |
xy | x AND y | соответствует линиям с x и y |
x и y - это подчинения, которые не начинаются со специальных символов | , - и ( (используйте цитаты или побег, чтобы соответствовать их);
- NOT одинаковы и имеют приоритет над OR , что означает, что -x|y == (-x)|y , например.
| и OR являются одинаковыми и имеют приоритет AND , что означает, что xy|z == x (y|z) например;
Параметр --stats отображает логические запросы в читаемой человеке, преобразованной в CNF (конъюнктивная нормальная форма), после завершения поиска. Чтобы показать CNF без поиска, прочитайте из стандартного ввода, завершенного EOF, например, echo | ugrep -% '...' --stats .
Подвески зажигаются на выходе, за исключением того, что NOT отрицаются ( NOT подчиненный все еще может отображаться в соответствующей линии при использовании картины или не такого как x|-y ). Обратите внимание, что подчинения могут перекрываться. В этом случае только первое подчинение подчинения зажигается.
Несколько строк могут быть сопоставлены, когда подбороды соответствуют новичкам. Однако есть одно исключение X подчинения, заканчивающиеся (?=X)
Пустые узоры соответствуют любой линии (стандарт GREP). Следовательно, -% 'x|""|y' совпадает с всем, а x и y не зажигаются. Опция -y должен использоваться для отображения каждой строки в качестве контекста, например, -y 'x|y' .
Интерактивное интерактивное запросы FZF (логический поиск с фиксированными строками с нечетким сопоставлением, чтобы позволить, например, до 4 дополнительных символов, сопоставленных с -Z+4 в словах с -w ), нажмите вкладку и alt -y, чтобы просмотреть файл с матчами. Нажмите Shift-Tab и Alt-L, чтобы вернуться к списку соответствующих файлов:
ug -Q -%% -l -w -F -Z+4 --sort=best
Чтобы рекурсивно найти все файлы, содержащие как hot , так и dog в любом месте файла с опцией --files :
ug -%% 'hot dog'
ug --files -e hot --and dog
Чтобы найти линии, содержащие как hot , так и dog в myfile.txt :
ug -% 'hot dog' myfile.txt
ug -e hot --and dog myfile.txt
Чтобы найти линии, содержащие place , а затем также hotdog или taco (или оба) в myfile.txt :
ug -% 'hotdog|taco place' myfile.txt
ug -e hotdog -e taco --and place myfile.txt
То же самое, но исключайте линии, соответствующие diner :
ug -% 'hotdog|taco place -diner' myfile.txt
ug -e hotdog -e taco --and place --andnot diner myfile.txt
Чтобы найти линии с diner или линиями, которые соответствуют fast и food , но bad в myfile.txt :
ug -% 'diner|(fast food -bad)' myfile.txt
Чтобы найти линии с fast food (точно) или линий с diner , но не bad или old в myfile.txt :
ug -% '"fast food"|diner -bad -old' myfile.txt
То же самое, но используя другое логическое выражение, которое имеет одинаковое значение:
ug -% '"fast food"|diner -(bad|old)' myfile.txt
Чтобы найти линии с diner подразумевающей good в myfile.txt (то есть, покажите линии с good без diner и покажите линии с diner , но только с good , что логически подразумевается!):
ug -% 'good|-diner' myfile.txt
ug -e good --not diner myfile.txt
Чтобы найти строки с foo и -bar и "baz" в myfile.txt (не то, что - " следует сопоставить с помощью Escapes и с --and -e -bar ):
ug -% 'foo -bar "baz"' myfile.txt
ug -e foo --and -e -bar --and '"baz"' myfile.txt
Для поиска myfile.cpp для строк с TODO или FIXME , но не оба на одной линии, как XOR:
ug -% 'TODO|FIXME -(TODO FIXME)' myfile.cpp
ug -e TODO -e FIXME --and --not TODO --not FIXME myfile.cpp
? Вернуться к содержимому
-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 $.
См. Также Boolean Patterns с -%, -%%, -и, не для более мощных вариантов логического запроса, чем традиционные варианты GNU/BSD GREP.
Чтобы отобразить строки в файле myfile.sh , но не строки, соответствующие ^[ t]*# :
ug -v '^[ t]*#' myfile.sh
Чтобы найти myfile.cpp для линий с FIXME и urgent , но не Scotty :
ugrep FIXME myfile.cpp | ugrep urgent | ugrep -v Scotty
То же самое, но используя -% для логических запросов:
ug -% 'FIXME urgent -Scotty' myfile.cpp
Для поиска десятичных декораций, используя шаблон d+ , которые не начинаются с 0 используя отрицательный шаблон 0d+ и исключая 555 :
ug -e 'd+' -N '0d+' -N 555 myfile.cpp
Для поиска слов, начинающихся с disp , без сопоставления display в файле myfile.py , используя «негативную шаблон» -N '/<display>' , где -N определяет дополнительный отрицательный шаблон для пропуска матчей:
ug -e '<disp' -N '<display>' myfile.py
Чтобы найти строки с помощью слова display в файле myfile.py пропуская это слово в строках и комментариях, где -f указывает шаблоны в файлах, которые являются предопределенными шаблонами в этом случае:
ug -n -w 'display' -f python/zap_strings -f python/zap_comments myfile.py
Чтобы отобразить строки, которые не являются пустыми линиями:
ug -x -e '.*' -N 'h*' myfile.py
То же самое, но используя -v и -x с h* , т.е. pattern ^h*$ :
ug -v -x 'h*' myfile.py
Чтобы рекурсивно перечислить все файлы Python, которые не содержат слова display , позволяя слову происходить в строках и комментариях:
ug -RL -tPython -w 'display' -f python/zap_strings -f python/zap_comments
? Вернуться к содержимому
--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.)
Файлы бинарных, ASCII и UTF-8 не требуют этой опции для их поиска. Также файлы UTF-16 и UTF-32 не требуют этой опции для их поиска, предполагая, что файлы UTF-16 и UTF-32 начинаются с UTF BOM (оценка байта), как обычно. Другие кодировки файлов требуют опции --encoding=ENCODING :
| кодирование | параметр |
|---|---|
| ASCII | н/д |
| UTF-8 | н/д |
| UTF-16 с Bom | н/д |
| UTF-32 с Bom | н/д |
| UTF-16 быть без бом | UTF-16 или UTF-16BE |
| UTF-16 LE W/O BOM | UTF-16LE |
| UTF-32 без бом | UTF-32 или UTF-32BE |
| UTF-32 без бом | UTF-32LE |
| Латин-1 | LATIN1 или 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 |
| Макроман (Cr = Newline) | MACROMAN |
| EBCDIC | EBCDIC |
| Код DOS Страница 437 | CP437 |
| Код DOS Страница 850 | CP850 |
| Код DOS Страница 858 | CP858 |
| Кодовая страница Windows 1250 | CP1250 |
| Кодовая страница Windows 1251 | CP1251 |
| Кодовая страница Windows 1252 | CP1252 |
| Кодовая страница Windows 1253 | CP1253 |
| Кодовая страница Windows 1254 | CP1254 |
| Кодовая страница Windows 1255 | CP1255 |
| Кодовая страница Windows 1256 | CP1256 |
| Кодовая страница Windows 1257 | CP1257 |
| Кодовая страница Windows 1258 | CP1258 |
| Koi8-r | KOI8-R |
| Koi8-u | KOI8-U |
| Koi8-ru | KOI8-RU |
Обратите внимание, что шаблоны регуляции всегда указываются в UTF-8 (включает ASCII). Для поиска двоичных файлов с помощью двоичных шаблонов см. Поиск и отображение двоичных файлов с -U, -W и -X.
Рекурсивно перечислить все файлы, которые являются ASCII (то есть 7-бит):
ug -L '[^[:ascii:]]'
Рекурсивно перечислить все файлы, не являющиеся файлами, не являющимися файлами, т.е. UTF-8, UTF-16 и UTF-32 с символами Unicode не ASCII (U+0080 и выше):
ug -l '[^[:ascii:]]'
Чтобы проверить, содержит ли файл Unicode не ASCII (U+0080 и выше):
ug -q '[^[:ascii:]]' myfile && echo "contains Unicode"
Чтобы удалить неверные символы Unicode из файла (обратите внимание, что -o может не работать, потому что двоичные данные обнаруживаются и отклоняются и добавляются новички, но --format="%o% не проверяет бинарный и копирует матч", как есть " ):
ug "[p{Unicode}n]" --format="%o" badfile.txt
Чтобы рекурсивно перечислить файлы с недопустимым контентом UTF (то есть недопустимых последовательностей UTF-8 байтов или файлов, которые содержат любые кодовые точки UTF-8/16/32, которые находятся за пределами допустимого диапазона Unicode), сопоставив любую кодовую точку . и с помощью негативного шаблона -N 'p{Unicode}' чтобы игнорировать каждый действительный символ Unicode:
ug -l -e '.' -N 'p{Unicode}'
Чтобы показать линии, содержащие смайлики смеха:
ug '[?-?]' emojis.txt
Те же результаты получаются с использованием x{hhhh} чтобы выбрать диапазон символов Unicode:
ug '[x{1F600}-x{1F60F}]' emojis.txt
Чтобы отобразить линии, содержащие имена Gödel (или Goedel), Escher или Bach:
ug 'G(ö|oe)del|Escher|Bach' GEB.txt wiki.txt
Для поиска lorem в нижнем или верхнем регистре в файле UTF-16, который отмечен UTF-16 BOM:
ug -iw 'lorem' utf16lorem.txt
Для поиска utf16lorem.txt, когда в этом файле нет UTF-16 BOM, используя --encoding :
ug --encoding=UTF-16 -iw 'lorem' utf16lorem.txt
Для поиска файла spanish-iso.txt закодированного в ISO-8859-1:
ug --encoding=ISO-8859-1 -w 'año' spanish-iso.txt
? Вернуться к содержимому
-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.
Несколько строк могут быть сопоставлены с шаблонами, которые соответствуют символам Newline. Используйте опцию -o , чтобы вывести только совпадение, а не полные линии (ы), которые совпадают.
Чтобы соответствовать разрыву линии n , включите n в шаблон, чтобы соответствовать символу LF. Если вы хотите соответствовать разрыву строки rn и n , используйте r?n или просто используйте R , чтобы соответствовать любому разрыву строки Unicode rn , r , v , f , n , u +0085, U+2028 и U+2029.
Чтобы соответствовать C/C ++ /*...*/ Многострочные комментарии:
ug '/*(.*n)*?.**+/' myfile.cpp
Чтобы соответствовать комментариям C/C ++ с использованием предварительно определенных шаблонов c/comments с -fc/comments , ограниченными соответствующей частью только с помощью опции -o :
ug -of c/comments myfile.cpp
То же, что и sed -n '/begin/,/end/p' : соответствовать всем линиям между линией, содержащей begin , и первой строкой после этого, содержащего end , используя ленивое повторение:
ug -o '.*begin(.|n)*?end.*' myfile.txt
? Вернуться к содержимому
-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.
Чтобы отобразить две строки контекста до и после подходящей линии:
ug -C2 'FIXME' myfile.cpp
Чтобы показать три строки контекста после подходящей линии:
ug -A3 'FIXME.*' myfile.cpp:
Чтобы отобразить одну строку контекста перед каждой соответствующей строкой с определением функции C (C имена не являются Unicode):
ug -B1 -f c/functions myfile.c
Чтобы отобразить одну строку контекста перед каждой соответствующей строкой с определением функции C ++ (имена C ++ может быть Unicode):
ug -B1 -f c++/functions myfile.cpp
Чтобы отобразить любые не сопоставляющие строки в качестве контекста для соответствия строк с -y :
ug -y -f c++/functions myfile.cpp
Чтобы отобразить гексдумп подходящей линии с одной линией контекста Hexdump:
ug -C1 -UX 'xaaxbbxcc' a.out
Контекст в линии отображается с опцией -o с опцией контекста:
ug -o -C20 'pattern' myfile.cpp
То же самое, но с красивым выводом с заголовками, номерами строк и номерами столбцов ( -k ) и показывающим контекст:
ug --pretty -oC20 'pattern' myfile.cpp
? Вернуться к содержанию
-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.
Типы файлов перечислены с ugrep -tlist . Список основан на расширениях имени файла и «магических байтах». Если у вас есть тип файла, который не указан, используйте параметры -O и/или -M . Возможно, вы захотите определить псевдоним, например, alias ugft='ugrep -Oft' как сокращение для поиска файлов с суффиксом имени файла .ft .
Рекурсивно отобразить определения функций в файлах C/C ++ ( .h , .hpp , .c , .cpp и т. Д.) с номерами строк с -tc++ , -o , -n и -f c++/functions :
ug -on -tc++ -f c++/functions
Чтобы рекурсивно отобразить определения функций в файлах .c и .cpp с номерами строк с -Oc,cpp , -o , -n и -f c++/functions :
ug -on -Oc,cpp -f c++/functions
Чтобы рекурсивно перечислить все файлы оболочки с -tShell чтобы соответствовать расширениям имени файла и файлов с Shell Shebangs, кроме файлов с суффиксом .sh :
ug -l -tShell -O^sh ''
Чтобы рекурсивно перечислить все не -оболочки с помощью -t^Shell :
ug -l -t^Shell ''
Рекурсивно перечислить все файлы оболочки с оболочкой Shebangs, у которых нет расширений имени файла оболочки:
ug -l -tShell -t^shell ''
Для поиска строк с FIXME в комментариях C/C ++, исключая FIXME в многострочных строках:
ug -n 'FIXME' -f c++/zap_strings myfile.cpp
Для чтения шаблонов TODO и FIXME из стандартного ввода, чтобы соответствовать линиям в входе, исключая совпадения в строках C ++:
ug -on -f - -f c++/zap_strings myfile.cpp <<END
TODO
FIXME
END
Чтобы отобразить теги элемента и атрибута XML в файле XML, ограниченную соответствующей частью с -o , исключая теги, которые размещены в (многострочные) комментарии:
ug -o -f xml/tags -f xml/zap_comments myfile.xml
? Вернуться к содержимому
-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.
Файлы, сжатые с помощью Gzip ( .gz ), сжатия ( .Z ), bzip2 ( .bz , .bz2 , .bzip2 ), lzma ( .lzma ), xz ( .xz ), lz4 ( .lz4 ), zstd ( .zst ,, .zstd ), brotli ( .br ) и bzip3 ( .bz3 ) с опцией -z , когда соответствующие библиотеки установлены и скомпилированы с UGREP. Эта опция не требует сжатия файлов. Несоцененные файлы также ищут также, хотя и медленнее.
Другие форматы сжатия можно искать с помощью фильтров UGREP .
Архивы (CPIO, JAR, PAX, TAR, ZIP и 7Z) выполняются с опцией -z . Регулярные файлы в архиве, который соответствует выводу с архивными путями, заключенными в брекеты { и } . Поддерживаемые форматы смолы V7, USTAR, GNU, OldGNU и PAX. Поддерживаемые форматы CPIO являются ODC, NEWC и CRC. Не поддерживается устаревший невоздушный старый бинарный бинарный формат CPIO. Форматы архива CPIO, TAR и PAX автоматически распознаются с помощью опции -z на основе их содержания, независимо от суффикса имени файла.
По умолчанию также поиск в архивах ZIP, хранящихся в архивах ZIP: все файлы CPIO, PAX и TAR, хранящиеся в архивах ZIP и 7Z, автоматически распознаются и искали. Однако, по умолчанию, сжатые файлы, хранящиеся в архивах, не распознаются, например, файлы ZIP, хранящиеся в файлах TAR, не ищут, а все сжатые файлы и архивы ищут, как если бы они представляют собой двоичные файлы без их распаковки.
Укажите --zmax=NUM для поиска архивов, которые содержат сжатые файлы и архивы для глубины NUM . Значение NUM может варьироваться от 1 до 99 для до 99 шагов декомпрессии и де-архивирования для расширения до 99 вложенных архивов. Больше --zmax=NUM значения деградируют производительность. Вряд ли вам когда -либо понадобится 99 AS --zmax=2 достаточно для большинства практических вариантов использования, таких как поиск файлов Zip, хранящихся в файлах TAR.
Когда опция -z используется с параметрами -g , -O , -M или -t , архивами и сжатыми и несжаемыми файлами, которые соответствуют критериям выбора файла (глобус, расширение, магические байты или тип файла) только поиск. Например, ugrep -r -z -tc++ ищет файлы c ++, такие как main.cpp и zip и tar -архивы, которые содержат файлы c ++, такие как main.cpp . Также в поиске включены сжатые файлы C ++, такие как main.cpp.gz и main.cpp.xz при наличии. Кроме того, любые архивы CPIO, PAX, TAR, ZIP и 7Z, когда они находятся в настоящих файлах C ++, которые они содержат, такие как main.cpp . Используйте опцию --stats , чтобы увидеть список шаблонов глобуса, применяемых для фильтрации путей файла в рекурсивном поиске и при поиске содержимого архива.
Когда опция -z используется с параметрами -g , -O , -M или -t для поиска архивов CPIO, JAR, PAX, TAR, ZIP и 7Z, архивные файлы, соответствующие критериям выбора файла, исходят только.
Форматы GZIP, сжатия и ZIP автоматически обнаруживаются, что полезно при чтении данных с распределением GZIP с стандартного входа, например, входного входа, перенаправленного из трубы. Другие форматы сжатия требуют суффикса имени файла: .bz , .bz2 , или .bzip2 для bzip2, .lzma для lzma, .xz для xz, .lz4 для lz4, .zst или .zstd для zstd, .br для brotli и .bz3 для Bzip3. Также сжатые архив -архивные ограничения .taz , .tgz и .tpz для Gzip, .tbz , .tbz2 , .tb2 и .tz2 для Bzip2, .tlz для lzma, .txz для xz и .tzst для zstd распознаются. Чтобы найти эти форматы с UGREP с стандартного ввода, используйте опцию --label='stdin.bz2' для Bzip2, --label='stdin.lzma' для lzma, --label='stdin.xz' для xz, --label='stdin.lz4 для lz4 и --label='stdin.zst для zstd и так далее. Имя stdin произвольное и может быть опущено:
| формат | Суффикс имени файла | TAR/PAX ARCHIVE Короткий суффикс | Требуется суффикс? | Ugrep от Stdin | библиотека |
|---|---|---|---|---|---|
| gzip | .gz | .taz , .tgz , .tpz | нет | автоматический | либ |
| компресс | .Z | .taZ , .tZ | нет | автоматический | встроенный |
| молния | .zip , .zipx , .ZIP | нет | автоматический | либ | |
| 7zip | .7z | да | --label=.7z | встроенный | |
| Bzip2 | .bz , .bz2 , .bzip2 | .tb2 , .tbz , .tbz2 , .tz2 | да | --label=.bz2 | libbz2 |
| лзма | .lzma | .tlz | да | --label=.lzma | liblzma |
| хз | .xz | .txz | да | --label=.xz | liblzma |
| лз4 | .lz4 | да | --label=.lz4 | liblz4 | |
| zstd | .zst , .zstd | .tzst | да | --label=.zst | libzstd |
| Бротли | .br | да | --label=.br | Libbrotlidec | |
| Bzip3 | .bz3 | да | --label=.bz3 | libbzip3 |
Форматы GZIP, BZIP2, XZ, LZ4 и ZSTD поддерживают конкатенированные сжатые файлы. Согласованные сжатые файлы ищут как один файл.
Поддерживаемые методы сжатия на молнии хранятся (0), дефлятные (8), BZIP2 (12), LZMA (14), XZ (95) и ZSTD (93). Методы BZIP2, LZMA, XZ и ZSTD требуют, чтобы UGREP был составлен с соответствующими библиотеками сжатия.
Поиск зашифрованных ZIP -архивов не поддерживается (возможно, в будущих выпусках, в зависимости от запросов на улучшения).
Поиск Archives 7ZIP занимает гораздо больше оперативной памяти и больше времени по сравнению с другими методами. Реализация 7ZIP LZMA SDK не поддерживает потоковую передачу, требуя физического файла 7Z. Это означает, что файлы 7Z не могут быть поиска, когда они вложены в архив. Лучше всего избегать 7zip. Поддержка 7ZIP может быть отключена с ./build.sh --disable-7zip для построения UGREP.
Опция -z использует потоки для параллелизма задачи, чтобы ускорить поиск более крупных файлов, одновременно запустив декомпрессор с поиском декомпрессированного потока.
Чтобы перечислить все непустые файлы, хранящиеся в архиве package.zip .
ug --zmax=2 -z -l '' package.zip
То же самое, но только перечислите файлы исходного кода Python, включая сценарии, которые вызывают Python, с опцией -tPython ( ugrep -tlist для получения подробной информации):
ug --zmax=2 -z -l -tPython '' package.zip
Для поиска приложений Python, распределенных как файл TAR с их зависимостями, включает в себя как колеса (zip -файлы с кодом Python), поиск слова my_class in app.tgz :
ug --zmax=2 -z -tPython -w my_class app.tgz
Чтобы рекурсивно искать файлы C ++, включая сжатые файлы для слова my_function , в то время как пропуски C и C ++ Комментарии:
ug -z -r -tc++ -Fw my_function -f cpp/zap_comments
Для поиска BZIP2, LZMA, XZ, LZ4 и ZSTD сжатые данные при стандартном входе, опция --label может использоваться для указания расширения, соответствующего формату сжатия для усиления декомпрессии, когда расширение BZIP2 не доступно для UGREP, например:: Например::
cat myfile.bz2 | ugrep -z --label='stdin.bz2' 'xyz'
Для поиска файла main.cpp в project.zip для строк TODO и FIXME :
ug -z -g main.cpp -w -e 'TODO' -e 'FIXME' project.zip
Для поиска tarball project.tar.gz для файлов c ++ с помощью линий TODO и FIXME :
ug -z -tc++ -w -e 'TODO' -e 'FIXME' project.tar.gz
Для поиска файлов, соответствующих глобусу *.txt в project.zip для license в любом случае (обратите внимание, что аргумент -g Glob должен быть указан):
ug -z -g '*.txt' -w -i 'license' project.zip
Чтобы отобразить и страдать через все файлы C ++ в Tarball project.tgz :
ug --pager -z -tc++ '' project.tgz
Чтобы перечислить файлы, соответствующие стилю Gitignore Glob /**/projects/project1.* в projects.tgz , выбрав файлы, содержащие в архиве текст December 12 :
ug -z -l -g '/**/projects/project1.*' -F 'December 12' projects.tgz
Чтобы просмотреть данные meta -inf/manifest.mf в файле jar с -Ojar и -OMF , чтобы выбрать файл JAR и файл MF в нем ( -Ojar требуется, в противном случае файл JAR будет пропущен, хотя мы могли его прочитать из вместо этого стандартный ввод):
ug -z -h -OMF,jar '' my.jar
Чтобы извлечь файлы C ++, которые содержат FIXME из project.tgz , мы используем -m1 с --format="'%z '" для создания разделенного пространственным списком путей, расположенных в архиве, который соответствует слову FIXME :
tar xzf project.tgz `ugrep -z -l -tc++ --format='%z ' -w FIXME project.tgz`
Чтобы выполнить поиск по глубине с find , затем используйте cpio и ugrep для поиска файлов:
find . -depth -print | cpio -o | ugrep -z 'xyz'
? Вернуться к содержимому
--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.
Рекурсивно перечислить все файлы, которые начинаются с #! Шебангс:
ug -l -M'#!' ''
Рекурсивно перечислить все файлы, которые начинаются с # , но не с #! Шебангс:
ug -l -M'#' -M'^#!' ''
Рекурсивно перечислить все файлы Python (Extension .py или a Shebang) с -tPython :
ug -l -tPython ''
Чтобы рекурсивно перечислить все не -оболочки с помощью -t^Shell :
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. Например:
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:
| шаблон | спички |
|---|---|
* | 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 :
| параметр | результат |
|---|---|
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= | сепараторы |
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:
| код | с | эффект | код | с | эффект |
|---|---|---|---|---|---|
| 0 | н | normal font and color | 2 | ж | faint (not widely supported) |
| 1 | час | highlighted bold font | 21 | ЧАС | highlighted bold off |
| 4 | ты | подчеркнуть | 24 | ты | underline off |
| 7 | я | инвертировать видео | 27 | я | invert off |
| 30 | к | black text | 90 | +k | bright gray text |
| 31 | р | red text | 91 | +р | bright red text |
| 32 | г | green text | 92 | +g | bright green text |
| 33 | й | yellow text | 93 | +y | bright yellow text |
| 34 | б | blue text | 94 | +b | bright blue text |
| 35 | м | magenta text | 95 | +m | bright magenta text |
| 36 | с | cyan text | 96 | +с | bright cyan text |
| 37 | ш | белый текст | 97 | +w | bright white text |
| 40 | К | черный фон | 100 | +К | bright gray background |
| 41 | Р | dark red background | 101 | +R | bright red background |
| 42 | Г | dark green background | 102 | +Г | bright green background |
| 43 | Да | dark yellow backgrounda | 103 | +Y | bright yellow background |
| 44 | Б | dark blue background | 104 | +Б | bright blue background |
| 45 | М | dark magenta background | 105 | +М | bright magenta background |
| 46 | С | dark cyan background | 106 | +С | bright cyan background |
| 47 | Вт | 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:
| вариант | результат |
|---|---|
--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| вариант | format string (within quotes) |
|---|---|
--format-open | '%+' |
--format | '%[,]$%H%N%K%B%V%~%u' |
--json| вариант | 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| вариант | 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| вариант | format string (within quotes) |
|---|---|
--format-open | '%+' |
--format | '%F%n%s%K%B%~%u' |
The following fields may be used in the FORMAT string:
| поле | выход |
|---|---|
%% | 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 |
Примечание:
%~ 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 ψ :
| Шаблон | Матчи |
|---|---|
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 ):
| Шаблон | Матчи |
|---|---|
[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 | Матчи |
|---|---|
[: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 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
