ugrep
v7.1.1
[ LÉAME | Guía del usuario | Indexación | Puntos de referencia | Preguntas y respuestas]
¡La opción -Q abre una TUI de consulta para buscar archivos mientras escribes!
ugrep es rápido, fácil de usar y está equipado con un montón de funciones nuevas que los usuarios querían
incluye una TUI interactiva con ayuda incorporada, búsqueda similar a Google con patrones Y/O/NO, búsqueda difusa, búsqueda (anidada) de archivos zip/7z/tar/pax/cpio, archivos tar y archivos comprimidos gz/Z/bz/ bz2/lzma/xz/lz4/zstd/brotli, búsqueda y volcado hexadecimal de archivos binarios, búsqueda de documentos como PDF, doc, docx y salida en JSON, XML, CSV o tu propio formato personalizado
Sintaxis de patrones de expresiones regulares extendida Unicode con coincidencia de patrones de varias líneas sin necesidad de opciones especiales de línea de comandos
Incluye un indexador de archivos para acelerar la búsqueda en sistemas de archivos lentos y fríos.
un verdadero reemplazo directo para GNU grep (suponiendo que copie o enlace simbólicamente ug a grep y a egrep y fgrep ), a diferencia de otros grep populares que afirman ser "alternativas de grep" o "reemplazos" cuando en realidad implementan una línea de comandos incompatible opciones y use un comparador de expresiones regulares incompatible, es decir, solo expresiones regulares de Perl versus POSIX BRE (grep) y ERE (egrep) cuando ugrep admite todos los modos de expresiones regulares
Los puntos de referencia muestran que ugrep es (uno de) los grep más rápidos que utilizan el comparador de expresiones regulares RE/flex de alto rendimiento basado en DFA.
Si se debe mejorar o agregar algo a ugrep, ¡hágamelo saber!
La prioridad número uno es la garantía de calidad para continuar asegurándonos de que ugrep no tenga errores y sea confiable.
haga que ugrep se ejecute aún más rápido, consulte, por ejemplo, #432, #421
compartir resultados de rendimiento reproducibles
ug es para uso interactivo, que carga un archivo de configuración .ugrep opcional con sus preferencias ubicado en el directorio de trabajo o en el directorio de inicio, ug+ también busca archivos PDF, documentos, libros electrónicos y metadatos de imágenes.
ugrep para uso por lotes como GNU grep sin un archivo de configuración .ugrep, ugrep+ también busca archivos PDF, documentos, libros electrónicos y metadatos de imágenes.
Coincide con patrones Unicode de forma predeterminada y busca automáticamente archivos codificados en UTF-8, UTF-16 y UTF-32.
Coincide con varias líneas con n o R en patrones de expresiones regulares, ¡no se requieren opciones especiales para hacerlo!
Ayuda integrada: ug --help , donde ug --help WHAT muestra opciones relacionadas con WHAT estás buscando
ug --help regex , ug --help globs , ug --help fuzzy , ug --help format .
Fácil de usar con archivos de configuración personalizables utilizados por el comando ug destinado a uso interactivo que carga un archivo de configuración .ugrep con sus preferencias
ug PATTERN ... ugrep --config PATTERN ...
ug --save-config ...options-you-want-to-save... guarda un archivo de configuración .ugrep en el directorio de trabajo para que la próxima vez que ejecute ug allí utilice estas opciones. Haga esto en su directorio de inicio para guardar un archivo de configuración .ugrep con las opciones que generalmente desea usar.
Consulta interactiva TUI, presione F1 o CTRL-Z para obtener ayuda y TAB/SHIFT-TAB para navegar a directorios y archivos
ug -Q ug -Q -e PATTERN
-Q reemplaza PATTERN en la línea de comando para permitirle ingresar patrones de forma interactiva en la TUI. En la TUI, utilice ALT+teclas de letras para activar/desactivar las "opciones de letras" cortas, por ejemplo ALT-n (opción -n ) para mostrar/ocultar números de línea.
Busque el contenido de archivos (zip, tar, pax, jar, cpio, 7z) y archivos comprimidos (gz, Z, bz, bz2, lzma, xz, lz4, zstd, brotli)
ug -z PATTERN ... ug -z --zmax=2 PATTERN ...
Especifique -z --zmax=2 para buscar archivos comprimidos y archivos anidados dentro de archivos. El argumento --zmax puede variar de 1 (predeterminado) a 99 para hasta 99 pasos de descompresión y desarchivado para buscar archivos anidados.
Busque con patrones de consulta booleanos similares a los de Google usando patrones -% con AND (o solo espacio), OR (o una barra | ), NOT (o un guión - ), usando comillas para que coincidan exactamente y agrupando con ( ) (que se muestra en el lado izquierdo abajo); o con opciones -e (como "o"), --and , --andnot y --not patrones de expresiones regulares (que se muestran en el lado derecho a continuación):
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' ...
donde A , B y C son patrones de expresiones regulares arbitrarios (use la opción -F para buscar cadenas)
especifique la opción -%% ( --bool --files ) para aplicar la consulta booleana a los archivos en su conjunto: un archivo coincide si se cumplen todas las condiciones booleanas al hacer coincidir los patrones en todo el archivo. De lo contrario, las condiciones booleanas se aplican a líneas individuales de forma predeterminada, ya que las utilidades grep generalmente comparan patrones basados en líneas. La opción --stats muestra la consulta en formato legible por humanos una vez completada la búsqueda.
Busque pdf, doc, docx, libros electrónicos y más con ug+ usando filtros asociados con las extensiones de nombre de archivo:
ug+ PATTERN ...
o especifique --filter con un tipo de archivo para usar una utilidad de filtro:
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 ...
El comando ug+ es el mismo que el comando ug , pero también utiliza filtros para buscar archivos PDF, documentos y metadatos de imágenes.
Muestre el contexto horizontal con la opción -o ( --only-matching ) y las opciones de contexto -ABC , por ejemplo, para buscar coincidencias en líneas muy largas, como fuentes Javascript y JSON:
ug -o -C20 -nk PATTERN longlines.js
-o -C20 ajusta todas las coincidencias con un contexto de 20 caracteres antes y 20 caracteres después de una coincidencia (es decir, 40 caracteres Unicode en total), -nk genera números de línea y columna.
Encuentre coincidencias de patrones aproximadas con búsqueda difusa, dentro de la distancia de Levenshtein especificada
ug -Z PATTERN ... ug -Z3 PATTTERN ...
-Zn coincide con hasta n caracteres adicionales, faltantes o reemplazados, -Z+n coincide con hasta n caracteres adicionales, -Zn coincide con hasta n caracteres faltantes y -Z~n coincide con hasta n caracteres reemplazados. -Z por defecto es -Z1 .
Búsqueda tipo Fzf con expresiones regulares (o cadenas fijas con -F ), coincidencia aproximada con hasta 4 caracteres adicionales con -Z+4 y palabras solo con -w , usando -%% para búsquedas booleanas en todo el archivo
ug -Q -%% -l -w -Z+4 --sort=best
-l enumera los archivos coincidentes en la TUI, presione TAB y luego ALT-y para ver un archivo, SHIFT-TAB y Alt-l para regresar y ver la lista de archivos coincidentes ordenados por mejor coincidencia
Busque archivos binarios y muestre volcados hexadecimales con coincidencias de patrones binarios (texto Unicode o -U para patrones de bytes)
ug --hexdump -U BYTEPATTERN ... ug --hexdump TEXTPATTERN ...
ug -X -U BYTEPATTERN ... ug -X TEXTPATTERN ...
ug -W -U BYTEPATTERN ... ug -W TEXTPATTERN ...
--hexdump=4chC1 muestra 4 columnas hexadecimales sin una columna de caracteres c , sin espacio hexadecimal h y con una línea hexadecimal adicional C1 antes y después de una coincidencia.
Incluya archivos para buscar por tipos de archivos o "bytes mágicos" de archivos o exclúyalos con ^
ug -t TYPE PATTERN ... ug -t ^TYPE PATTERN ...
ug -M 'MAGIC' PATTERN ... ug -M '^MAGIC' PATTERN ...
Incluya archivos y directorios para buscar que coincidan con globs de estilo gitignore o exclúyalos con ^
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 ...
Incluya archivos para buscar por extensiones de nombre de archivo (sufijo) o excluyalos con ^ , una abreviatura de -g"*.EXT"
ug -O EXT PATTERN ... ug -O ^EXT PATTERN ...
Incluir archivos ocultos (dotfiles) y directorios para buscar (omitidos de forma predeterminada)
ug -. PATTERN ... ug -g'.*,.*/' PATTERN ...
especifique hidden en su .ugrep para buscar siempre archivos ocultos con ug .
Excluir archivos especificados por .gitignore, etc.
ug --ignore-files PATTERN ... ug --ignore-files=.ignore PATTERN ...
especifique ignore-files en su .ugrep para ignorarlos siempre con ug . Agregue ignore-files=... adicionales según lo desee.
Patrones de búsqueda excluyendo patrones negativos ("coincide con esto pero no con aquello")
ug -e PATTERN -N NOTPATTERN ... ug -e '[0-9]+' -N 123 ...
Utilice patrones de expresiones regulares predefinidos para buscar código fuente, javascript, XML, JSON, HTML, PHP, rebajas, etc.
ug PATTERN -f c++/zap_comments -f c++/zap_strings ...
ug PATTERN -f php/zap_html ...
ug -f js/functions ... | ug PATTERN ...
Ordene los archivos coincidentes por nombre, mejor coincidencia, tamaño y hora
ug --sort PATTERN ... ug --sort=size PATTERN ...
ug --sort=changed PATTERN ... ug --sort=created PATTERN ...
ug -Z --sort=best PATTERN ... ug --no-sort PATTERN ...
Resultados de salida en formatos CSV, JSON, XML y especificados por el usuario
ug --csv PATTERN ... ug --json PATTERN ...
ug --xml PATTERN ... ug --format='file=%f line=%n match=%O%~' PATTERN ...
ug --help format muestra ayuda sobre los campos % de formato para una salida personalizada.
Busque con patrones de expresiones regulares compatibles con Perl de PCRE y muestre o reemplace coincidencias de subpatrones
ug -P PATTERN ... ug -P --format='%1 and %2%~' 'PATTERN(SUB1)(SUB2)' ...
Reemplace los patrones en la salida con -P y --replace el texto de reemplazo, que opcionalmente contiene campos de formato % , usando -y para pasar el resto del archivo:
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 muestra ayuda sobre los campos de % de formato para usar opcionalmente con --replace .
Busque archivos con un formato de codificación específico como ISO-8859-1 a 16, CP 437, CP 850, MACROMAN, KOI8, etc.
ug --encoding=LATIN1 PATTERN ...
Instale el último ugrep con Homebrew:
$ brew install ugrep
o instalar con MacPorts:
$ sudo port install ugrep
Esto instala los comandos ugrep y ug , donde ug es lo mismo que ugrep pero también carga el archivo de configuración .ugrep cuando está presente en el directorio de trabajo o en el directorio de inicio.
Instalar con Winget winget install Genivia.ugrep
O instalar con Chocolatey choco install ugrep
O instalar con Scoop scoop install ugrep
O descargue el ejecutable ugrep.exe con todas las funciones como artefacto de lanzamiento desde https://github.com/Genivia/ugrep/releases. La versión comprimida contiene el binario principal ugrep.exe , así como ug.exe . El comando ug , diseñado para uso interactivo, carga y lee la configuración del archivo de configuración .ugrep (cuando está presente en el directorio de trabajo o en el directorio de inicio).
Agregue ugrep.exe y ug.exe a su ruta de ejecución: vaya a Configuración y busque "Ruta" en Buscar una configuración . Seleccione variables de entorno -> Ruta -> Nuevo y agregue el directorio donde colocó los ejecutables ugrep.exe y ug.exe .
Consejo
Consejos prácticos sobre el uso ugrep.exe y ug.exe en la línea de comandos de Windows:
' sino " en su lugar; la mayoría de las utilidades de comandos de Windows consideran las comillas simples ' parte del argumento de la línea de comandos.-g/GLOB en lugar de los argumentos habituales de la línea de comando GLOB para seleccionar archivos y directorios para buscar, especialmente para búsquedas recursivas;"" para que coincida con todas las entradas, algunos intérpretes de comandos de Windows, como Powershell, pueden ignorarlo; en ese caso, debe especificar la opción --match en su lugar;R en lugar de n para hacer coincidir cualquier nueva línea Unicode, como rn pares y r y n individuales. $ apk add ugrep ugrep-doc
Consulte https://pkgs.alpinelinux.org/packages?name=ugrep para obtener información sobre la versión.
$ pacman -S ugrep
Consulte https://archlinux.org/packages/extra/x86_64/ugrep para obtener información sobre la versión.
Primero habilite el repositorio EPEL, luego podrá instalar ugrep.
$ dnf install ugrep
Consulte https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ para obtener información sobre la versión.
$ apt-get install ugrep
Consulte https://packages.debian.org/ugrep para obtener información sobre la versión. Para compilar y probar ugrep localmente, consulte los pasos de compilación "Todas las plataformas" más adelante.
$ dnf install ugrep
Consulte https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ para obtener información sobre la versión.
$ pkg install ugrep
Consulte https://www.freshports.org/textproc/ugrep para obtener información sobre la versión.
$ pkgman install cmd:ugrep
Consulte https://github.com/haikuports/haikuports/tree/master/app-text/ugrep para obtener información sobre la versión. Para compilar y probar ugrep localmente, consulte los pasos de compilación "Todas las plataformas" más adelante.
Puede utilizar el instalador de paquetes estándar de NetBSD (pkgsrc): http://cdn.netbsd.org/pub/pkgsrc/current/pkgsrc/textproc/ugrep/README.html
$ pkg_add ugrep
Consulte https://openports.pl/path/sysutils/ugrep para obtener información sobre la versión.
$ zypper install ugrep
Consulte https://build.opensuse.org/package/show/utilities/ugrep para obtener información sobre la versión.
Primero habilite el repositorio EPEL, luego podrá instalar ugrep.
$ dnf install ugrep
Consulte https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ para obtener información sobre la versión.
Clonar ugrep con
$ git clone https://github.com/Genivia/ugrep
O visite https://github.com/Genivia/ugrep/releases para descargar una versión específica.
Siempre puedes agregarlos más tarde, cuando necesites estas características:
La opción -P (expresiones regulares de Perl) requiere la biblioteca PCRE2 (recomendada) o la biblioteca Boost.Regex (reserva opcional). Si PCRE2 no está instalado, instale PCRE2 con, por ejemplo, sudo apt-get install -y libpcre2-dev o descargue PCRE2 y siga las instrucciones de instalación. Alternativamente, descargue Boost.Regex y ejecute ./bootstrap.sh y sudo ./b2 --with-regex install . Consulte Boost: cómo empezar.
La opción -z (búsqueda de archivos comprimidos y archivos comprimidos) requiere la biblioteca zlib instalada. Está instalado en la mayoría de los sistemas. De lo contrario, instálelo, por ejemplo, con sudo apt-get install -y libz-dev . Para buscar archivos .bz y .bz2 , instale la biblioteca bzip2 (recomendado), por ejemplo, con sudo apt-get install -y libbz2-dev . Para buscar archivos .lzma y .xz , instale la biblioteca lzma (recomendado), por ejemplo, con sudo apt-get install -y liblzma-dev . Para buscar archivos .lz4 , instale la biblioteca lz4 (opcional, no requerida), por ejemplo, con sudo apt-get install -y liblz4-dev . Para buscar archivos .zst , instale la biblioteca zstd (opcional, no requerida), por ejemplo, con sudo apt-get install -y libzstd-dev . Para buscar archivos .br , instale la biblioteca brotli (opcional, no requerida), por ejemplo, con sudo apt-get install -y libbrotli-dev . Para buscar archivos .bz3 , instale la biblioteca bzip3 (opcional, no requerida), por ejemplo, con sudo apt-get install -y bzip3 .
Consejo
Incluso si su sistema tiene utilidades de línea de comandos, como bzip2 , eso no significa necesariamente que las bibliotecas de desarrollo como libbz2 estén instaladas. Las bibliotecas de desarrollo deben estar instaladas.
Es posible que algunos sistemas Linux no estén configurados para cargar bibliotecas dinámicas desde /usr/local/lib , lo que provoca un error de carga de biblioteca al ejecutar ugrep . Para corregir esto, agregue export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/usr/local/lib" a su archivo ~/.bashrc . O ejecute sudo ldconfig /usr/local/lib .
Ejecute el script ./build.sh para compilar ugrep :
$ cd ugrep
$ ./build.sh
Esto construye el ejecutable ugrep en el directorio ugrep/src con ./configure y make -j , verificado con make test . Cuando pasan todas las pruebas, el ejecutable ugrep se copia a ugrep/bin/ugrep y se agrega el enlace simbólico ugrep/bin/ug -> ugrep/bin/ugrep para el comando ug .
Tenga en cuenta que ug es lo mismo que ugrep pero también carga el archivo de configuración .ugrep cuando está presente en el directorio de trabajo o en el directorio de inicio. Esto significa que puede definir sus opciones predeterminadas para ug en .ugrep.
Se pueden especificar rutas alternativas a las bibliotecas locales o instaladas con ./build.sh . Para obtener ayuda sobre las opciones de compilación disponibles:
$ ./build.sh --help
Puede crear ejecutables estáticos especificando:
$ ./build.sh --enable-static
Esto puede fallar si las bibliotecas no se vinculan estáticamente, como brotli. En ese caso, intente ./build.sh --enable-static --without-brotli .
Puede crear ugrep con los valores predeterminados personalizados habilitados, como un buscapersonas:
$ ./build.sh --enable-pager
Las opciones para seleccionar valores predeterminados para compilaciones incluyen:
--help a mostrar opciones de compilación--enable-static construye ejecutables estáticos, si es posible--enable-hidden siempre busca archivos y directorios ocultos--enable-pager siempre usa un buscapersonas para mostrar la salida en los terminales--enable-pretty la salida a terminales y agregar encabezados de nombre de archivo--disable-auto-color deshabilita los colores automáticos, requiere la opción ugrep --color=auto para mostrar colores--disable-mmap deshabilita los archivos mapeados en memoria--disable-sse2 desactiva las optimizaciones SSE2 y AVX--disable-avx2 desactiva las optimizaciones AVX2 y AVX512BW, pero compila con SSE2 cuando sea compatible--disable-neon desactiva las optimizaciones ARM NEON/AArch64--with-grep-path la ruta -f predeterminada si GREP_PATH no está definido--with-grep-colors los colores predeterminados si GREP_COLORS no está definido Una vez completada la compilación, copie ugrep/bin/ugrep y ugrep/bin/ug en una ubicación conveniente, por ejemplo en su directorio ~/bin . O, si desea instalar los comandos y las páginas de manual ugrep y ug :
$ sudo make install
Esto también instala los archivos de patrones con patrones predefinidos para la opción -f en /usr/local/share/ugrep/patterns/ . La opción -f primero verifica el directorio de trabajo para detectar la presencia de archivos de patrón; si no se encuentran, verifica la variable de entorno GREP_PATH para cargar los archivos de patrón y, si no se encuentran, lee los archivos de patrón predefinidos instalados.
Desafortunadamente, los clones de git no conservan las marcas de tiempo, lo que significa que puede encontrarse con "ADVERTENCIA: falta 'aclocal-1.15' en su sistema". o que no se encontró el encabezado automático al ejecutar make .
Para solucionar este problema, ejecute:
$ autoreconf -fi
$ ./build.sh
GCC 8 y versiones posteriores pueden producir advertencias del tipo "nota: paso de parámetro para argumento... cambiado en GCC 7.1" . Estas advertencias deben ignorarse.
Se incluye un Dockerfile para compilar ugrep en un contenedor de Ubuntu.
Es posible que los desarrolladores deseen utilizar desinfectantes para verificar el código ugrep al realizar cambios significativos, por ejemplo, para detectar carreras de datos con ThreadSanitizer:
$ ./build.sh CXXFLAGS='-fsanitize=thread -O1 -g'
Verificamos ugrep con clang AddressSanitizer, MemorySanitizer, ThreadSanitizer y UndefinedBehaviorSanitizer. Estas opciones generan una sobrecarga de tiempo de ejecución significativa y no deben usarse para la compilación final.
? Volver a la tabla de contenidos
Tenga en cuenta que los comandos ugrep y ug buscan archivos binarios de forma predeterminada y no ignoran los archivos especificados .gitignore, lo que no hará que las comparaciones de rendimiento de búsqueda recursiva sean significativas a menos que se utilicen las opciones -I y --ignore-files . Para que estas opciones sean las predeterminadas para ug , simplemente agregue ignore-binary e ignore-files a su archivo de configuración .ugrep.
Para obtener una comparación de rendimiento actualizada de la última versión de ugrep, consulte los puntos de referencia de rendimiento de ugrep. Ugrep es más rápido que GNU grep, Silver Searcher, ack, sift. La velocidad de Ugrep supera a ripgrep en la mayoría de los puntos de referencia.
Primero, definamos el comando :grep en Vim para buscar archivos de forma recursiva. Para hacerlo, agregue las siguientes líneas a su .vimrc ubicado en el directorio raíz:
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
Esto especifica -j búsquedas que no distinguen entre mayúsculas y minúsculas con el comando Vim :grep . Para búsquedas que distingan entre mayúsculas y minúsculas, elimine -j de grepprg . Varias coincidencias en la misma línea se enumeran por separado en la ventana de corrección rápida. Si no lo desea, elimine -u de grepprg . Con este cambio, solo se muestra la primera coincidencia de una línea. La opción --ignore-files omite los archivos especificados en los archivos .gitignore , cuando están presentes. Para limitar la profundidad de las búsquedas recursivas solo al directorio actual, agregue -1 a grepprg .
Ahora puede invocar el comando Vim :grep en Vim para buscar archivos en una PATH especificada para coincidencias PATTERN :
:grep PATTERN [PATH]
Si omite PATH , se busca en el directorio de trabajo. Utilice % como PATH para buscar solo el archivo abierto actualmente en Vim:
:grep PATTERN %
El comando :grep muestra los resultados en una ventana de corrección rápida que le permite saltar rápidamente a las coincidencias encontradas.
Para abrir una ventana de corrección rápida con la lista más reciente de coincidencias:
:copen
Haga doble clic en una línea en esta ventana (o seleccione una línea y presione ENTRAR) para saltar al archivo y la ubicación en el archivo de la coincidencia. Ingrese los comandos :cn y :cp para saltar a la coincidencia anterior o siguiente, respectivamente. Para actualizar los resultados de la búsqueda en la ventana de corrección rápida, simplemente búsquelos. Por ejemplo, para buscar recursivamente el código fuente C++ marcado como FIXME en el directorio de trabajo:
:grep -tc++ FIXME
Para cerrar la ventana de corrección rápida:
:cclose
Puede usar las opciones de ugrep con el comando :grep , por ejemplo, para seleccionar comentarios de una o varias líneas en el archivo actual:
:grep -f c++/comments %
Para ahorrar espacio, solo se muestra la primera línea de un comentario de varias líneas en Quickfix. Para mostrar todas las líneas de una coincidencia de varias líneas, elimine %-G de grepformat .
Una herramienta Vim popular es ctrlp.vim, que se instala con:
$ cd ~/.vim
$ git clone https://github.com/kien/ctrlp.vim.git bundle/ctrlp.vim
CtrlP usa ugrep agregando las siguientes líneas a su .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
donde -I omite los archivos binarios, la opción --ignore-files omite los archivos especificados en los archivos .gitignore , cuando están presentes, y la opción -3 restringe la búsqueda de directorios a tres niveles (el directorio de trabajo y hasta dos niveles inferiores).
Inicie Vim y luego ingrese el comando:
:helptags ~/.vim/bundle/ctrlp.vim/doc
Para ver la documentación de CtrlP en Vim, ingrese el comando:
:help ctrlp.txt
? Volver a la tabla de contenidos
Gracias a Manuel Uberti, ahora puedes usar ugrep en Emacs. Para usar ugrep en lugar de GNU grep dentro de Emacs, agregue la siguiente línea a su archivo .emacs.d/init.el :
(setq-default xref-search-program ‘ugrep)
Esto significa que los comandos de Emacs como project-find-regexp que dependen de Xref ahora pueden aprovechar el poder de ugrep .
Además, es posible utilizar grep en los comandos grep de Emacs. Por ejemplo, puedes ejecutar lgrep con ugrep personalizando grep-template con algo como lo siguiente:
(setq-default grep-template "ugrep --color=always -0Iinr -e <R>")
Si no tiene la versión 29 (o superior) de Emacs, puede descargar y compilar Emacs desde la rama maestra de Emacs o habilitar la integración de Xref con ugrep manualmente:
(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))
? Volver a la tabla de contenidos
Ugrep listo para usar admite todas las opciones de línea de comandos grep estándar de GNU/BSD y también mejora muchas de ellas. Para obtener más información, consulte las mejoras notables con respecto a grep.
Si desea ceñirse exactamente a los patrones Unicode no UTF de GNU/BSD grep ASCII/LATIN1, use la opción -U para deshabilitar la coincidencia completa de patrones Unicode.
De hecho, ejecutar ugrep con las opciones -U , -Y , -. y --sort hace que se comporte exactamente como egrep , haciendo coincidir solo patrones Unicode ASCII/LATIN1 no UTF, permitiendo que patrones vacíos coincidan y busquen archivos ocultos en lugar de ignorarlos, respectivamente. Ver equivalencia grep.
Puede crear alias grep convenientes con o sin opciones -U , -Y , -. y --sort o incluir otras opciones según se desee.
O puede crear ejecutables grep , egrep y fgrep copiando ugrep con esos nombres. Cuando el ejecutable ugrep (o ugrep.exe ) se copia como grep ( grep.exe ), egrep ( egrep.exe ), fgrep ( fgrep.exe ), luego las opciones -U , -Y y -. se habilitan automáticamente junto con -G para grep , -E para egrep y -F para fgrep . Además, cuando se copia como zgrep , zegrep y zfgrep , la opción -z está habilitada. Por ejemplo, cuando ugrep se copia como zegrep , las opciones -z , -E , -Y , -. y --sort están habilitados.
Del mismo modo, los enlaces simbólicos y físicos a ugrep también funcionan bien para crear reemplazos grep , egrep y fgrep . Por ejemplo, para crear un enlace simbólico egrep :
sudo ln -s `which ugrep` /opt/local/bin/egrep
El /opt/local/bin es solo un ejemplo y puede o no estar en su $path y puede encontrarse o no al ejecutar egrep dependiendo de su $path .
ugrep es equivalente a grep GNU/BSD cuando se utilizan las siguientes opciones:
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
dónde:
-U deshabilita la coincidencia de patrones Unicode de caracteres anchos, por lo que, por ejemplo, el patrón xa3 coincide con el byte A3 en lugar del punto de código Unicode U+00A3 representado por la secuencia UTF-8 C2 A3. De forma predeterminada en ugrep, xa3 coincide con U+00A3. No recomendamos usar -U para búsquedas de patrones de texto, solo para búsquedas binarias o para buscar archivos latin-1 (iso-8859-1) sin informar estos archivos como binarios (desde ugrep v3.5.0).-Y habilita coincidencias vacías, por lo que, por ejemplo, el patrón a* coincide con cada línea en lugar de una secuencia de a . De forma predeterminada en ugrep, el patrón a* coincide con una secuencia de a . Además, en ugrep el patrón a*b*c* coincide con lo que se supone que debe coincidir de forma predeterminada. Ver mejoras.-. busca archivos ocultos (archivos de puntos). De forma predeterminada, los archivos ocultos se ignoran, como la mayoría de las utilidades de Unix.--sort especifica la salida ordenada por nombre de ruta, mostrando primero los archivos coincidentes ordenados seguidos de coincidencias recursivas ordenadas en los subdirectorios. De lo contrario, los archivos coincidentes se informan sin ningún orden en particular para mejorar el rendimiento;-Dread y -dread son los valores predeterminados de GNU/BSD grep pero no se recomiendan; consulte las mejoras para obtener una explicación.? Volver a la tabla de contenidos
Alias comúnmente utilizados para agregar a .bashrc para aumentar la productividad:
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)
? Volver a la tabla de contenidos
-Q .n .-U ).--bool ).--ignore-files .-Z .-z .-z .-z y --zmax=NUM hasta NUM niveles de profundidad.--filter utilizando utilidades de conversión de formatos de terceros como complementos.-r para buscar directorios de forma recursiva.-. ).-E como egrep, mientras que -G habilita BRE).-J1 ).-W (genera coincidencias binarias en hexadecimal con coincidencias de texto como de costumbre) y -X (genera todas las coincidencias en hexadecimal).--format ).-f usa la variable de entorno GREP_PATH o los patrones predefinidos instalados en /usr/local/share/ugrep/patterns . Si se especifica -f y también se especifican uno o más patrones -e , las opciones -F , -x y -w no se aplican a los patrones -f . Esto es para evitar confusiones cuando -f se usa con patrones predefinidos que tal vez ya no funcionen correctamente con estas opciones.-O , -M y -t especifican extensiones de archivo, patrones de bytes mágicos de firma de archivo y tipos de archivo predefinidos, respectivamente. Esto permite buscar ciertos tipos de archivos en árboles de directorios, por ejemplo con las opciones de búsqueda recursivas -R y -r . Las opciones -O , -M y -t también se aplican a archivos archivados en archivos cpio, jar, pax, tar, zip y 7z.-k , --column-number para mostrar el número de columna, teniendo en cuenta el espacio entre tabulaciones al expandir las pestañas, como se especifica en la opción --tabs .-P (expresiones regulares de Perl) admite referencias inversas (con --format ) y búsquedas atrás, que utiliza la biblioteca PCRE2 o Boost.Regex para una rápida coincidencia de expresiones regulares de Perl con una sintaxis similar a PCRE.-b con la opción -o o con la opción -u , ugrep muestra el desplazamiento de bytes exacto de la coincidencia del patrón en lugar del desplazamiento de bytes del inicio de la línea coincidente informada por GNU/BSD grep.-u , --ungroup para no agrupar varias coincidencias por línea. Esta opción muestra nuevamente una línea de entrada coincidente para cada coincidencia de patrón adicional en la línea. Esta opción es particularmente útil con la opción -c para informar el número total de coincidencias de patrones por archivo en lugar del número de líneas coincidentes por archivo.-Y permite hacer coincidir patrones vacíos. Hacer grep con patrones de coincidencias vacías es extraño y da resultados diferentes con GNU grep versus BSD grep. Ugrep no genera coincidencias vacías de forma predeterminada, lo que evita cometer errores que pueden producir resultados "aleatorios". Por ejemplo, con GNU/BSD grep, el patrón a* coincide con cada línea de la entrada y, de hecho, coincide con xyz tres veces (las transiciones vacías antes y entre x , y y z ). Permitir coincidencias vacías requiere la opción ugrep -Y . Los patrones que comienzan con ^ o terminan con $ , como ^h*$ , coinciden con espacios vacíos. Estos patrones habilitan automáticamente la opción -Y .-D, --devices=ACTION se skip de forma predeterminada, en lugar de read . Esto evita que se bloqueen inesperadamente canalizaciones con nombre en directorios que se buscan recursivamente, como puede suceder con GNU/BSD grep que read dispositivos de forma predeterminada.-d, --directories=ACTION se skip de forma predeterminada, en lugar de read . De forma predeterminada, se buscan los directorios especificados en la línea de comando, pero no de forma recursiva en los subdirectorios.-N PATTERN , que son patrones de la forma (?^X) que omiten todas las entradas X , eliminando así X de la búsqueda. Por ejemplo, se pueden utilizar patrones negativos para omitir cadenas y comentarios al buscar identificadores en el código fuente y encontrar coincidencias que no están en cadenas y comentarios. Los patrones zap predefinidos usan patrones negativos; por ejemplo, use -f cpp/zap_comments para ignorar las coincidencias de patrones en los comentarios de C++.GREP_OPTIONS , porque el comportamiento de ugrep debe ser portátil y predecible en todos los sistemas. También GNU grep abandonó GREP_OPTIONS por este motivo. Utilice el comando ug que carga el archivo de configuración .ugrep ubicado en el directorio de trabajo o en el directorio de inicio cuando esté presente, o utilice alias de shell para crear nuevos comandos con opciones de búsqueda específicas.? Volver a la tabla de contenidos
Para realizar una búsqueda utilizando un archivo de configuración .ugrep colocado en el directorio de trabajo o en el directorio de inicio (tenga en cuenta que ug es lo mismo que ugrep --config ):
ug PATTERN FILE...
Para guardar un archivo de configuración .ugrep en el directorio de trabajo, edite este archivo en su directorio de inicio para personalizar sus preferencias para los valores predeterminados ug :
ug --save-config
Para buscar main en el directorio de trabajo y de forma recursiva más profunda (tenga en cuenta que -r enlaces simbólicos recursivos está habilitado de forma predeterminada si no se especifican argumentos de archivo):
ug main
Lo mismo, pero solo busca archivos de código fuente C++ de forma recursiva, ignorando todos los demás archivos:
ug -tc++ main
Lo mismo, usando la consulta interactiva TUI, comenzando con el patrón de búsqueda inicial main (tenga en cuenta que -Q con un patrón inicial requiere la opción -e porque los patrones normalmente se especifican de forma interactiva y todos los argumentos de la línea de comando se consideran archivos/directorios):
ug -Q -tc++ -e main
Para buscar #define (y # define etc.) usando un patrón de expresiones regulares en archivos C++ (tenga en cuenta que los patrones deben citarse para evitar que el shell incluya * y ? ):
ug -tc++ '#[t ]*define'
Para buscar main como palabra ( -w ) de forma recursiva sin seguir enlaces simbólicos ( -r ) en el directorio myproject , mostrando los números de línea ( -n ) y columna ( -k ) coincidentes junto a las líneas coincidentes:
ug -r -nkw main myproject
Lo mismo, pero solo busca myproject sin recurrir más profundamente (tenga en cuenta que los argumentos del directorio se buscan en un nivel de forma predeterminada):
ug -nkw main myproject
Lo mismo, pero busque myproject y un nivel de subdirectorio más profundo (dos niveles) con -2 :
ug -2 -nkw main myproject
Lo mismo, pero solo busca archivos C++ en myproject y sus subdirectorios con -tc++ :
ug -tc++ -2 -nkw main myproject
Lo mismo, pero también busca dentro de archivos (por ejemplo, archivos zip y tar) y archivos comprimidos con -z :
ug -z -tc++ -2 -nkw main myproject
Busque recursivamente main en el directorio de trabajo mientras ignora los archivos ignorados por git (por ejemplo, asumiendo que .gitignore está en el directorio de trabajo o debajo):
ug --ignore-files -tc++ -nkw main
Para enumerar todos los archivos en el directorio de trabajo y en niveles más profundos que no son ignorados por los archivos .gitignore :
ug --ignore-files -l ''
Para mostrar la lista de extensiones de nombre de archivo y "bytes mágicos" (shebangs) que se buscan correspondientes a los argumentos -t :
ug -tlist
Para enumerar todos los archivos de shell de forma recursiva, según las extensiones y los shebangs con -l (tenga en cuenta que '' coincide con cualquier archivo que no esté vacío):
ug -l -tShell ''
? Volver a la tabla de contenidos
Para buscar main en el código fuente mientras se ignoran cadenas y bloques de comentarios, puede usar patrones negativos con la opción -N para omitir coincidencias no deseadas en cadenas entre comillas y bloques de comentarios de C/C++:
ug -r -nkw -e 'main' -N '"(\.|\r?n|[^\n"])*"|//.*|/*(.*n)*?.**+/' myproject
¡Es mucho trabajo escribirlo correctamente! Si eres como yo, no quiero perder tiempo jugueteando con patrones de expresiones regulares cuando estoy trabajando en algo más importante. Hay una manera más fácil utilizando los patrones predefinidos de UGREP ( -f ) que se instalan con la herramienta ugrep :
ug -r -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
Esta consulta también busca otros archivos del código fuente C/C ++, como Readmes, Makefiles, etc. También nos saltamos los enlaces simbólicos con -r . Entonces, refinemos esta consulta seleccionando archivos C/C ++ solo usando opción -tc,c++ e incluir enlaces de simulación a archivos y directorios con -R :
ug -R -tc,c++ -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
¿Qué pasa si solo desea buscar el identificador main pero no como una función main( ? En este caso, use un patrón negativo para que esto se saltea mainh*( coincidencias de patrones:
ug -R -tc,c++ -nkw -e 'main' -N 'mainh*(' -f c/zap_strings -f c/zap_comments myproject
Esto utiliza las opciones -e y -N para especificar explícitamente un patrón y un patrón negativo, respectivamente, que esencialmente está formando el patrón main|(?^mainh*() , donde h coincide con el espacio y la pestaña en general. Los patrones negativos son útiles para filtrar coincidencias de patrones que no nos interesa.
Como otro ejemplo, supongamos que podemos buscar la palabra FIXME en bloques de comentarios c/c ++. Para hacerlo, primero podemos seleccionar los bloques de comentarios con el patrón de c/comments predefinidos de UGREP y luego seleccionar líneas con FIXME usando una tubería:
ug -R -tc,c++ -nk -f c/comments myproject | ug -w 'FIXME'
Filtrar los resultados con las tuberías es generalmente más fácil que usar y o la lógica o la lógica que usan algunas herramientas de búsqueda. Este enfoque sigue el espíritu Unix para mantener los servicios públicos simples y usarlas en combinación para tareas más complejas.
Produciremos una lista ordenada de todos los identificadores que se encuentran en el código fuente de Java mientras se omite las cuerdas y los comentarios:
ug -R -tjava -f java/names myproject | sort -u
Esto coincide con los identificadores de Java Unicode utilizando el Regex p{JavaIdentifierStart}p{JavaIdentifierPart}* definido en patterns/java/names .
Con GREP tradicionales y herramientas similares a GREP, se necesita un gran esfuerzo para buscar recursivamente el archivo fuente de C/C ++ que define la función qsort , que requiere algo como esto:
ug -R --include='*.c' --include='*.cpp' '^([ t]*[[:word:]:*&]+)+[ t]+qsort[ t]*([^;n]+$' myproject
Afortunadamente, con UGREP podemos simplemente seleccionar todas las definiciones de funciones en archivos con extensión .c o .cpp utilizando opción -Oc,cpp y utilizando un functions predefinido que se instala con la herramienta para producir todas las definiciones de funciones. Luego seleccionamos el que queremos:
ug -R -Oc,cpp -nk -f c/functions | ug 'qsort'
Tenga en cuenta que podríamos haber usado -tc,c++ para seleccionar archivos C/C ++, pero esto también incluye archivos de encabezado cuando solo queremos buscar archivos .c y .cpp .
También podemos omitir archivos y directorios de que se busque que se definan en .gitignore . Para hacerlo, usamos --ignore-files para excluir cualquier archivo y directorios de búsquedas recursivas que coincidan con los globos en .gitignore , cuando se encuentran uno o más archivos .gitignore :
ug -R -tc++ --ignore-files -f c++/defines
Esto busca archivos C ++ ( -tc++ ) en el directorio de trabajo para #define Lines ( -f c++/defines ), mientras se omite archivos y directorios declarados en .gitignore . Si encuentra esto demasiado largo para escribir, defina un alias para buscar directorios de GitHub:
alias ugit='ugrep -R --ignore-files'
ugit -tc++ -f c++/defines
Para resaltar las coincidencias cuando se empujamos a través de una cadena de tuberías que deberíamos usar --color=always :
ugit --color=always -tc++ -f c++/defines | ugrep -w 'FOO.*'
Esto devuelve una lista iluminada de color de todos #define FOO... macros en archivos de código fuente C/C ++, omitiendo archivos definidos en .gitignore .
Tenga en cuenta que el complemento de --exclude no es --include , porque las exclusiones siempre tienen prioridad sobre las inclusiones, por lo que no podemos enumerar de manera confiable los archivos que se ignoran con --include-from='.gitignore' . Solo se visitan los archivos explícitamente especificados con --include y directorios explícitamente especificados con --include-dir . El --include-from de las listas de globos que se consideran archivos y directorios para agregar a --include y --include-dir , respectivamente. Esto significa que cuando los nombres de los directores y las rutas de directorio no se enumeran explícitamente en este archivo, no se visitará usando --include-from .
Debido a que UGREP verifica si la entrada es válida unicode codificada con UTF (a menos que se use -U ), es posible usarla como un filtro para ignorar la salida no UTF producida por un programa:
program | ugrep -I ''
Si el programa produce una salida válida, la salida se pasa, de lo contrario, la salida se filtra opción -I . Si la salida es inicialmente válida para una porción muy grande, pero es seguido por una salida no válida, entonces UGREP puede mostrar inicialmente la salida hasta pero excluyendo la salida no válida después de la cual se bloquea una salida adicional.
Para filtrar líneas que están codificadas por ASCII o UTF, al tiempo que eliminan líneas que no son:
program | ugrep '[p{Unicode}--[n]]+'
Tenga en cuenta que p{Unicode} coincide n ¡pero no queremos coincidir con todo el archivo! Solo líneas con [p{Unicode}--[n]]+ .
? Volver a la tabla de contenido
La página del hombre de Ugrep:
man ugrep
Para mostrar una página de ayuda:
ug --help
Para mostrar opciones que mencionan WHAT :
ug --help WHAT
Para mostrar una lista de valores de opción de -t TYPES :
ug -tlist
En la consulta interactiva TUI, presione F1 o CTRL-Z para obtener ayuda y opciones:
ug -Q
? Volver a la tabla de contenido
--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.
El comando ug está destinado a la búsqueda interactiva dependiente del contexto y es equivalente al comando ugrep --config para cargar el archivo de configuración .ugrep cuando está presente en el directorio de trabajo o, cuando no se encuentra, en el directorio de inicio:
ug PATTERN ...
ugrep --config PATTERN ...
El comando ug también clasifica los archivos por nombre por directorio buscado. Un archivo de configuración contiene NAME=VALUE por línea, donde NAME es el nombre de una opción larga (sin -- ) y =VALUE es un argumento, que es opcional y puede omitirse dependiendo de la opción. Se ignoran las líneas y líneas vacías que comienzan con un # :
# 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
Las opciones de línea de comandos se analizan en el siguiente orden: primero se carga el archivo de configuración (predeterminado o nombrado), luego se analizan las opciones y argumentos restantes en la línea de comando.
Opción: --stats muestra el archivo de configuración utilizado después de buscar.
Los archivos de configuración nombrados están destinados a optimizar las tareas de búsqueda personalizadas, reduciendo el número de opciones de línea de comando a solo uno ---FILE para usar la recopilación de opciones especificadas en FILE . La opción --config=FILE y su formulario abreviado ---FILE Cargue el archivo de configuración especificado ubicado en el directorio de trabajo o, cuando no se encuentra, ubicado en el directorio de inicio:
ug ---FILE PATTERN ...
ugrep ---FILE PATTERN ...
Se produce un error cuando FILE no se encuentra o no se puede leer.
Los archivos de configuración nombrados se pueden usar para definir una colección de opciones que son específicas de los requisitos de una tarea en el flujo de trabajo de desarrollo de un proyecto. Por ejemplo, para informar problemas no resueltos controlando el código fuente y la documentación de los comentarios con los elementos FixMe y TODO. Tal archivo de configuración con nombre se puede localizar en un proyecto colocándolo en el directorio del proyecto, o se puede hacer global colocándolo en el directorio de inicio. Para la retroalimentación visual, se puede especificar un esquema de color específico para esta tarea con colors de opción en el FILE de configuración para ayudar a identificar la salida producida por una configuración con nombre en lugar de la configuración predeterminada.
La opción --save-config guarda un archivo de configuración .ugrep en el directorio de trabajo utilizando la configuración actual cargada con --config . Esto guarda la configuración actual combinada con opciones adicionales cuando también se especifica. Solo aquellas opciones que no pueden entrar en conflicto con otras opciones y opciones que no pueden afectar negativamente los resultados de búsqueda se guardarán.
La opción --save-config=FILE guarda la configuración en el FILE especificado. La configuración se escribe en salida estándar cuando FILE es a - .
Alternativamente, un archivo de configuración puede ser creado o modificado manualmente. Un archivo de configuración puede incluir una o más config[=FILE] para cargar indirectamente el FILE especfificado, pero la carga de configuración recursiva está prohibida. La forma más sencilla de crear un archivo de configuración es especificar config en la parte superior del archivo, seguido de las largas opciones para anular los valores predeterminados.
? Volver a la tabla de contenido
-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.
Esta opción inicia una interfaz de usuario para ingresar patrones de búsqueda de manera interactiva:
-c para contar las coincidencias. Presionando alt -c nuevamente deshabilita -c . Las opciones se pueden alternar con la tecla ALT mientras se busca o al ver la pantalla de ayuda. Si no se admiten Alt/Meta Keys (por ejemplo, x11 xterm), presione CTRL-O seguido de la tecla correspondiente a la opción.-g y las globas de coincidencia de directorio, una lista separada por comas de patrones de globas de estilo Gitignore. Presionar ESC devuelve el control a la solicitud del patrón de consulta (se guardan los globos). Cuando un globo es precedido por A ! o a ^ , omita los archivos cuyo nombre coincide con el globo cuando un globo contiene A / , los nombres de ruta completos coinciden. De lo contrario, los nombres de base se combinan. Cuando un globo termina con A / , los directorios coinciden.Q> (normal), F> (cadenas fijas), G> (regex básica), P> (coincidencia de perl) y Z> (coincidencia difusa). Cuando se muestra el --glob= Avecute, se puede ingresar una lista separada por comas de patrones de globas de estilo Gitignore. Presionar ESC devuelve el control al indicador del patrón.--view .--view=COMMAND . De lo contrario, las variables de entorno PAGER o EDITOR se utilizan para invocar el comando con CTRL-Y. Los nombres de archivo deben estar habilitados y visibles en la salida para usar esta función.--color .DELAY bajo como 1. Sin embargo, los valores más bajos pueden aumentar la carga del sistema como resultado de iniciar y cancelar repetidamente las búsquedas por cada tecla presionada.--heading está habilitada de forma predeterminada. Presione Alt-+ para apagar los encabezados.Consulta TUI Mapeo de teclas:
| llaves) | función |
|---|---|
Alt-key | alternar la opción de línea de comandos UGREP correspondiente a key |
Alt-/ xxxx / | Insertar el punto de código HEX UNICODE U+xxxx |
Esc Ctrl-C | Volver o salir |
Ctrl-Q | Salida rápida y salida Los resultados seleccionados en el modo de selección |
Tab | CHDIR al directorio del archivo que se muestra en la parte superior de la pantalla o seleccione el archivo |
Shift-Tab | Chdir un nivel de nivel o deseleccionar |
Enter | Ingrese el modo de selección y altere las líneas seleccionadas para salir al salir |
Up Ctrl-P | subir |
Down Ctrl-N | bajar |
Ctrl-B Left | moverse a la izquierda |
Ctrl-F Right | moverse a la derecha |
PgUp Ctrl-G | Mover la pantalla por una página |
PgDn Ctrl-D | Mover la pantalla hacia abajo por una página |
Alt-Up | Mueva la visualización por 1/2 página ( Shift-Up macOS) |
Alt-Down | Mueva la pantalla hacia abajo por 1/2 página (MacOS Shift-Down ) |
Alt-Left | Mueva la pantalla izquierda por 1/2 página (macOS Shift-Left ) |
Alt-Right | Mueva la pantalla directamente por 1/2 página (MacOS Shift-Right ) |
Home Ctrl-A | Mover el cursor al comienzo de la línea |
End Ctrl-E | Mueva el cursor al final de la línea |
Ctrl-K | Eliminar después del cursor |
Ctrl-L | pantalla de actualización |
Ctrl-O + key | Termine la opción de línea de comandos UGREP correspondiente a key , igual que Alt-key |
Ctrl-R F4 | saltar al marcador |
Ctrl-S | Saltar al siguiente dir/archivo/contexto |
Ctrl-T F5 | Pantalla dividida de toggle ( --split inicia un TUI de pantalla dividida) |
Ctrl-U | Eliminar antes del cursor |
Ctrl-V | carácter literal |
Ctrl-W | Sube a un dir/archivo/contexto |
Ctrl-X F3 | Establecer marcador |
Ctrl-Y F2 | Ver o editar el archivo que se muestra en la parte superior de la pantalla |
Ctrl-Z F1 | Ver ayuda y opciones |
Ctrl-^ | Chdir de vuelta al directorio de trabajo inicial |
Ctrl-] | alternar color/mono |
Ctrl- | proceso final |
Para buscar interactivamente los archivos en el directorio de trabajo y a continuación:
ug -Q
Lo mismo, pero restringido solo a archivos C ++ e ignorando los archivos .gitignore :
ug -Q -tc++ --ignore-files
Para buscar interactivamente todos los muelles en el directorio de trabajo y a continuación:
ug -Q -g 'Makefile*' -g 'makefile*'
Lo mismo, pero para hasta 2 niveles de directorio (trabajo y un nivel de subdirectorio):
ug -Q -2 -g 'Makefile*' -g 'makefile*'
Para ver interactivamente el contenido de main.cpp y buscarlo, donde -y muestra cualquier línea no coincidente como contexto:
ug -Q -y main.cpp
Para buscar interactivamente main.cpp , comenzando con el patrón de búsqueda TODO y un contexto de coincidencia de 5 líneas (el contexto se puede habilitar y deshabilitar interactivamente, esto también anula el tamaño de contexto predeterminado de 2 líneas):
ug -Q -C5 -e TODO main.cpp
Para ver y buscar el contenido de un archivo (por ejemplo, zip, tarball):
ug -Q -z archive.tar.gz
Para seleccionar interactivamente archivos de project.zip para descomprimir con unzip , utilizando el modo de selección de consultas UGREP (presione Entrar para seleccionar líneas):
unzip project.zip `zipinfo -1 project.zip | ugrep -Q`
? Volver a la tabla de contenido
-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.
Si no se especifican argumentos de archivo y se lee la entrada desde un terminal, las búsquedas recursivas se realizan como si se especifica -r . Para forzar la lectura de la entrada estándar, especifique - como argumento del archivo.
Para enumerar recursivamente todos los archivos no vacíos en el directorio de trabajo:
ug -r -l ''
Para enumerar todos los archivos no vacíos en el directorio de trabajo pero no más profundo (ya que se da un argumento de archivo, en este caso . Para el directorio de trabajo):
ug -l '' .
Para enumerar todos los archivos no vacíos en el directorio mydir pero no más profundo (ya que se da un argumento de archivo):
ug -l '' mydir
Para enumerar todos los archivos no vacíos en el directorio mydir y más profundo mientras sigue los enlaces simbólicos:
ug -R -l '' mydir
Para enumerar recursivamente todos los archivos no vacíos en la ruta especificada, mientras visitan solo subdirectorios, es decir, los directorios mydir/ y los subdirectorios en un nivel más profundo mydir/*/ se visitan (tenga en cuenta que -2 -l se puede abreviar a -l2 ):
ug -2 -l '' mydir
Para enumerar recursivamente todos los archivos no vacíos en el directorio mydir , no seguir ningún enlace simbólico (excepto cuando está en la línea de comando como mydir ):
ug -rl '' mydir
Para enumerar recursivamente todos los makefiles que coinciden con el texto CPP :
ug -l -tmake 'CPP'
Para enumerar recursivamente todo Makefile.* bin_PROGRAMS coincidente:
ug -l -g'Makefile.*' 'bin_PROGRAMS'
Para enumerar recursivamente todos los archivos no vacíos con extensión .sh, con -Osh :
ug -l -Osh ''
Para enumerar recursivamente todos los scripts de shell basados en extensiones y shebangs con -tShell :
ug -l -tShell ''
Para enumerar recursivamente todos los scripts de shell basados solo en extensiones con -tshell :
ug -l -tshell ''
? Volver a la tabla de contenido
--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.
Tenga en cuenta que las opciones --and , --not , y --andnot requieren -e PATTERN .
La opción -% hace todos los patrones basados en booleanos, lo que respalda las siguientes operaciones lógicas enumeradas desde el nivel más alto de precedencia hasta el más bajo:
| operador | alternativa | resultado |
|---|---|---|
"x" | coincidir x literalmente y exactamente como se especifica (utilizando los escapes de regex estándar Q y E ) | |
( ) | Agrupación de expresión booleana | |
-x | NOT x | partido invertido, coincidencias de IE si x no coincide |
x|y | x OR y | coincide con líneas con x o y |
xy | x AND y | coincide con líneas con x e y |
x e y son subpaterarios que no comienzan con los símbolos especiales | , - , y ( (use citas o un escape para que coincida con estos);
- NOT son iguales y tome prioridad OR , lo que significa que -x|y == (-x)|y por ejemplo.
| y OR son los mismos y tomar prioridad AND , lo que significa que xy|z == x (y|z) por ejemplo;
La opción --stats muestra las consultas booleanas en forma legible por humanos convertidos en CNF (forma normal conjuntiva), después de completar la búsqueda. Para mostrar el CNF sin una búsqueda, lea desde la entrada estándar terminado por un EOF, como echo | ugrep -% '...' --stats .
Los subpaterarios están iluminados en el color en la salida, excepto los negados con NOT (un subpatrón NOT puede aparecer en una línea coincidente cuando se usa un patrón OR como x|-y ). Tenga en cuenta que los subpaterarios pueden superponerse. En ese caso, solo el primer subpatrón coincidente está a la altura del color.
Se pueden combinar varias líneas cuando los subpaterarios coinciden con nuevas líneas. Sin embargo, hay una excepción: los subpaterarios que terminan con (?=X) LookAheads puede no coincidir cuando X abarca múltiples líneas.
Los patrones vacíos coinciden con cualquier línea (estándar GREP). Por lo tanto, -% 'x|""|y' coincide con todo y x e y no están altos de color. La opción -y debe usarse para mostrar cada línea como contexto, por ejemplo -y 'x|y' .
Consulta interactiva similar a FZF (búsqueda booleana con cadenas fijas con coincidencia difusa para permitir, por ejemplo, hasta 4 caracteres adicionales coincidentes con -Z+4 en palabras con -w ), presione la pestaña y alt -y para ver un archivo con coincidencias. Presione Shift-Tab y Alt-L para volver a la lista de archivos coincidentes:
ug -Q -%% -l -w -F -Z+4 --sort=best
Para encontrar recursivamente todos los archivos que contienen tanto hot como dog en cualquier lugar del archivo con la opción --files :
ug -%% 'hot dog'
ug --files -e hot --and dog
Para encontrar líneas que contienen tanto hot como dog en myfile.txt :
ug -% 'hot dog' myfile.txt
ug -e hot --and dog myfile.txt
Para encontrar líneas que contengan place y luego también hotdog o taco (o ambos) en myfile.txt :
ug -% 'hotdog|taco place' myfile.txt
ug -e hotdog -e taco --and place myfile.txt
Lo mismo, pero excluye líneas a juego de diner :
ug -% 'hotdog|taco place -diner' myfile.txt
ug -e hotdog -e taco --and place --andnot diner myfile.txt
Para encontrar líneas con diner o líneas que coincidan tanto fast como en food , pero no bad en myfile.txt :
ug -% 'diner|(fast food -bad)' myfile.txt
Para encontrar líneas con fast food (exactamente) o líneas con diner , pero no bad o old en myfile.txt :
ug -% '"fast food"|diner -bad -old' myfile.txt
Lo mismo, pero usando una expresión booleana diferente que tiene el mismo significado:
ug -% '"fast food"|diner -(bad|old)' myfile.txt
Para encontrar líneas con diner lo que implica good en myfile.txt (es decir, exhibir las líneas con good sin diner y líneas de espectáculos con diner pero solo aquellos con good , lo cual está lógicamente implícito):
ug -% 'good|-diner' myfile.txt
ug -e good --not diner myfile.txt
Para encontrar líneas con foo y -bar y "baz" en myfile.txt (no eso - " debe coincidir con escapes y con --and -e -bar ):
ug -% 'foo -bar "baz"' myfile.txt
ug -e foo --and -e -bar --and '"baz"' myfile.txt
Para buscar myfile.cpp para líneas con TODO o FIXME pero no ambos en la misma línea, como Xor:
ug -% 'TODO|FIXME -(TODO FIXME)' myfile.cpp
ug -e TODO -e FIXME --and --not TODO --not FIXME myfile.cpp
? Volver a la tabla de contenido
-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 $.
Consulte también Patrones de consulta booleana con -%, -%%, -y, -No para opciones de consulta booleana más potentes que las opciones tradicionales de GNU/BSD GREP.
Para mostrar líneas en el archivo myfile.sh pero no las líneas que coinciden ^[ t]*# :
ug -v '^[ t]*#' myfile.sh
Para buscar myfile.cpp para líneas con FIXME y urgent , pero no Scotty :
ugrep FIXME myfile.cpp | ugrep urgent | ugrep -v Scotty
Lo mismo, pero usando -% para consultas booleanas:
ug -% 'FIXME urgent -Scotty' myfile.cpp
Para buscar decimales usando el patrón d+ que no comienzan con 0 usando el patrón negativo 0d+ y excluyendo 555 :
ug -e 'd+' -N '0d+' -N 555 myfile.cpp
Para buscar palabras que comiencen con disp sin coincidir con display en el archivo myfile.py utilizando un "patrón negativo" -N '/<display>' donde -N especifica un patrón negativo adicional para omitir las coincidencias:
ug -e '<disp' -N '<display>' myfile.py
Para buscar líneas con la display de palabras en el archivo myfile.py omitiendo esta palabra en cadenas y comentarios, donde -f especifica patrones en archivos que son patrones predefinidos en este caso:
ug -n -w 'display' -f python/zap_strings -f python/zap_comments myfile.py
Para mostrar líneas que no son líneas en blanco:
ug -x -e '.*' -N 'h*' myfile.py
Lo mismo, pero usando -v y -x con h* , es decir, patrón ^h*$ :
ug -v -x 'h*' myfile.py
Para enumerar recursivamente todos los archivos de Python que no contienen la display de la palabra, lo que permite que la palabra ocurra en cadenas y comentarios:
ug -RL -tPython -w 'display' -f python/zap_strings -f python/zap_comments
? Volver a la tabla de contenido
--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.)
Los archivos binarios, ASCII y UTF-8 no requieren esta opción para buscarlos. Además, los archivos UTF-16 y UTF-32 no requieren esta opción para buscarlos, suponiendo que los archivos UTF-16 y UTF-32 comiencen con un UTF BOM (marca de pedido de bytes) como de costumbre. Otras codificaciones de archivos requieren la opción --encoding=ENCODING :
| codificación | parámetro |
|---|---|
| ASCII | n / A |
| UTF-8 | n / A |
| UTF-16 con Bom | n / A |
| UTF-32 con BOM | n / A |
| UTF-16 no nació | UTF-16 o UTF-16BE |
| UTF-16 LE W/O Bom | UTF-16LE |
| UTF-32 sin nacimiento | UTF-32 o UTF-32BE |
| UTF-32 sin nacimiento | UTF-32LE |
| Latin-1 | LATIN1 o 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 |
| Macroman (CR = Newline) | MACROMAN |
| EBCDIC | EBCDIC |
| Código DOS Página 437 | CP437 |
| Código DOS Página 850 | CP850 |
| Código DOS Página 858 | CP858 |
| Código de Windows Página 1250 | CP1250 |
| Código de Windows Página 1251 | CP1251 |
| Código de Windows Página 1252 | CP1252 |
| Código de Windows Página 1253 | CP1253 |
| Código de Windows Página 1254 | CP1254 |
| Código de Windows Página 1255 | CP1255 |
| Código de Windows Página 1256 | CP1256 |
| Código de Windows Página 1257 | CP1257 |
| Código de Windows Página 1258 | CP1258 |
| KOI8-R | KOI8-R |
| KOI8-U | KOI8-U |
| Koi8-ru | KOI8-RU |
Tenga en cuenta que los patrones regex siempre se especifican en UTF-8 (incluye ASCII). Para buscar archivos binarios con patrones binarios, vea la búsqueda y la visualización de archivos binarios con -u, -w y -x.
Para enumerar recursivamente todos los archivos que son ASCII (es decir, 7 bits):
ug -L '[^[:ascii:]]'
Para enumerar recursivamente todos los archivos que no son ASCII, es decir, UTF-8, UTF-16 y UTF-32 con caracteres no ASCII UNICODE (U+0080 y arriba):
ug -l '[^[:ascii:]]'
Para verificar si un archivo contiene unicode no ASCII (u+0080 y más):
ug -q '[^[:ascii:]]' myfile && echo "contains Unicode"
Para eliminar los caracteres Unicode no válidos de un archivo (tenga en cuenta que -o puede no funcionar porque se detectan y rechazan datos binarios y se agregan nuevas líneas, pero --format="%o% no verifica el binario y copia la coincidencia" Como está ". ):
ug "[p{Unicode}n]" --format="%o" badfile.txt
Para enumerar recursivamente archivos con contenido UTF no válido (es decir, secuencias o archivos de bytes UTF-8 inválidos que contienen cualquier punto de código UTF-8/16/32 que esté fuera del rango de Unicode válido) al hacer coincidir cualquier punto de código . y utilizando un patrón negativo -N 'p{Unicode}' para ignorar cada carácter de unicode válido:
ug -l -e '.' -N 'p{Unicode}'
Para mostrar líneas que contienen emojis de la cara risa:
ug '[?-?]' emojis.txt
Los mismos resultados se obtienen usando x{hhhh} para seleccionar un rango de caracteres Unicode:
ug '[x{1F600}-x{1F60F}]' emojis.txt
Para mostrar líneas que contienen los nombres Gödel (o Goedel), Escher o Bach:
ug 'G(ö|oe)del|Escher|Bach' GEB.txt wiki.txt
Para buscar lorem en la caja inferior o superior en un archivo UTF-16 que está marcado con un BOM UTF-16:
ug -iw 'lorem' utf16lorem.txt
Para buscar utf16lorem.txt cuando este archivo no tiene utf-16 Bom, usando --encoding :
ug --encoding=UTF-16 -iw 'lorem' utf16lorem.txt
Para buscar archivo spanish-iso.txt codificado en ISO-8859-1:
ug --encoding=ISO-8859-1 -w 'año' spanish-iso.txt
? Volver a la tabla de contenido
-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.
Múltiples líneas pueden coincidir con patrones que coinciden con los personajes de Newline. Use la opción -o para emitir solo la coincidencia, no las líneas completas que coinciden.
Para que coincida con n ruptura de la línea, incluya n en el patrón para que coincida con el carácter LF. Si desea que coincidan rn y n rupturas de línea, use r?n o simplemente use R para que coincida con cualquier ruptura de línea unicode rn , r , v , f , n , u u +0085, U+2028 y U+2029.
Para que coincida con C/C ++ /*...*/ Comentarios de múltiples líneas:
ug '/*(.*n)*?.**+/' myfile.cpp
Para que coincidan con los comentarios de C/C ++ utilizando los patrones c/comments predefinidos con -fc/comments , restringidos a la parte coincidente solo con la opción -o :
ug -of c/comments myfile.cpp
Igual que sed -n '/begin/,/end/p' : para que coincida con todas las líneas entre una línea que contiene begin y la primera línea después de eso que contiene end , utilizando repetición perezosa:
ug -o '.*begin(.|n)*?end.*' myfile.txt
? Volver a la tabla de contenido
-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.
Para mostrar dos líneas de contexto antes y después de una línea de juego:
ug -C2 'FIXME' myfile.cpp
Para mostrar tres líneas de contexto después de una línea coincidente:
ug -A3 'FIXME.*' myfile.cpp:
Para mostrar una línea de contexto antes de cada línea de coincidencia con una definición de función C (los nombres C no son unicodos):
ug -B1 -f c/functions myfile.c
Para mostrar una línea de contexto antes de cada línea de coincidencia con una definición de función de C ++ (los nombres de C ++ pueden ser unicode):
ug -B1 -f c++/functions myfile.cpp
Para mostrar cualquier línea no coincidente como contexto para las líneas coincidentes con -y :
ug -y -f c++/functions myfile.cpp
Para mostrar un hexdump de una línea coincidente con una línea de contexto hexdump:
ug -C1 -UX 'xaaxbbxcc' a.out
El contexto dentro de una línea se muestra con la opción -o con una opción de contexto:
ug -o -C20 'pattern' myfile.cpp
Lo mismo, pero con una salida bonita con encabezados, números de línea y números de columna ( -k ) y contexto mostrando:
ug --pretty -oC20 'pattern' myfile.cpp
? Volver a la tabla de contenido
-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.
Los tipos de archivos se enumeran con ugrep -tlist . La lista se basa en extensiones de nombre de archivo establecidas y "bytes mágicos". Si tiene un tipo de archivo que no está en la lista, use opciones -O y/o -M . Es posible que desee definir un alias, por ejemplo alias ugft='ugrep -Oft' como una abreviatura de buscar archivos con sufijo de nombre de archivo .ft .
Para mostrar de forma recursiva definiciones de funciones en archivos c/c ++ ( .h , .hpp , .c , .cpp , etc.) con números de línea con -tc++ , -o , -n y -f c++/functions :
ug -on -tc++ -f c++/functions
Para mostrar recursivamente las definiciones de funciones en archivos .c y .cpp con números de línea con -Oc,cpp , -o , -n y -f c++/functions :
ug -on -Oc,cpp -f c++/functions
Para enumerar recursivamente todos los archivos de shell con -tShell para que coincidan con extensiones y archivos de nombre de archivo con shell shebangs, excepto archivos con sufijo .sh :
ug -l -tShell -O^sh ''
Para enumerar recursivamente todos los archivos que no son de cáscara con -t^Shell :
ug -l -t^Shell ''
Para enumerar recursivamente todos los archivos de shell con shell shebangs que no tienen extensiones de nombre de archivo shell:
ug -l -tShell -t^shell ''
Para buscar líneas con FIXME en comentarios de C/C ++, excluyendo FIXME en cadenas de múltiples líneas:
ug -n 'FIXME' -f c++/zap_strings myfile.cpp
Para leer los patrones TODO y FIXME de la entrada estándar para coincidir con las líneas en la entrada, al tiempo que excluye las coincidencias en cadenas C ++:
ug -on -f - -f c++/zap_strings myfile.cpp <<END
TODO
FIXME
END
Para mostrar el elemento XML y las etiquetas de atributo en un archivo XML, restringido a la parte coincidente con -o , excluyendo las etiquetas que se colocan en comentarios (múltiples):
ug -o -f xml/tags -f xml/zap_comments myfile.xml
? Volver a la tabla de contenido
-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.
Archivos comprimidos con GZIP ( .gz ), Compress ( .Z ), BZIP2 ( .bz , .bz2 , .bzip2 ), LZMA (.LZMA), XZ ( .xz ), LZ4 ( .lz4 ), ZSTD .lzma .zst , .zstd ), brotli ( .br ) y bzip3 ( .bz3 ) se buscan con la opción -z cuando las bibliotecas correspondientes se instalan y compilan con UGREP. Esta opción no requiere que los archivos se compriman. También se buscan archivos sin comprimir, aunque más lentos.
Se pueden buscar otros formatos de compresión con filtros UGREP .
Los archivos (CPIO, JAR, PAX, TAR, ZIP y 7Z) se buscan con la opción -z . Los archivos regulares en un archivo que coinciden se emiten con los nombres de ruta de archivo encerrados en { y } aparatos ortopédicos. Los formatos de alquitrán soportados son V7, Ustar, Gnu, Oldgnu y Pax. Los formatos CPIO compatibles son ODC, NewC y CRC. No es compatible es el obsoleto formato binario binario no portátil no portátil. Los formatos de archivo CPIO, TAR y PAX se reconocen automáticamente con la opción -z en función de su contenido, independientemente de su sufijo de nombre de archivo.
Por defecto, también se buscan archivos sin comprimir almacenados dentro de los archivos ZIP: todos los archivos CPIO, PAX y TAR almacenados en los archivos ZIP y 7Z se reconocen y buscan automáticamente. Sin embargo, de manera predeterminada, no se reconocen los archivos comprimidos almacenados dentro de los archivos, por ejemplo, los archivos zip almacenados dentro de los archivos TAR no se buscan, sino que todos los archivos y archivos comprimidos se buscan como si fueran archivos binarios sin descomprimirlos.
Especifique --zmax=NUM para buscar archivos que contienen archivos y archivos comprimidos para hasta los niveles NUM . El valor de NUM puede variar de 1 a 99 para hasta 99 pasos de descompresión y desarchiving para expandir hasta 99 archivos anidados. Más grande --zmax=NUM degradan el rendimiento. Es poco probable que alguna vez necesite 99 como --zmax=2 es suficiente para la mayoría de los casos de uso práctico, como la búsqueda de archivos zip almacenados en archivos de tar.
Cuando la opción -z se usa con opciones -g , -O , -M o -t , archivos y archivos comprimidos y sin comprimir que coinciden solo con los criterios de selección del nombre de archivo (global, extensión, bytes mágicos o tipo de archivo) se buscan solamente. Por ejemplo, ugrep -r -z -tc++ busca archivos C ++ como main.cpp y archivos zip y alquitrán que contienen archivos C ++ como main.cpp . También se incluyen en la búsqueda archivos C ++ comprimidos como main.cpp.gz y main.cpp.xz cuando está presente. También cualquier archivo CPIO, PAX, TAR, ZIP y 7Z cuando se presente se busca archivos C ++ que contienen, como main.cpp . Use la opción --stats para ver una lista de los patrones del mundo aplicados para filtrar los nombres de ruta del archivo en la búsqueda recursiva y al buscar contenido del archivo.
Cuando la opción -z se usa con opciones -g , -O , -M o -t para buscar CPIO, jar, pax, tar, zip y 7z archivos, archivos archivados que coinciden solo con los criterios de selección del nombre de archivo solo se buscan.
Los formatos GZIP, Compress y ZIP se detectan automáticamente, lo cual es útil al leer datos comprimidos por GZIP de la entrada estándar, por ejemplo, la entrada redirigida de una tubería. Otros formatos de compresión requieren un sufijo de nombre de archivo: .bz , .bz2 o .bzip2 para bzip2, .lzma para lzma, .xz para xz, .lz4 para lz4, .zst o .zstd para zstd, .br para brotli y .bz3 para bzip3. También se reconocen los mortificantes del archivo de alquitrán comprimidos .taz y .tpz para gzip, .tbz , .tbz2 , .tb2 y .tgz para bzip2, .tlz para lzma, .txz para xz y .tzst .tz2 ZSTD. Para buscar estos formatos con UGREP desde la entrada estándar, use la opción --label='stdin.bz2' para bzip2, --label='stdin.lzma' para lzma, --label='stdin.xz' para xz, --label='stdin.lz4 para LZ4 y --label='stdin.zst para ZSTD y así sucesivamente. El nombre stdin es arbitrario y puede omitirse:
| formato | sufijo de nombre de archivo | Tar/Pax Archive Sustifijo corto | ¿Se requiere sufijo? | Ugrep de Stdin | biblioteca |
|---|---|---|---|---|---|
| zip | .gz | .taz , .tgz , .tpz | No | automático | libz |
| comprimir | .Z | .taZ , .tZ | No | automático | incorporado |
| cremallera | .zip , .zipx , .ZIP | No | automático | libz | |
| 7zip | .7z | Sí | --label=.7z | incorporado | |
| bzip2 | .bz , .bz2 , .bzip2 | .tb2 , .tbz , .tbz2 , .tz2 | Sí | --label=.bz2 | libbz2 |
| lzma | .lzma | .tlz | Sí | --label=.lzma | Liblzma |
| xz | .xz | .txz | Sí | --label=.xz | Liblzma |
| LZ4 | .lz4 | Sí | --label=.lz4 | Liblz4 | |
| ZSTD | .zst , .zstd | .tzst | Sí | --label=.zst | libzstd |
| brotli | .br | Sí | --label=.br | libbrotlidec | |
| BZIP3 | .bz3 | Sí | --label=.bz3 | libbzip3 |
Los formatos GZIP, BZIP2, XZ, LZ4 y ZSTD admiten archivos comprimidos concatenados. Los archivos comprimidos concatenados se buscan como un solo archivo.
Los métodos de compresión postal compatibles se almacenan (0), deflate (8), BZIP2 (12), LZMA (14), XZ (95) y ZSTD (93). Los métodos BZIP2, LZMA, XZ y ZSTD requieren que se compilen UGREP con las bibliotecas de compresión correspondientes.
La búsqueda de archivos ZIP cifrados no es compatible (tal vez en futuras versiones, dependiendo de las solicitudes de mejoras).
La búsqueda de archivos de 7ZIP requiere mucha más RAM y más tiempo en comparación con otros métodos. La implementación de 7ZIP LZMA SDK no admite la transmisión, que requiere un archivo 7Z solicitable físico. Esto significa que los archivos 7Z no se pueden buscar cuando se anidan dentro de los archivos. Lo mejor es evitar 7zip. El soporte para 7ZIP se puede deshabilitar con ./build.sh --disable-7zip para construir UGREP.
Opción -z utiliza hilos para el paralelismo de tareas para acelerar la búsqueda de archivos más grandes ejecutando el descompresor simultáneamente con una búsqueda de la transmisión descomprimida.
Para enumerar todos los archivos no vacíos almacenados en un archivo de package.zip , incluido el contenido de todos los archivos CPIO, PAX, TAR, ZIP y 7Z que se almacenan en él:
ug --zmax=2 -z -l '' package.zip
Lo mismo, pero solo enumere los archivos del código fuente de Python, incluidos los scripts que invocan Python, con opción -tPython ( ugrep -tlist para más detalles):
ug --zmax=2 -z -l -tPython '' package.zip
Para buscar aplicaciones de Python distribuidas como un archivo de alquitrán con sus dependencias incluye como ruedas (archivos zip con código python), buscando la palabra my_class en app.tgz :
ug --zmax=2 -z -tPython -w my_class app.tgz
Para buscar recursivamente archivos C ++, incluidos archivos comprimidos para la palabra my_function , mientras omita los comentarios de C y C ++:
ug -z -r -tc++ -Fw my_function -f cpp/zap_comments
Para buscar datos comprimidos BZIP2, LZMA, XZ, LZ4 y ZSTD en la entrada estándar, la --label se puede usar para especificar la extensión correspondiente al formato de compresión para forzar la descompresión cuando la extensión BZIP2 no está disponible para UGREP, por ejemplo:
cat myfile.bz2 | ugrep -z --label='stdin.bz2' 'xyz'
Para buscar el archivo main.cpp en project.zip para líneas TODO y FIXME :
ug -z -g main.cpp -w -e 'TODO' -e 'FIXME' project.zip
Para buscar en Tarball project.tar.gz para archivos C ++ con líneas TODO y FIXME :
ug -z -tc++ -w -e 'TODO' -e 'FIXME' project.tar.gz
Para buscar archivos que coincidan con el global *.txt en project.zip para la license Word en cualquier caso (tenga en cuenta que el argumento del global -g debe cotizarse):
ug -z -g '*.txt' -w -i 'license' project.zip
Para mostrar y página a través de todos los archivos C ++ en Tarball project.tgz :
ug --pager -z -tc++ '' project.tgz
Para enumerar los archivos que coinciden con el Gitignore Style Glob /**/projects/project1.* en projects.tgz , seleccionando archivos que contienen en el archivo el texto December 12 :
ug -z -l -g '/**/projects/project1.*' -F 'December 12' projects.tgz
Para ver los datos metainf/manifest.mf en un archivo jar con -Ojar y -OMF para seleccionar el archivo jar y el archivo mf en el mismo ( -Ojar es necesario, de lo contrario el archivo jar se omitirá aunque podríamos leerlo desde Entrada estándar en su lugar):
ug -z -h -OMF,jar '' my.jar
Para extraer archivos C ++ que contienen FIXME de project.tgz , usamos -m1 con --format="'%z '" para generar una lista separada por espacios de los nombres de ratadizo de archivo ubicados en el archivo que coinciden con la palabra FIXME :
tar xzf project.tgz `ugrep -z -l -tc++ --format='%z ' -w FIXME project.tgz`
Para realizar una búsqueda de profundidad con find , luego use cpio y ugrep para buscar los archivos:
find . -depth -print | cpio -o | ugrep -z 'xyz'
? Volver a la tabla de contenido
--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.
¡Para enumerar recursivamente todos los archivos que comienzan con #! shebangs:
ug -l -M'#!' ''
Para enumerar recursivamente todos los archivos que comienzan con # pero no con #! shebangs:
ug -l -M'#' -M'^#!' ''
Para enumerar recursivamente todos los archivos Python (Extension .py o un shebang) con -tPython :
ug -l -tPython ''
Para enumerar recursivamente todos los archivos que no son de cáscara con -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. Por ejemplo:
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:
| patrón | partidos |
|---|---|
* | 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 :
| parámetro | resultado |
|---|---|
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= | separators |
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:
| código | do | efecto | código | do | efecto |
|---|---|---|---|---|---|
| 0 | norte | normal font and color | 2 | F | faint (not widely supported) |
| 1 | h | highlighted bold font | 21 | h | highlighted bold off |
| 4 | tu | subrayar | 24 | Ud. | underline off |
| 7 | i | invert video | 27 | I | invert off |
| 30 | k | black text | 90 | +k | bright gray text |
| 31 | r | red text | 91 | +r | bright red text |
| 32 | gramo | green text | 92 | +g | bright green text |
| 33 | y | yellow text | 93 | +y | bright yellow text |
| 34 | b | blue text | 94 | +b | bright blue text |
| 35 | metro | magenta text | 95 | +m | bright magenta text |
| 36 | do | cyan text | 96 | +c | bright cyan text |
| 37 | w | texto blanco | 97 | +w | bright white text |
| 40 | k | fondo negro | 100 | +K | bright gray background |
| 41 | R | dark red background | 101 | +R | bright red background |
| 42 | GRAMO | dark green background | 102 | +G | bright green background |
| 43 | Y | dark yellow backgrounda | 103 | +Y | bright yellow background |
| 44 | B | fondo azul oscuro | 104 | +B | bright blue background |
| 45 | METRO | dark magenta background | 105 | +M | bright magenta background |
| 46 | do | dark cyan background | 106 | +C | bright cyan background |
| 47 | W. | dark white background | 107 | +W | bright white background |
See Wikipedia ANSI escape code - SGR parameters
For quick and easy color specification, the corresponding single-letter color names may be used in place of numeric SGR codes and semicolons are not required to separate color names. Color names and numeric codes may be mixed.
For example, to display matches in underlined bright green on bright selected lines, aiding in visualizing white space in matches and file names:
export GREP_COLORS='sl=1:cx=33:ms=1;4;32;100:mc=1;4;32:fn=1;32;100:ln=1;32:cn=1;32:bn=1;32:se=36'
The same, but with single-letter color names:
export GREP_COLORS='sl=h:cx=y:ms=hug+K:mc=hug:fn=hg+K:ln=hg:cn=hg:bn=hg:se=c'
Another color scheme that works well:
export GREP_COLORS='cx=hb:ms=hiy:mc=hic:fn=hi+y+K:ln=hg:cn=hg:bn=hg:se='
Modern Windows command interpreters support ANSI escape codes. Named or numeric colors can be set with SET GREP_COLORS , for example:
SET GREP_COLORS=sl=1;37:cx=33:mt=1;31:fn=1;35:ln=1;32:cn=1;32:bn=1;32:se=36
To disable colors on Windows:
SET GREP_COLORS=""
Color intensities may differ per platform and per terminal program used, which affects readability.
Option -y outputs every line of input, including non-matching lines as context. The use of color helps distinguish matches from non-matching context.
To copy silver searcher's color palette:
export GREP_COLORS='mt=30;43:fn=1;32:ln=1;33:cn=1;33:bn=1;33'
To produce color-highlighted results ( --color is redundance since it is the default):
ug --color -r -n -k -tc++ 'FIXME.*'
To page through the results with pager ( less -R by default):
ug --pager -r -n -k -tc++ 'FIXME'
To display a hexdump of a zip file itself (ie without decompressing), with color-highlighted matches of the zip magic bytes PKx03x04 ( --color is redundant since it is the default):
ug --color -y -UX 'PKx03x04' some.zip
To use predefined patterns to list all #include and #define in C++ files:
ug --pretty -r -n -tc++ -f c++/includes -f c++/defines
Same, but overriding the color of matches as inverted yellow (reverse video) and headings with yellow on blue using --pretty :
ug --pretty --colors="ms=yi:fn=hyB" -r -n -tc++ -f c++/includes -f c++/defines
To list all #define FOO... macros in C++ files, color-highlighted:
ug --color=always -r -n -tc++ -f c++/defines | ug 'FOO.*'
Same, but restricted to .cpp files only:
ug --color=always -r -n -Ocpp -f c++/defines | ug 'FOO.*'
To search tarballs for matching names of PDF files (assuming bash is our shell):
for tb in *.tar *.tar.gz *.tgz; do echo "$tb"; tar tfz "$tb" | ugrep '.*.pdf$'; done
? Back to table of contents
--cpp Output file matches in C++. See also options --format and -u.
--csv Output file matches in CSV. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
--json Output file matches in JSON. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
--xml Output file matches in XML. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
To recursively search for lines with TODO and display C++ file matches in JSON with line number properties:
ug -tc++ -n --json 'TODO'
To recursively search for lines with TODO and display C++ file matches in XML with line and column number attributes:
ug -tc++ -nk --xml 'TODO'
To recursively search for lines with TODO and display C++ file matches in CSV format with file pathname, line number, and column number fields:
ug -tc++ --csv -Hnk 'TODO'
To extract a table from an HTML file and put it in C/C++ source code using -o :
ug -o --cpp '<tr>.*</tr>' index.html > table.cpp
? Back to table of contents
--format=FORMAT
Output FORMAT-formatted matches. For example --format='%f:%n:%O%~'
outputs matching lines `%O' with filename `%f` and line number `%n'
followed by a newline `%~'. If -P is specified, FORMAT may include
`%1' to `%9', `%[NUM]#' and `%[NAME]#' to output group captures. A
`%%' outputs `%'. See `ugrep --help format' and `man ugrep'
section FORMAT for details. When option -o is specified, option -u
is also enabled. Context options -A, -B, -C and -y are ignored.
-P, --perl-regexp
Interpret PATTERN as a Perl regular expression.
Use option -P to use group captures and backreferences. Capturing groups in regex patterns are parenthesized expressions (pattern) . The first group is referenced in FORMAT by %1 , the second by %2 and so on. Named captures are of the form (?<NAME>pattern) and are referenced in FORMAT by %[NAME]# .
The following output formatting options may be used. The FORMAT string % -fields are listed in a table further below:
| opción | resultado |
|---|---|
--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| opción | format string (within quotes) |
|---|---|
--format-open | '%+' |
--format | '%[,]$%H%N%K%B%V%~%u' |
--json| opción | 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| opción | 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| opción | format string (within quotes) |
|---|---|
--format-open | '%+' |
--format | '%F%n%s%K%B%~%u' |
The following fields may be used in the FORMAT string:
| campo | producción |
|---|---|
%% | 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 |
Nota:
%~ 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 ψ :
| Patrón | Partidos |
|---|---|
x | matches the character x , where x is not a special character |
. | matches any single character except newline (unless in dotall mode) |
. | partidos . (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 ):
| Patrón | Partidos |
|---|---|
[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 | Partidos |
|---|---|
[: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 | Partidos |
|---|---|
. | 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
