ugrep
v7.1.1
[ LEIA-ME | Guia do usuário | Indexação | Referências | Perguntas e respostas]
a opção -Q abre uma consulta TUI para pesquisar arquivos enquanto você digita!
O ugrep é rápido, fácil de usar e equipado com vários novos recursos que os usuários queriam
inclui uma TUI interativa com ajuda integrada, pesquisa semelhante à do Google com padrões AND/OR/NOT, pesquisa difusa, pesquisa (aninhada) de arquivos zip/7z/tar/pax/cpio, tarballs e arquivos compactados gz/Z/bz/ bz2/lzma/xz/lz4/zstd/brotli, pesquisa e arquivos binários hexdump, pesquisa de documentos como PDF, doc, docx e saída em JSON, XML, CSV ou seu próprio formato personalizado
Sintaxe de padrão regex estendida Unicode com correspondência de padrão multilinha sem a necessidade de opções especiais de linha de comando
inclui um indexador de arquivos para acelerar a pesquisa em sistemas de arquivos lentos e frios
um verdadeiro substituto para GNU grep (supondo que você copie ou crie um link simbólico ug para grep , e para egrep e para fgrep ), ao contrário de outros grep populares que afirmam ser "alternativas grep" ou "substituições" quando eles realmente implementam linha de comando incompatível opções e usar um correspondente de regex incompatível, ou seja, apenas regex Perl versus POSIX BRE (grep) e ERE (egrep) quando ugrep suporta todos os regex modos
benchmarks mostram que ugrep é (um dos) o grep mais rápido usando o matcher regex RE/flex de alto desempenho baseado em DFA
se algo precisar ser melhorado ou adicionado ao ugrep, me avise!
A prioridade nº 1 é a garantia de qualidade para continuar garantindo que o ugrep não tenha bugs e seja confiável
faça o ugrep rodar ainda mais rápido, veja por exemplo #432, #421
compartilhe resultados de desempenho reproduzíveis
ug é para uso interativo, que carrega um arquivo de configuração .ugrep opcional com suas preferências localizadas no diretório de trabalho ou diretório inicial, ug+ também pesquisa PDFs, documentos, e-books, metadados de imagens
ugrep para uso em lote como GNU grep sem um arquivo de configuração .ugrep, ugrep+ também pesquisa PDFs, documentos, e-books, metadados de imagens
Corresponde aos padrões Unicode por padrão e pesquisa automaticamente arquivos codificados em UTF-8, UTF-16 e UTF-32
Corresponde múltiplas linhas com n ou R em padrões regex, nenhuma opção especial é necessária para fazer isso!
Ajuda integrada: ug --help , onde ug --help WHAT exibe opções relacionadas ao WHAT você está procurando
ug --help regex , ug --help globs , ug --help fuzzy , ug --help format .
Fácil de usar, com arquivos de configuração personalizáveis usados pelo comando ug destinado ao uso interativo que carrega um arquivo de configuração .ugrep com suas preferências
ug PATTERN ... ugrep --config PATTERN ...
ug --save-config ...options-you-want-to-save... salva um arquivo de configuração .ugrep no diretório de trabalho para que na próxima vez que você executar ug lá ele use essas opções. Faça isso em seu diretório inicial para salvar um arquivo de configuração .ugrep com opções que você geralmente deseja usar.
Consulta interativa TUI, pressione F1 ou CTRL-Z para obter ajuda e TAB/SHIFT-TAB para navegar até diretórios e arquivos
ug -Q ug -Q -e PATTERN
-Q substitui PATTERN na linha de comando para permitir que você insira padrões interativamente na TUI. Na TUI, use teclas ALT + letras para ativar/desativar "opções de letras" curtas, por exemplo ALT-n (opção -n ) para mostrar/ocultar números de linha.
Pesquise o conteúdo de arquivos (zip, tar, pax, jar, cpio, 7z) e arquivos compactados (gz, Z, bz, bz2, lzma, xz, lz4, zstd, brotli)
ug -z PATTERN ... ug -z --zmax=2 PATTERN ...
especifique -z --zmax=2 para pesquisar arquivos compactados e arquivos aninhados em arquivos. O argumento --zmax pode variar de 1 (padrão) a 99 para até 99 etapas de descompactação e desarquivamento para pesquisar arquivos aninhados
Pesquise com padrões de consulta booleana semelhantes ao Google usando padrões -% com AND (ou apenas espaço), OR (ou uma barra | ), NOT (ou um traço - ), usando aspas para corresponder exatamente e agrupando com ( ) (mostrado em o lado esquerdo abaixo); ou com as opções -e (como um "ou"), --and , --andnot e --not padrões regex (mostrados no lado direito abaixo):
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' ...
onde A , B e C são padrões regex arbitrários (use a opção -F para pesquisar strings)
especifique a opção -%% ( --bool --files ) para aplicar a consulta booleana aos arquivos como um todo: um arquivo corresponde se todas as condições booleanas forem satisfeitas pela correspondência de padrões em todo o arquivo. Caso contrário, as condições booleanas se aplicam a linhas únicas por padrão, uma vez que os utilitários grep geralmente são correspondentes de padrões baseados em linhas. A opção --stats exibe a consulta em formato legível após a conclusão da pesquisa.
Pesquise PDF, doc, docx, e-book e muito mais com ug+ usando filtros associados a extensões de nome de arquivo:
ug+ PATTERN ...
ou especifique --filter com um tipo de arquivo para usar um utilitário 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 ...
o comando ug+ é igual ao comando ug , mas também usa filtros para pesquisar PDFs, documentos e metadados de imagens
Exiba o contexto horizontal com a opção -o ( --only-matching ) e opções de contexto -ABC , por exemplo, para encontrar correspondências em linhas muito longas, como fontes Javascript e JSON:
ug -o -C20 -nk PATTERN longlines.js
-o -C20 ajusta todas as correspondências com contexto em 20 caracteres antes e 20 caracteres depois de uma correspondência (ou seja, 40 caracteres Unicode no total), -nk gera números de linhas e colunas.
Encontre correspondências aproximadas de padrões com pesquisa difusa, dentro da distância de Levenshtein especificada
ug -Z PATTERN ... ug -Z3 PATTTERN ...
-Zn corresponde a até n caracteres extras, ausentes ou substituídos, -Z+n corresponde a até n caracteres extras, -Zn corresponde a até n caracteres ausentes e -Z~n corresponde a até n caracteres substituídos. -Z é padronizado como -Z1 .
Pesquisa semelhante a Fzf com regex (ou strings fixas com -F ), correspondência difusa com até 4 caracteres extras com -Z+4 e palavras apenas com -w , usando -%% para pesquisas booleanas em todo o arquivo
ug -Q -%% -l -w -Z+4 --sort=best
-l lista os arquivos correspondentes na TUI, pressione TAB e depois ALT-y para visualizar um arquivo, SHIFT-TAB e Alt-l para voltar para visualizar a lista de arquivos correspondentes ordenados pela melhor correspondência
Pesquise arquivos binários e exiba hexdumps com correspondências de padrões binários (texto Unicode ou -U para padrões 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 exibe 4 colunas hexadecimais sem uma coluna de caracteres c , sem espaçamento hexadecimal h e com uma linha hexadecimal extra C1 antes e depois de uma correspondência.
Inclua arquivos para pesquisar por tipos de arquivo ou "bytes mágicos" de arquivo ou exclua-os com ^
ug -t TYPE PATTERN ... ug -t ^TYPE PATTERN ...
ug -M 'MAGIC' PATTERN ... ug -M '^MAGIC' PATTERN ...
Inclua arquivos e diretórios para pesquisar que correspondam a globs no estilo gitignore ou exclua-os com ^
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 ...
Inclua arquivos para pesquisar por extensões de nome de arquivo (sufixo) ou exclua-os com ^ , uma abreviação de -g"*.EXT"
ug -O EXT PATTERN ... ug -O ^EXT PATTERN ...
Incluir arquivos ocultos (dotfiles) e diretórios para pesquisa (omitidos por padrão)
ug -. PATTERN ... ug -g'.*,.*/' PATTERN ...
especifique hidden em seu .ugrep para sempre pesquisar arquivos ocultos com ug .
Exclua arquivos especificados por .gitignore etc.
ug --ignore-files PATTERN ... ug --ignore-files=.ignore PATTERN ...
especifique ignore-files no seu .ugrep para sempre ignorá-los com ug . Adicione ignore-files=... adicionais conforme desejado.
Padrões de pesquisa, excluindo padrões negativos ("correspondem a isto, mas não àquilo")
ug -e PATTERN -N NOTPATTERN ... ug -e '[0-9]+' -N 123 ...
Use padrões regex predefinidos para pesquisar código-fonte, javascript, XML, JSON, HTML, PHP, markdown, etc.
ug PATTERN -f c++/zap_comments -f c++/zap_strings ...
ug PATTERN -f php/zap_html ...
ug -f js/functions ... | ug PATTERN ...
Classifique os arquivos correspondentes por nome, melhor correspondência, tamanho e 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 saída em CSV, JSON, XML e formatos especificados pelo usuário
ug --csv PATTERN ... ug --json PATTERN ...
ug --xml PATTERN ... ug --format='file=%f line=%n match=%O%~' PATTERN ...
ug --help format exibe ajuda nos campos % de formato para saída personalizada.
Pesquise com padrões regex compatíveis com Perl do PCRE e exiba ou substitua correspondências de subpadrões
ug -P PATTERN ... ug -P --format='%1 and %2%~' 'PATTERN(SUB1)(SUB2)' ...
Substitua os padrões na saída por texto de substituição -P e --replace, contendo opcionalmente % campos de formatação, usando -y para passar o restante do arquivo:
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 exibe ajuda nos campos % de formato para usar opcionalmente com --replace .
Pesquise arquivos com um formato de codificação específico, como ISO-8859-1 a 16, CP 437, CP 850, MACROMAN, KOI8, etc.
ug --encoding=LATIN1 PATTERN ...
Instale o ugrep mais recente com Homebrew:
$ brew install ugrep
ou instale com MacPorts:
$ sudo port install ugrep
Isso instala os comandos ugrep e ug , onde ug é o mesmo que ugrep mas também carrega o arquivo de configuração .ugrep quando presente no diretório de trabalho ou no diretório inicial.
Instalar com Winget winget install Genivia.ugrep
Ou instale com Chocolatey choco install ugrep
Ou instale com Scoop scoop install ugrep
Ou baixe o executável ugrep.exe completo como artefato de lançamento em https://github.com/Genivia/ugrep/releases. A versão compactada contém o binário principal ugrep.exe bem como ug.exe . O comando ug , destinado ao uso interativo, carrega e lê as configurações do arquivo de configuração .ugrep (quando presente no diretório de trabalho ou no diretório inicial).
Adicione ugrep.exe e ug.exe ao seu caminho de execução: vá para Configurações e pesquise "Caminho" em Encontrar uma configuração . Selecione variáveis de ambiente -> Caminho -> Novo e adicione o diretório onde você colocou os executáveis ugrep.exe e ug.exe .
Dica
Dicas práticas sobre como usar ugrep.exe e ug.exe na linha de comando do Windows:
' simples, mas use " em vez disso; a maioria dos utilitários de comando do Windows considera as aspas ' simples como parte do argumento da linha de comando!-g/GLOB em vez dos argumentos usuais de linha de comando GLOB para selecionar arquivos e diretórios para pesquisar, especialmente para pesquisas recursivas;"" para corresponder a todas as entradas, isso pode ser ignorado por alguns interpretadores de comandos do Windows, como o Powershell; nesse caso, você deve especificar a opção --match ;R vez de n para corresponder a quaisquer novas linhas Unicode, como rn pares e únicos r e n . $ apk add ugrep ugrep-doc
Verifique https://pkgs.alpinelinux.org/packages?name=ugrep para obter informações sobre a versão.
$ pacman -S ugrep
Verifique https://archlinux.org/packages/extra/x86_64/ugrep para obter informações sobre a versão.
Primeiro habilite o repositório EPEL e então você pode instalar o ugrep.
$ dnf install ugrep
Verifique https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ para informações sobre a versão.
$ apt-get install ugrep
Verifique https://packages.debian.org/ugrep para informações de versão. Para compilar e testar ugrep localmente, consulte as etapas de compilação de "Todas as plataformas" mais abaixo.
$ dnf install ugrep
Verifique https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ para informações sobre a versão.
$ pkg install ugrep
Verifique https://www.freshports.org/textproc/ugrep para obter informações sobre a versão.
$ pkgman install cmd:ugrep
Verifique https://github.com/haikuports/haikuports/tree/master/app-text/ugrep para obter informações sobre a versão. Para compilar e testar ugrep localmente, consulte as etapas de compilação de "Todas as plataformas" mais abaixo.
Você pode usar o instalador de pacote padrão do NetBSD (pkgsrc): http://cdn.netbsd.org/pub/pkgsrc/current/pkgsrc/textproc/ugrep/README.html
$ pkg_add ugrep
Verifique https://openports.pl/path/sysutils/ugrep para obter informações sobre a versão.
$ zypper install ugrep
Verifique https://build.opensuse.org/package/show/utilities/ugrep para obter informações sobre a versão.
Primeiro habilite o repositório EPEL e então você pode instalar o ugrep.
$ dnf install ugrep
Verifique https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ para informações sobre a versão.
Clonar ugrep com
$ git clone https://github.com/Genivia/ugrep
Ou visite https://github.com/Genivia/ugrep/releases para baixar uma versão específica.
Você sempre pode adicioná-los mais tarde, quando precisar destes recursos:
A opção -P (expressões regulares Perl) requer a biblioteca PCRE2 (recomendada) ou a biblioteca Boost.Regex (substituição opcional). Se o PCRE2 não estiver instalado, instale o PCRE2 com, por exemplo, sudo apt-get install -y libpcre2-dev ou baixe o PCRE2 e siga as instruções de instalação. Alternativamente, baixe Boost.Regex e execute ./bootstrap.sh e sudo ./b2 --with-regex install . Consulte Boost: primeiros passos.
A opção -z (pesquisa de arquivos compactados e arquivos) requer a biblioteca zlib instalada. Ele está instalado na maioria dos sistemas. Caso contrário, instale-o, por exemplo, com sudo apt-get install -y libz-dev . Para pesquisar arquivos .bz e .bz2 , instale a biblioteca bzip2 (recomendado), por exemplo, com sudo apt-get install -y libbz2-dev . Para pesquisar arquivos .lzma e .xz , instale a biblioteca lzma (recomendada), por exemplo, com sudo apt-get install -y liblzma-dev . Para pesquisar arquivos .lz4 , instale a biblioteca lz4 (opcional, não obrigatória), por exemplo, com sudo apt-get install -y liblz4-dev . Para pesquisar arquivos .zst , instale a biblioteca zstd (opcional, não obrigatória), por exemplo, com sudo apt-get install -y libzstd-dev . Para pesquisar arquivos .br , instale a biblioteca brotli (opcional, não obrigatória), por exemplo, com sudo apt-get install -y libbrotli-dev . Para pesquisar arquivos .bz3 , instale a biblioteca bzip3 (opcional, não obrigatória), por exemplo, com sudo apt-get install -y bzip3 .
Dica
Mesmo que o seu sistema possua utilitários de linha de comando, como bzip2 , isso não significa necessariamente que as bibliotecas de desenvolvimento, como libbz2 estejam instaladas. As bibliotecas de desenvolvimento devem ser instaladas.
Alguns sistemas Linux podem não estar configurados para carregar bibliotecas dinâmicas de /usr/local/lib , causando um erro de carregamento de biblioteca ao executar ugrep . Para corrigir isso, adicione export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/usr/local/lib" ao seu arquivo ~/.bashrc . Ou execute sudo ldconfig /usr/local/lib .
Execute o script ./build.sh para construir ugrep :
$ cd ugrep
$ ./build.sh
Isso cria o executável ugrep no diretório ugrep/src com ./configure e make -j , verificado com make test . Quando todos os testes forem aprovados, o executável ugrep será copiado para ugrep/bin/ugrep e o link simbólico ugrep/bin/ug -> ugrep/bin/ugrep será adicionado ao comando ug .
Observe que ug é igual a ugrep , mas também carrega o arquivo de configuração .ugrep quando presente no diretório de trabalho ou no diretório inicial. Isso significa que você pode definir suas opções padrão para ug em .ugrep.
Caminhos alternativos para bibliotecas instaladas ou locais podem ser especificados com ./build.sh . Para obter ajuda sobre as opções de compilação disponíveis:
$ ./build.sh --help
Você pode criar executáveis estáticos especificando:
$ ./build.sh --enable-static
Isso pode falhar se as bibliotecas não estiverem vinculadas estaticamente, como brotli. Nesse caso, tente ./build.sh --enable-static --without-brotli .
Você pode construir ugrep com padrões personalizados habilitados, como um pager:
$ ./build.sh --enable-pager
As opções para selecionar padrões para compilações incluem:
--help exibe opções de construção--enable-static cria executáveis estáticos, se possível--enable-hidden sempre pesquisa arquivos e diretórios ocultos--enable-pager sempre usa um pager para exibir a saída nos terminais--enable-pretty colore a saída para terminais e adiciona cabeçalhos de nome de arquivo--disable-auto-color desabilita cores automáticas, requer a opção ugrep --color=auto para mostrar cores--disable-mmap desabilita arquivos mapeados na memória--disable-sse2 desabilita otimizações SSE2 e AVX--disable-avx2 desativa as otimizações AVX2 e AVX512BW, mas compila com SSE2 quando compatível--disable-neon desabilita otimizações ARM NEON/AArch64--with-grep-path o caminho padrão -f se GREP_PATH não estiver definido--with-grep-colors as cores padrão se GREP_COLORS não estiver definido Após a conclusão da compilação, copie ugrep/bin/ugrep e ugrep/bin/ug para um local conveniente, por exemplo, em seu diretório ~/bin . Ou, se você quiser instalar os comandos ugrep e ug e as páginas man:
$ sudo make install
Isso também instala os arquivos padrão com padrões predefinidos para a opção -f em /usr/local/share/ugrep/patterns/ . A opção -f primeiro verifica o diretório de trabalho quanto à presença de arquivos de padrão, se não for encontrada, verifica a variável de ambiente GREP_PATH para carregar os arquivos de padrão e, se não for encontrada, lê os arquivos de padrão predefinidos instalados.
Infelizmente, os clones git não preservam carimbos de data/hora, o que significa que você pode encontrar "AVISO: 'aclocal-1.15' está faltando em seu sistema." ou aquele autoheader não foi encontrado ao executar make .
Para contornar esse problema, execute:
$ autoreconf -fi
$ ./build.sh
GCC 8 e superior podem produzir avisos do tipo "nota: passagem de parâmetro para argumento ... alterado no GCC 7.1" . Esses avisos devem ser ignorados.
Um Dockerfile está incluído para construir ugrep em um contêiner Ubuntu.
Os desenvolvedores podem querer usar sanitizadores para verificar o código ugrep ao fazer alterações significativas, por exemplo, para detectar disputas de dados com o ThreadSanitizer:
$ ./build.sh CXXFLAGS='-fsanitize=thread -O1 -g'
Verificamos ugrep com clang AddressSanitizer, MemorySanitizer, ThreadSanitizer e UndefinedBehaviorSanitizer. Essas opções geram sobrecarga significativa no tempo de execução e não devem ser usadas na compilação final.
? Voltar ao índice
Observe que os comandos ugrep e ug pesquisam arquivos binários por padrão e não ignoram os arquivos especificados .gitignore, o que não tornará as comparações de desempenho de pesquisa recursivas significativas, a menos que as opções -I e --ignore-files sejam usadas. Para tornar essas opções o padrão para ug , basta adicionar ignore-binary e ignore-files ao seu arquivo de configuração .ugrep.
Para uma comparação de desempenho atualizada do ugrep mais recente, consulte os benchmarks de desempenho do ugrep. Ugrep é mais rápido que GNU grep, Silver Searcher, ack, sift. A velocidade do Ugrep supera o ripgrep na maioria dos benchmarks.
Primeiro, vamos definir o comando :grep no Vim para pesquisar arquivos recursivamente. Para fazer isso, adicione as seguintes linhas ao seu .vimrc localizado no diretório raiz:
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
Isso especifica pesquisas que não diferenciam maiúsculas de minúsculas -j com o comando Vim :grep . Para pesquisas que diferenciam maiúsculas de minúsculas, remova -j de grepprg . Múltiplas correspondências na mesma linha são listadas separadamente na janela de correção rápida. Se isso não for desejado, remova -u do grepprg . Com esta alteração, apenas a primeira correspondência numa linha é mostrada. A opção --ignore-files ignora os arquivos especificados nos arquivos .gitignore , quando presentes. Para limitar a profundidade das pesquisas recursivas apenas ao diretório atual, anexe -1 a grepprg .
Agora você pode invocar o comando Vim :grep no Vim para pesquisar arquivos em um PATH especificado para correspondências PATTERN :
:grep PATTERN [PATH]
Se você omitir PATH , o diretório de trabalho será pesquisado. Use % como PATH para pesquisar apenas o arquivo atualmente aberto no Vim:
:grep PATTERN %
O comando :grep mostra os resultados em uma janela de correção rápida que permite pular rapidamente para as correspondências encontradas.
Para abrir uma janela de correção rápida com a lista de correspondências mais recente:
:copen
Clique duas vezes em uma linha nesta janela (ou selecione uma linha e pressione ENTER) para ir para o arquivo e localização no arquivo da correspondência. Digite os comandos :cn e :cp para pular para a partida seguinte ou anterior, respectivamente. Para atualizar os resultados da pesquisa na janela do quickfix, basta fazer um grep neles. Por exemplo, para pesquisar recursivamente o código-fonte C++ marcado como FIXME no diretório de trabalho:
:grep -tc++ FIXME
Para fechar a janela de correção rápida:
:cclose
Você pode usar opções ugrep com o comando :grep , por exemplo, para selecionar comentários de uma ou várias linhas no arquivo atual:
:grep -f c++/comments %
Apenas a primeira linha de um comentário multilinha é mostrada no quickfix, para economizar espaço. Para mostrar todas as linhas de uma correspondência multilinha, remova %-G de grepformat .
Uma ferramenta Vim popular é ctrlp.vim, que é instalada com:
$ cd ~/.vim
$ git clone https://github.com/kien/ctrlp.vim.git bundle/ctrlp.vim
CtrlP usa ugrep adicionando as seguintes linhas ao seu .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
onde -I ignora arquivos binários, a opção --ignore-files ignora os arquivos especificados nos arquivos .gitignore , quando presente, e a opção -3 restringe a pesquisa de diretórios a três níveis (o diretório de trabalho e até dois níveis abaixo).
Inicie o Vim e digite o comando:
:helptags ~/.vim/bundle/ctrlp.vim/doc
Para visualizar a documentação do CtrlP no Vim, digite o comando:
:help ctrlp.txt
? Voltar ao índice
Graças a Manuel Uberti, agora você pode usar o ugrep no Emacs. Para usar ugrep em vez de GNU grep no Emacs, adicione a seguinte linha ao seu arquivo .emacs.d/init.el :
(setq-default xref-search-program ‘ugrep)
Isso significa que os comandos do Emacs, como project-find-regexp que dependem do Xref, agora podem aproveitar o poder do ugrep .
Além disso, é possível usar grep nos comandos grep do Emacs. Por exemplo, você pode executar lgrep com ugrep personalizando grep-template para algo como o seguinte:
(setq-default grep-template "ugrep --color=always -0Iinr -e <R>")
Se você não possui o Emacs versão 29 (ou superior), você pode baixar e construir o Emacs a partir do branch master do Emacs ou ativar a integração do Xref com o 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))
? Voltar ao índice
O ugrep pronto para uso suporta todas as opções de linha de comando grep padrão do GNU/BSD e melhora muitas delas também. Para obter detalhes, consulte melhorias notáveis em relação ao grep.
Se você quiser seguir exatamente os padrões GNU/BSD grep ASCII/LATIN1 não-UTF Unicode, use a opção -U para desabilitar a correspondência completa de padrões Unicode.
Na verdade, executar ugrep com as opções -U , -Y , -. e --sort faz com que ele se comporte exatamente como egrep , combinando apenas padrões ASCII/LATIN1 não-UTF Unicode, permitindo que padrões vazios correspondam e pesquisem arquivos ocultos em vez de ignorá-los, respectivamente. Veja equivalência grep.
Você pode criar aliases grep convenientes com ou sem opções -U , -Y , -. e --sort ou inclua outras opções conforme desejado.
Ou você pode criar executáveis grep , egrep e fgrep copiando ugrep para esses nomes. Quando o executável ugrep (ou ugrep.exe ) é copiado como grep ( grep.exe ), egrep ( egrep.exe ), fgrep ( fgrep.exe ), então as opções -U , -Y e -. são ativados automaticamente junto com -G para grep , -E para egrep e -F para fgrep . Além disso, quando copiado como zgrep , zegrep e zfgrep , a opção -z está habilitada. Por exemplo, quando ugrep é copiado como zegrep , as opções -z , -E , -Y , -. e --sort estão habilitados.
Da mesma forma, links simbólicos e links físicos para ugrep também funcionam bem para criar substituições grep , egrep e fgrep . Por exemplo, para criar um link simbólico egrep :
sudo ln -s `which ugrep` /opt/local/bin/egrep
O /opt/local/bin é apenas um exemplo e pode ou não estar no seu $path e pode ou não ser encontrado ao executar egrep dependendo do seu $path .
ugrep é equivalente ao GNU/BSD grep quando as seguintes opções são usadas:
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
onde:
-U desativa a correspondência de padrões de caracteres largos Unicode, portanto, por exemplo, o padrão xa3 corresponde ao byte A3 em vez do ponto de código Unicode U+00A3 representado pela sequência UTF-8 C2 A3. Por padrão no ugrep, xa3 corresponde a U+00A3. Não recomendamos usar -U para pesquisas de padrões de texto, apenas para pesquisas binárias ou para pesquisar arquivos latin-1 (iso-8859-1) sem reportar esses arquivos como binários (desde ugrep v3.5.0).-Y permite correspondências vazias, por exemplo, o padrão a* corresponde a cada linha em vez de uma sequência de a 's. Por padrão no ugrep, o padrão a* corresponde a uma sequência de a 's. Além disso, em ugrep o padrão a*b*c* corresponde ao que deveria corresponder por padrão. Veja melhorias.-. pesquisa arquivos ocultos (dotfiles). Por padrão, os arquivos ocultos são ignorados, como a maioria dos utilitários Unix.--sort especifica a saída classificada por nome do caminho, mostrando primeiro os arquivos correspondentes classificados, seguidos por correspondências recursivas classificadas em subdiretórios. Caso contrário, os arquivos correspondentes serão relatados sem nenhuma ordem específica para melhorar o desempenho;-Dread e -dread são os padrões grep do GNU/BSD, mas não são recomendados, veja melhorias para uma explicação.? Voltar ao índice
Aliases comumente usados para adicionar ao .bashrc para aumentar a produtividade:
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)
? Voltar ao índice
-Q .n .-U ).--bool ).--ignore-files .-Z .-z .-z .-z e --zmax=NUM para até NUM níveis de profundidade.--filter usando utilitários de conversão de formato de terceiros como plug-ins.-r para pesquisar diretórios recursivamente.-. ).-E como egrep, enquanto -G habilita BRE).-J1 ).-W (saída de correspondências binárias em hexadecimal com texto correspondente à saída como de costume) e -X (saída de todas as correspondências em hexadecimal).--format ).-f usa a variável de ambiente GREP_PATH ou os padrões predefinidos instalados em /usr/local/share/ugrep/patterns . Se -f for especificado e também um ou mais padrões -e forem especificados, então as opções -F , -x e -w não se aplicam aos padrões -f . Isto evita confusão quando -f é usado com padrões predefinidos que podem não funcionar mais corretamente com essas opções.-O , -M e -t especificam extensões de arquivo, padrões de bytes mágicos de assinatura de arquivo e tipos de arquivo predefinidos, respectivamente. Isso permite pesquisar certos tipos de arquivos em árvores de diretórios, por exemplo, com opções de pesquisa recursiva -R e -r . As opções -O , -M e -t também se aplicam a arquivos arquivados em arquivos cpio, jar, pax, tar, zip e 7z.-k , --column-number para exibir o número da coluna, levando em consideração o espaçamento entre tabulações, expandindo as tabulações, conforme especificado pela opção --tabs .-P (expressões regulares Perl) suporta referências anteriores (com --format ) e lookbehinds, que usa a biblioteca PCRE2 ou Boost.Regex para correspondência rápida de regex Perl com uma sintaxe semelhante a PCRE.-b com a opção -o ou com a opção -u , ugrep exibe o deslocamento exato de bytes da correspondência de padrão em vez do deslocamento de bytes do início da linha correspondente relatado pelo GNU/BSD grep.-u , --ungroup para não agrupar várias correspondências por linha. Esta opção exibe uma linha de entrada correspondente novamente para cada correspondência de padrão adicional na linha. Esta opção é particularmente útil com a opção -c para relatar o número total de correspondências de padrões por arquivo em vez do número de linhas correspondidas por arquivo.-Y permite a correspondência de padrões vazios. Grepping com padrões de correspondência vazia é estranho e fornece resultados diferentes com GNU grep versus BSD grep. Correspondências vazias não são geradas pelo ugrep por padrão, o que evita erros que podem produzir resultados "aleatórios". Por exemplo, com GNU/BSD grep, o padrão a* corresponde a cada linha na entrada e, na verdade, corresponde xyz três vezes (as transições vazias antes e entre x , y e z ). Permitir correspondências vazias requer a opção ugrep -Y . Padrões que começam com ^ ou terminam com $ , como ^h*$ , correspondem a vazios. Esses padrões ativam automaticamente a opção -Y .-D, --devices=ACTION é skip por padrão, em vez de read . Isso evita a suspensão inesperada de pipes nomeados em diretórios que são pesquisados recursivamente, como pode acontecer com o grep GNU/BSD que read dispositivos por padrão.-d, --directories=ACTION é skip por padrão, em vez de read . Por padrão, os diretórios especificados na linha de comando são pesquisados, mas não de forma recursiva nos subdiretórios.-N PATTERN , que são padrões no formato (?^X) que ignoram todas as entradas X , removendo assim X da pesquisa. Por exemplo, padrões negativos podem ser usados para pular strings e comentários ao pesquisar identificadores no código-fonte e encontrar correspondências que não estão em strings e comentários. Os padrões zap predefinidos usam padrões negativos, por exemplo, use -f cpp/zap_comments para ignorar correspondências de padrões em comentários C++.GREP_OPTIONS , porque o comportamento do ugrep deve ser portátil e previsível em todos os sistemas. Além disso, o GNU grep abandonou GREP_OPTIONS por esse motivo. Use o comando ug que carrega o arquivo de configuração .ugrep localizado no diretório de trabalho ou no diretório inicial, quando presente, ou use aliases de shell para criar novos comandos com opções de pesquisa específicas.? Voltar ao índice
Para realizar uma pesquisa usando um arquivo de configuração .ugrep colocado no diretório de trabalho ou no diretório inicial (observe que ug é o mesmo que ugrep --config ):
ug PATTERN FILE...
Para salvar um arquivo de configuração .ugrep no diretório de trabalho, edite esse arquivo em seu diretório inicial para personalizar suas preferências para os padrões ug :
ug --save-config
Para pesquisar o diretório de trabalho e recursivamente mais profundamente para main (observe que -r recurse symlinks é habilitado por padrão se nenhum argumento de arquivo for especificado):
ug main
O mesmo, mas pesquise apenas arquivos de código-fonte C++ recursivamente, ignorando todos os outros arquivos:
ug -tc++ main
O mesmo, usando a consulta interativa TUI, começando com o padrão de pesquisa inicial main (observe que -Q com um padrão inicial requer a opção -e porque os padrões são normalmente especificados interativamente e todos os argumentos da linha de comando são considerados arquivos/diretórios):
ug -Q -tc++ -e main
Para procurar #define (e # define etc) usando um padrão regex em arquivos C++ (observe que os padrões devem ser citados para evitar globbing de shell de * e ? ):
ug -tc++ '#[t ]*define'
Para pesquisar main como uma palavra ( -w ) recursivamente sem seguir links simbólicos ( -r ) no diretório myproject , mostrando os números de linha ( -n ) e coluna ( -k ) correspondentes próximos às linhas correspondentes:
ug -r -nkw main myproject
O mesmo, mas pesquise apenas myproject sem recorrer mais profundamente (observe que os argumentos do diretório são pesquisados em um nível por padrão):
ug -nkw main myproject
O mesmo, mas pesquise myproject e um nível de subdiretório mais profundo (dois níveis) com -2 :
ug -2 -nkw main myproject
O mesmo, mas pesquise apenas arquivos C++ em myproject e seus subdiretórios com -tc++ :
ug -tc++ -2 -nkw main myproject
O mesmo, mas também pesquise dentro de arquivos (por exemplo, arquivos zip e tar) e arquivos compactados com -z :
ug -z -tc++ -2 -nkw main myproject
Pesquise recursivamente o diretório de trabalho por main enquanto ignora os arquivos gitignored (por exemplo, assumindo que .gitignore esteja no diretório de trabalho ou abaixo):
ug --ignore-files -tc++ -nkw main
Para listar todos os arquivos no diretório de trabalho e mais profundos que não são ignorados pelos arquivos .gitignore :
ug --ignore-files -l ''
Para exibir a lista de extensões de nome de arquivo e "bytes mágicos" (shebangs) que são pesquisados correspondentes aos argumentos -t :
ug -tlist
Para listar todos os arquivos shell recursivamente, com base em extensões e shebangs com -l (observe que '' corresponde a qualquer arquivo não vazio):
ug -l -tShell ''
? Voltar ao índice
Para pesquisar main no código-fonte enquanto ignora strings e blocos de comentários, você pode usar padrões negativos com a opção -N para pular correspondências indesejadas em strings entre aspas e blocos de comentários em C/C++:
ug -r -nkw -e 'main' -N '"(\.|\r?n|[^\n"])*"|//.*|/*(.*n)*?.**+/' myproject
É muito trabalhoso digitar corretamente! Se você for como eu, não quero perder tempo brincando com padrões de regex quando estiver trabalhando em algo mais importante. Existe uma maneira mais fácil usando os padrões predefinidos ( -f ) do Ugrep que são instalados com a ferramenta ugrep :
ug -r -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
Esta consulta também pesquisa em outros arquivos que não o código -fonte C/C ++, como ReadMes, Makefiles e assim por diante. Também estamos pulando symblinks com -r . Então, vamos refinar esta consulta selecionando arquivos C/C ++ apenas usando opção -tc,c++ e incluir symblinks em arquivos e diretórios com -R :
ug -R -tc,c++ -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
E se você quiser procurar apenas o identificador main , mas não como uma função main( ? Nesse caso, use um padrão negativo para que isso pular para mainh*( padrão corresponde:
ug -R -tc,c++ -nkw -e 'main' -N 'mainh*(' -f c/zap_strings -f c/zap_comments myproject
Isso usa as opções -e e -N para especificar explicitamente um padrão e um padrão negativo, respectivamente, que está essencialmente formando o padrão main|(?^mainh*() , onde h corresponde ao espaço e na guia. Em geral , padrões negativos são úteis para filtrar correspondências de padrões nas quais não estamos interessados.
Como outro exemplo, digamos que queremos procurar o Word FIXME em blocos de comentários C/C ++. Para isso, podemos primeiro selecionar os blocos de comentários com o padrão c/comments predefinidos do Ugrep e depois selecionar linhas com FIXME usando um tubo:
ug -R -tc,c++ -nk -f c/comments myproject | ug -w 'FIXME'
Os resultados da filtragem com os tubos geralmente são mais fáceis do que usar e a lógica ou que algumas ferramentas de pesquisa usam. Essa abordagem segue o espírito Unix para simplificar os utilitários e usá -los em combinação para tarefas mais complexas.
Vamos produzir uma lista classificada de todos os identificadores encontrados no código -fonte do Java enquanto pulava strings e comentários:
ug -R -tjava -f java/names myproject | sort -u
Isso corresponde aos identificadores Java Unicode usando o regex p{JavaIdentifierStart}p{JavaIdentifierPart}* definido em patterns/java/names .
Com as ferramentas tradicionais do tipo grep e grep, é necessário um grande esforço para procurar recursivamente o arquivo de origem C/C ++ que define o qsort da função, exigindo algo assim:
ug -R --include='*.c' --include='*.cpp' '^([ t]*[[:word:]:*&]+)+[ t]+qsort[ t]*([^;n]+$' myproject
Felizmente, com o Ugrep, podemos simplesmente selecionar todas as definições de função em arquivos com extensão .c ou .cpp usando opção -Oc,cpp e usando functions de padrão predefinido instaladas com a ferramenta para produzir todas as definições de função. Então selecionamos o que queremos:
ug -R -Oc,cpp -nk -f c/functions | ug 'qsort'
Observe que poderíamos ter usado -tc,c++ para selecionar arquivos C/C ++, mas isso também inclui arquivos de cabeçalho quando queremos pesquisar apenas arquivos .c e .cpp .
Também podemos pular arquivos e diretórios de serem pesquisados que estão definidos no .gitignore . Para fazer isso, usamos --ignore-files para excluir quaisquer arquivos e diretórios de pesquisas recursivas que correspondam aos globs no .gitignore , quando um ou mais arquivos .gitignore são encontrados:
ug -R -tc++ --ignore-files -f c++/defines
Isso pesquisa arquivos C ++ ( -tc++ ) no diretório de trabalho das linhas #define ( -f c++/defines ), enquanto ignorava arquivos e diretórios declarados no .gitignore . Se você achar isso muito tempo para digitar, defina um alias para pesquisar diretórios do GitHub:
alias ugit='ugrep -R --ignore-files'
ugit -tc++ -f c++/defines
Para destacar as partidas quando empurradas através de uma cadeia de tubos, devemos usar --color=always :
ugit --color=always -tc++ -f c++/defines | ugrep -w 'FOO.*'
Isso retorna uma lista bem iluminada de todas as macros #define FOO... em arquivos de código-fonte C/C ++, pulando arquivos definidos no .gitignore .
Observe que o complemento de --exclude não é --include , porque as exclusões sempre têm precedência sobre inclusões; portanto, não podemos listar com segurança os arquivos que são ignorados com --include-from='.gitignore' . Somente arquivos especificados explicitamente com --include e os diretórios especificados explicitamente com --include-dir são visitados. O --include-from do Lists Globs que são considerados arquivos e diretórios a serem adicionados a --include e --include-dir , respectivamente. Isso significa que, quando os nomes de diretórios e os caminhos de diretório não são listados explicitamente neste arquivo, ele não será visitado usando --include-from .
Como o Ugrep verifica se a entrada é válida unicode codificada por UTF (a menos que -U seja usado), é possível usá-lo como um filtro para ignorar a saída não-UTF produzida por um programa:
program | ugrep -I ''
Se o programa produzir uma saída válida, a saída será passada, caso contrário, a saída será filtrada opção -I . Se a saída for inicialmente válida para uma parte muito grande, mas for seguida pela saída inválida, o UGREP poderá mostrar inicialmente a saída até, mas excluindo a saída inválida após a qual a saída adicional é bloqueada.
Filtrar linhas que são codificadas por ASCII ou UTF válidas, enquanto remove as linhas que não são:
program | ugrep '[p{Unicode}--[n]]+'
Observe que p{Unicode} corresponde a n , mas não queremos combinar o arquivo inteiro! Apenas linhas com [p{Unicode}--[n]]+ .
? Voltar para o índice
A página do homem do Ugrep:
man ugrep
Para mostrar uma página de ajuda:
ug --help
Para mostrar opções que mencionam WHAT :
ug --help WHAT
Para mostrar uma lista dos valores de opção -t TYPES :
ug -tlist
Na consulta interativa TUI, pressione F1 ou Ctrl-Z para obter ajuda e opções:
ug -Q
? Voltar para o índice
--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.
O comando ug destina-se à pesquisa interativa dependente do contexto e é equivalente ao comando ugrep --config para carregar o arquivo de configuração .ugrep quando presente no diretório de trabalho ou, quando não for encontrado, no diretório doméstico:
ug PATTERN ...
ugrep --config PATTERN ...
O comando ug também classifica os arquivos por nome por diretório pesquisado. Um arquivo de configuração contém NAME=VALUE por linha, onde NAME é o nome de uma opção longa (sem -- ) e =VALUE é um argumento, que é opcional e pode ser omitido, dependendo da opção. Linhas e linhas vazias começando com um # são ignoradas:
# 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
As opções da linha de comando são analisadas na seguinte ordem: Primeiro, o arquivo de configuração (padrão ou nomeado) é carregado, depois as opções e argumentos restantes na linha de comando são analisados.
Opção --stats Exibe o arquivo de configuração usado após a pesquisa.
Os arquivos de configuração nomeados destinam-se a otimizar tarefas de pesquisa personalizadas, reduzindo o número de opções de linha de comando para apenas um ---FILE para usar a coleta de opções especificadas no FILE . A opção --config=FILE e seu formulário abreviado ---FILE carregam o arquivo de configuração especificada localizada no diretório de trabalho ou, quando não encontrado, localizado no diretório doméstico:
ug ---FILE PATTERN ...
ugrep ---FILE PATTERN ...
Um erro é produzido quando FILE não é encontrado ou não pode ser lido.
Os arquivos de configuração nomeados podem ser usados para definir uma coleção de opções específicas para os requisitos de uma tarefa no fluxo de trabalho de desenvolvimento de um projeto. Por exemplo, para relatar problemas não resolvidos, verificando o código -fonte e a documentação para comentários com itens FixMe e TODO. Esse arquivo de configuração nomeado pode ser localizado em um projeto, colocando -o no diretório do projeto, ou pode ser tornado global colocando -o no diretório doméstico. Para feedback visual, um esquema de cores específico para esta tarefa pode ser especificado com colors da opção no FILE configuração para ajudar a identificar a saída produzida por uma configuração nomeada em oposição à configuração padrão.
A opção --save-config salva um arquivo de configuração .ugrep no diretório de trabalho usando a configuração atual carregada com --config . Isso salva a configuração atual combinada com opções adicionais quando especificada também. Somente as opções que não podem entrar em conflito com outras opções e opções que não podem impactar negativamente os resultados da pesquisa serão salvos.
A opção --save-config=FILE salva a configuração no FILE especificado. A configuração é gravada na saída padrão quando FILE é a - .
Como alternativa, um arquivo de configuração pode ser criado manualmente ou modificado. Um arquivo de configuração pode incluir um ou mais config[=FILE] para carregar indiretamente o FILE especificado, mas é proibido o carregamento de configuração recursiva. A maneira mais simples de fabricar um arquivo de configuração é especificar config na parte superior do arquivo, seguida pelas longas opções para substituir os padrões.
? Voltar para o índice
-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 opção inicia uma interface do usuário para inserir padrões de pesquisa interativamente:
-c contagem de correspondências. Pressionar Alt -C novamente desativa -c . As opções podem ser alternadas com a tecla Alt enquanto pesquisam ou ao visualizar a tela de ajuda. Se as teclas Alt/Meta não forem suportadas (por exemplo, x11 xterm), pressione Ctrl-O seguido pela tecla correspondente à opção.-g e o diretório Matching Globs, uma lista separada por vírgula dos padrões globais no estilo Gitignore. Pressioning ESC retorna o controle do prompt de padrão de consulta (os globs são salvos). Quando um globo é precedido por A ! ou a ^ , pula os arquivos cujo nome corresponde ao glob quando um glob contém / de caminho completos são correspondidos. Caso contrário, os nomes de basenas são correspondidos. Quando um glob termina com A / , os diretórios são comparados.Q> (normal), F> (cadeias fixas), G> (regex básico), P> (correspondência perl) e Z> (correspondência difusa). Quando o prompt --glob= é mostrado, uma lista separada por vírgula dos padrões globais no estilo Gitignore pode ser inserida. Pressionar ESC retorna o controle do prompt de padrão.--view .--view=COMMAND . Caso contrário, as variáveis de ambiente PAGER ou EDITOR são usadas para invocar o comando com Ctrl-Y. Os nomes de arquivos devem ser ativados e visíveis na saída para usar esse recurso.--color .DELAY como 1. No entanto, valores mais baixos podem aumentar a carga do sistema como resultado de iniciar e cancelar pesquisas repetidamente por cada tecla pressionada.--heading é ativado por padrão. Pressione Alt-+ para desligar os títulos.Consulta o mapeamento de chaves tui:
| Chave (s) | função |
|---|---|
Alt-key | alternar a opção de linha de comando ugrep correspondente à key |
Alt-/ xxxx / | Insira Unicode Código HEX PONTO U+XXXX |
Esc Ctrl-C | Voltar ou sair |
Ctrl-Q | saída rápida e saída dos resultados selecionados no modo de seleção |
Tab | Chdir para o diretório do arquivo mostrado na parte superior da tela ou selecione Arquivo |
Shift-Tab | Chdir One Level Up ou desmarcar arquivo |
Enter | Digite o modo de seleção e alterne as linhas selecionadas para a saída na saída |
Up Ctrl-P | subir |
Down Ctrl-N | descer |
Ctrl-B Left | mover para a esquerda |
Ctrl-F Right | mova para a direita |
PgUp Ctrl-G | Mova a exibição por uma página |
PgDn Ctrl-D | Mova a exibição para baixo por uma página |
Alt-Up | Mova a exibição em 1/2 página (MacOS Shift-Up ) |
Alt-Down | Mova a exibição para baixo por 1/2 página (MacOS Shift-Down ) |
Alt-Left | Mova o visor esquerdo por 1/2 página (MacOS Shift-Left ) |
Alt-Right | Mova a exibição direita por 1/2 página (MacOS Shift-Right ) |
Home Ctrl-A | Mova o cursor para o início da linha |
End Ctrl-E | Mova o cursor para o final da linha |
Ctrl-K | Exclua depois do cursor |
Ctrl-L | Tela de atualização |
key Ctrl-O + | alterne a opção de linha de comando ugrep correspondente à key , igual à Alt-key |
Ctrl-R F4 | Salte para o favorito |
Ctrl-S | Salte para o próximo dir/arquivo/contexto |
Ctrl-T F5 | Tecla de alternância ( --split inicia um tui de tela dividida) |
Ctrl-U | Exclua antes do cursor |
Ctrl-V | personagem literal |
Ctrl-W | Voltar para trás um dir/arquivo/contexto |
Ctrl-X F3 | Conjunto de marcadores |
Ctrl-Y F2 | visualizar ou editar o arquivo mostrado na parte superior da tela |
Ctrl-Z F1 | Ver ajuda e opções |
Ctrl-^ | chdir de volta ao diretório de trabalho inicial |
Ctrl-] | Alterne a cor/mono |
Ctrl- | terminar o processo |
Para pesquisar interativamente os arquivos no diretório de trabalho e abaixo:
ug -Q
O mesmo, mas restrito apenas a arquivos C ++ e ignorando arquivos .gitignore :
ug -Q -tc++ --ignore-files
Para pesquisar interativamente todos os modos no diretório de trabalho e abaixo:
ug -Q -g 'Makefile*' -g 'makefile*'
O mesmo, mas para até 2 níveis de diretório (funcionando e um nível de subdiretório):
ug -Q -2 -g 'Makefile*' -g 'makefile*'
Para visualizar interativamente o conteúdo do main.cpp e pesquisá -lo, onde -y mostra quaisquer linhas que não sejamtem como contexto:
ug -Q -y main.cpp
Para pesquisar interativamente main.cpp , começando com o padrão de pesquisa TODO e um contexto de correspondência de 5 linhas (o contexto pode ser ativado e desativado interativamente, isso também substitui o tamanho do contexto padrão de 2 linhas):
ug -Q -C5 -e TODO main.cpp
Para visualizar e pesquisar o conteúdo de um arquivo (por exemplo, zip, tarball):
ug -Q -z archive.tar.gz
Para selecionar interativamente os arquivos do project.zip para descomprimir com unzip , usando o modo de seleção de consulta do Ugrep (pressione Enter para selecionar linhas):
unzip project.zip `zipinfo -1 project.zip | ugrep -Q`
? Voltar para o índice
-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.
Se nenhum argumento de arquivo for especificado e a entrada for lida em um terminal, as pesquisas recursivas serão executadas como se -r fosse especificado. Para forçar a leitura da entrada padrão, especifique - como o argumento do arquivo.
Para listar recursivamente todos os arquivos não vazios no diretório de trabalho:
ug -r -l ''
Para listar todos os arquivos não vazios no diretório de trabalho, mas não mais profundo (já que um argumento de arquivo é fornecido, neste caso . Para o diretório de trabalho):
ug -l '' .
Para listar todos os arquivos não vazios no diretório mydir , mas não mais profundo (já que um argumento de arquivo é fornecido):
ug -l '' mydir
Para listar todos os arquivos não vazios no diretório mydir e mais profundamente, seguindo symblinks:
ug -R -l '' mydir
Para listar recursivamente todos os arquivos não vazios no caminho especificado, ao visitar apenas subdiretos, ou seja, diretórios mydir/ e subdiretórios em um nível mais profundo mydir/*/ são visitados (observe que -2 -l pode ser abreviado para -l2 ):
ug -2 -l '' mydir
Para listar recursivamente todos os arquivos não vazios no diretório mydir , sem seguir links simbólicos (exceto quando na linha de comando como mydir ):
ug -rl '' mydir
Para listar recursivamente todos os modos que correspondem ao texto CPP :
ug -l -tmake 'CPP'
Para listar recursivamente todos Makefile.* Combinando bin_PROGRAMS :
ug -l -g'Makefile.*' 'bin_PROGRAMS'
Para listar recursivamente todos os arquivos não vazios com extensão .sh, com -Osh :
ug -l -Osh ''
Para listar recursivamente todos os scripts de shell com base em extensões e shebangs com -tShell :
ug -l -tShell ''
Para listar recursivamente todos os scripts de shell com base em extensões apenas com -tshell :
ug -l -tshell ''
? Voltar para o índice
--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.
Observe que as opções --and , --not e --andnot requerem -e PATTERN .
A opção -% faz com que todos os padrões sejam baseados em booleanos, apoiando as seguintes operações lógicas listadas do nível mais alto de precedência ao menor:
| operador | alternativa | resultado |
|---|---|---|
"x" | Combine x literalmente e exatamente como especificado (usando as escapadas de regex padrão Q e E ) | |
( ) | Agrupamento de expressão booleana | |
-x | NOT x | partida invertida, ou seja, corresponde se x não corresponder |
x|y | x OR y | combina linhas com x ou y |
xy | x AND y | combina linhas com x e y |
x e y são subpadras que não começam com os símbolos especiais | , - e ( (use citações ou escape para corresponder a elas);
- NOT são iguais e precedência sobre OR , o que significa que -x|y == (-x)|y por exemplo.
| e OR são iguais e precedem AND , o que significa que xy|z == x (y|z) por exemplo;
A opção --stats exibe as consultas booleanas na forma legível pelo homem convertida em CNF (forma normal conjuntiva), após a conclusão da pesquisa. Para mostrar o CNF sem pesquisa, leia a partir de entrada padrão terminada por um EOF, como echo | ugrep -% '...' --stats .
Os subpadrões são bem iluminados na saída, exceto aqueles negados com NOT (um NOT subpaterno ainda pode aparecer em uma linha correspondente ao usar um padrão ou não ou não como x|-y ). Observe que os subpadrões podem se sobrepor. Nesse caso, apenas o primeiro subpadrão de correspondência é bem iluminado por cores.
Várias linhas podem ser correspondidas quando os subpadras correspondem às novas linhas. No entanto, há uma exceção: os subpadras terminando com (?=X) lookaheads podem não corresponder quando X abrange várias linhas.
Padrões vazios correspondem a qualquer linha (padrão grep). Portanto, -% 'x|""|y' corresponde tudo e x e y não são bem iluminados por cores. A opção -y deve ser usada para mostrar todas as linhas como contexto, por exemplo -y 'x|y' .
Consulta interativa do tipo FZF (pesquisa booleana com strings fixos com correspondência difusa para permitir, por exemplo, até 4 caracteres extras combinados com -Z+4 em palavras com -w ), pressione a guia e alt -y para visualizar um arquivo com correspondências. Pressione Shift-Tab e Alt-L para voltar à lista de arquivos correspondentes:
ug -Q -%% -l -w -F -Z+4 --sort=best
Para encontrar recursivamente todos os arquivos que contêm o hot e dog em qualquer lugar do arquivo com opção --files :
ug -%% 'hot dog'
ug --files -e hot --and dog
Para encontrar linhas contendo hot e dog em myfile.txt :
ug -% 'hot dog' myfile.txt
ug -e hot --and dog myfile.txt
Para encontrar linhas que contêm place e também hotdog ou taco (ou ambos) em myfile.txt :
ug -% 'hotdog|taco place' myfile.txt
ug -e hotdog -e taco --and place myfile.txt
Mesmo, mas exclua linhas combinando diner :
ug -% 'hotdog|taco place -diner' myfile.txt
ug -e hotdog -e taco --and place --andnot diner myfile.txt
Para encontrar linhas com diner ou linhas que correspondam fast e com food , mas não bad no myfile.txt :
ug -% 'diner|(fast food -bad)' myfile.txt
Para encontrar linhas com fast food (exatamente) ou linhas com diner , mas não bad ou old em myfile.txt :
ug -% '"fast food"|diner -bad -old' myfile.txt
O mesmo, mas usando uma expressão booleana diferente que tem o mesmo significado:
ug -% '"fast food"|diner -(bad|old)' myfile.txt
Para encontrar linhas com diner implicando good no myfile.txt (ou seja, mostrar linhas com good sem diner e mostrar linhas com diner , mas apenas aqueles com good , que está logicamente implícito!):
ug -% 'good|-diner' myfile.txt
ug -e good --not diner myfile.txt
Para encontrar linhas com foo e -bar e "baz" em myfile.txt (não isso - " devem ser correspondidos usando escapes e com --and -e -bar ):
ug -% 'foo -bar "baz"' myfile.txt
ug -e foo --and -e -bar --and '"baz"' myfile.txt
Para pesquisar myfile.cpp por linhas com TODO ou FIXME , mas não ambos na mesma linha, como XOR:
ug -% 'TODO|FIXME -(TODO FIXME)' myfile.cpp
ug -e TODO -e FIXME --and --not TODO --not FIXME myfile.cpp
? Voltar para o índice
-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 $.
Veja também padrões de consulta booleanos com -%, -%%, e, -não para opções de consulta booleanas mais poderosas do que as opções tradicionais de GNU/BSD Grep.
Para exibir linhas no arquivo myfile.sh , mas não linhas correspondentes ^[ t]*# :
ug -v '^[ t]*#' myfile.sh
Para pesquisar myfile.cpp por linhas com FIXME e urgent , mas não Scotty :
ugrep FIXME myfile.cpp | ugrep urgent | ugrep -v Scotty
O mesmo, mas usando -% para consultas booleanas:
ug -% 'FIXME urgent -Scotty' myfile.cpp
Para procurar decimais usando padrão d+ que não começam com 0 usando o padrão negativo 0d+ e excluindo 555 :
ug -e 'd+' -N '0d+' -N 555 myfile.cpp
Para procurar palavras que começam com disp sem corresponder display no arquivo myfile.py usando um "padrão negativo" -N '/<display>' onde -N especifica um padrão negativo adicional para pular correspondências:
ug -e '<disp' -N '<display>' myfile.py
Para procurar linhas com a display da palavra no arquivo myfile.py pulando essa palavra em strings e comentários, onde -f especifica padrões em arquivos que são padrões predefinidos neste caso:
ug -n -w 'display' -f python/zap_strings -f python/zap_comments myfile.py
Para exibir linhas que não são linhas em branco:
ug -x -e '.*' -N 'h*' myfile.py
O mesmo, mas usando -v e -x com h* , ou seja, padrão ^h*$ :
ug -v -x 'h*' myfile.py
Para listar recursivamente todos os arquivos Python que não contêm a display do Word, permitindo que a palavra ocorra em strings e comentários:
ug -RL -tPython -w 'display' -f python/zap_strings -f python/zap_comments
? Voltar para o índice
--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.)
Os arquivos binários, ASCII e UTF-8 não exigem essa opção para pesquisá-los. Além disso, os arquivos UTF-16 e UTF-32 não exigem essa opção para pesquisá-los, assumindo que os arquivos UTF-16 e UTF-32 começam com um BOM UTF (marca de pedidos de byte) como de costume. Outras codificações de arquivo requerem opção --encoding=ENCODING :
| codificação | parâmetro |
|---|---|
| ASCII | n / D |
| UTF-8 | n / D |
| UTF-16 com Bom | n / D |
| UTF-32 com Bom | n / D |
| UTF-16 seja sem nascer | UTF-16 ou UTF-16BE |
| UTF-16 LE W/O BOM | UTF-16LE |
| UTF-32 sem nascer | UTF-32 ou UTF-32BE |
| UTF-32 sem nascer | UTF-32LE |
| Latin-1 | LATIN1 ou 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 do Windows Página 1250 | CP1250 |
| Código do Windows Página 1251 | CP1251 |
| Código do Windows Página 1252 | CP1252 |
| Código do Windows Página 1253 | CP1253 |
| Código do Windows Página 1254 | CP1254 |
| Código do Windows Página 1255 | CP1255 |
| Código do Windows Página 1256 | CP1256 |
| Código do Windows Página 1257 | CP1257 |
| Código do Windows Página 1258 | CP1258 |
| KOI8-R | KOI8-R |
| Koi8-U | KOI8-U |
| KOI8-RU | KOI8-RU |
Observe que os padrões REGEX são sempre especificados no UTF-8 (inclui ASCII). Para pesquisar arquivos binários com padrões binários, consulte pesquisar e exibir arquivos binários com -u, -w e -x.
Para listar recursivamente todos os arquivos que são ASCII (ou seja, 7 bits):
ug -L '[^[:ascii:]]'
Para listar recursivamente todos os arquivos não-ASCII, ou seja, arquivos UTF-8, UTF-16 e UTF-32 com caracteres não-ASCII Unicode (U+0080 e UP):
ug -l '[^[:ascii:]]'
Para verificar se um arquivo contém unicode não-ASCII (U+0080 e UP):
ug -q '[^[:ascii:]]' myfile && echo "contains Unicode"
Para remover os caracteres Unicode inválidos de um arquivo (observe que -o pode não funcionar porque os dados binários são detectados e rejeitados e as linhas de novo são adicionadas, mas --format="%o% não verifica o binário e copia a correspondência" como está " ):
ug "[p{Unicode}n]" --format="%o" badfile.txt
Para listar recursivamente os arquivos com conteúdo UTF inválido (ou seja, sequências ou arquivos inválidos de UTF-8 bytes que contêm quaisquer pontos de código UTF-8/16/32 que estejam fora do intervalo unicode válido) correspondendo a qualquer ponto de código com . e usando um padrão negativo -N 'p{Unicode}' para ignorar cada caractere unicode válido:
ug -l -e '.' -N 'p{Unicode}'
Para exibir linhas contendo emojis de rosto rindo:
ug '[?-?]' emojis.txt
Os mesmos resultados são obtidos usando x{hhhh} para selecionar um intervalo de caracteres Unicode:
ug '[x{1F600}-x{1F60F}]' emojis.txt
Para exibir linhas que contêm os nomes Gödel (ou Goedel), Escher ou Bach:
ug 'G(ö|oe)del|Escher|Bach' GEB.txt wiki.txt
Para procurar lorem em minúsculas ou maiúsculas em um arquivo UTF-16 marcado com um Bom UTF-16:
ug -iw 'lorem' utf16lorem.txt
Para pesquisar UTF16lorem.txt quando este arquivo não tem Bom UTF-16, usando --encoding :
ug --encoding=UTF-16 -iw 'lorem' utf16lorem.txt
Para pesquisar o arquivo spanish-iso.txt codificado na ISO-8859-1:
ug --encoding=ISO-8859-1 -w 'año' spanish-iso.txt
? Voltar para o índice
-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.
Várias linhas podem ser correspondidas por padrões que correspondem aos caracteres da Newline. Use a opção -o para produzir apenas a correspondência, não as linhas completas que correspondem.
Para corresponder a uma quebra de linha n , inclua n no padrão para corresponder ao caractere LF. Se você deseja corresponder às quebras da linha rn e n , use r?n ou simplesmente use R para corresponder a alguma quebra de linha unicode rn , r , v , f , n , u +0085, U+2028 e U+2029.
Para corresponder a C/C ++ /*...*/ Comentários de várias linhas:
ug '/*(.*n)*?.**+/' myfile.cpp
Para corresponder aos comentários C/C ++ usando os padrões c/comments predefinidos com -fc/comments , restritos à parte correspondente apenas com a opção -o :
ug -of c/comments myfile.cpp
O mesmo que sed -n '/begin/,/end/p' : para corresponder a todas as linhas entre uma linha que contém begin e a primeira linha após o end contendo, usando repetição preguiçosa:
ug -o '.*begin(.|n)*?end.*' myfile.txt
? Voltar para o índice
-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 exibir duas linhas de contexto antes e depois de uma linha correspondente:
ug -C2 'FIXME' myfile.cpp
Para mostrar três linhas de contexto após uma linha correspondente:
ug -A3 'FIXME.*' myfile.cpp:
Para exibir uma linha de contexto antes de cada linha correspondente com uma definição de função C (n nomes C não unicode):
ug -B1 -f c/functions myfile.c
Para exibir uma linha de contexto antes de cada linha correspondente com uma definição de função C ++ (nomes C ++ podem ser unicode):
ug -B1 -f c++/functions myfile.cpp
Para exibir quaisquer linhas não correspondentes como contexto para corresponder linhas com -y :
ug -y -f c++/functions myfile.cpp
Para exibir um hexdump de uma linha correspondente com uma linha de contexto de hexdump:
ug -C1 -UX 'xaaxbbxcc' a.out
O contexto dentro de uma linha é exibido com a opção -o com uma opção de contexto:
ug -o -C20 'pattern' myfile.cpp
O mesmo, mas com uma saída bonita com títulos, números de linha e números de colunas ( -k ) e mostrando o contexto:
ug --pretty -oC20 'pattern' myfile.cpp
? Voltar para o índice
-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.
Os tipos de arquivo estão listados com ugrep -tlist . A lista é baseada em extensões de nome de arquivo estabelecidas e "bytes mágicos". Se você tiver um tipo de arquivo que não estiver listado, use opções -O e/ou -M . Você pode definir um pseudônimo, por exemplo, alias ugft='ugrep -Oft' como uma abreviação de pesquisar arquivos com o sufixo do nome do arquivo .ft .
Para exibir recursivamente as definições de função nos arquivos C/C ++ ( .h , .hpp , .c , .cpp etc.) com números de linha com -tc++ , -o , -n e -f c++/functions :
ug -on -tc++ -f c++/functions
Para exibir recursivamente as definições de função nos arquivos .c e .cpp com números de linha com -Oc,cpp , -o , -n e -f c++/functions :
ug -on -Oc,cpp -f c++/functions
Para listar recursivamente todos os arquivos shell com -tShell para combinar com extensões de nome do arquivo e arquivos com shebangs Shell, exceto arquivos com sufixo .sh :
ug -l -tShell -O^sh ''
Para listar recursivamente todos os arquivos que não são de casca com -t^Shell :
ug -l -t^Shell ''
Para listar recursivamente todos os arquivos Shell com shebangs do Shell que não possuem extensões de nome de arquivo Shell:
ug -l -tShell -t^shell ''
Para procurar linhas com FIXME nos comentários C/C ++, excluindo FIXME em Strings multi-line:
ug -n 'FIXME' -f c++/zap_strings myfile.cpp
Para ler os padrões TODO e FIXME da entrada padrão para corresponder linhas na entrada, ao mesmo tempo em que exclui as correspondências em strings C ++:
ug -on -f - -f c++/zap_strings myfile.cpp <<END
TODO
FIXME
END
Para exibir o elemento XML e as tags de atributo em um arquivo XML, restritas à parte correspondente com -o , excluindo tags que são colocadas em comentários (multi -line):
ug -o -f xml/tags -f xml/zap_comments myfile.xml
? Voltar para o índice
-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.
Arquivos compactados com gzip ( .gz ), compact ( .Z ), bzip2 ( .bz , .bz2 , .bzip2 ), lzma ( .lzma ), xz ( .xz ), lz4 ( .lz4 ), zstd ( .zst , .zstd ), brotli ( .br ) e bzip3 ( .bz3 ) são pesquisados com a opção -z quando as bibliotecas correspondentes são instaladas e compiladas com o ugrep. Esta opção não exige que os arquivos sejam compactados. Os arquivos não compactados também são pesquisados, embora mais lentos.
Outros formatos de compactação podem ser pesquisados com filtros Ugrep .
Os arquivos (CPIO, JAR, PAX, TAR, ZIP e 7Z) são pesquisados com a opção -z . Arquivos regulares em um arquivo que corresponde são emitidos com os nomes de caminhos de arquivo fechados em aparelhos { e } . Os formatos de alcatrão suportados são V7, USTAR, GNU, Oldgnu e Pax. Os formatos de CPIO suportados são ODC, Newc e CRC. Não suportado é o formato binário antigo não portável e não portável. Os formatos de arquivo CPIO, TAR e PAX são automaticamente reconhecidos com a opção -z com base em seu conteúdo, independentemente do sufixo do nome do arquivo.
Por padrão, os arquivos não compactados armazenados nos arquivos ZIP também são pesquisados: todos os arquivos CPIO, PAX e TAR armazenados nos arquivos ZIP e 7Z são reconhecidos e pesquisados automaticamente. No entanto, por padrão, os arquivos compactados armazenados nos arquivos não são reconhecidos, por exemplo, os arquivos ZIP armazenados nos arquivos TAR não são pesquisados, mas todos os arquivos e arquivos compactados são pesquisados como se fossem arquivos binários sem descomprimi -los.
Especifique --zmax=NUM para pesquisar arquivos que contêm arquivos e arquivos compactados para até os NUM níveis de profundidade. O valor de NUM pode variar de 1 a 99 para até 99 etapas de descompressão e desarboração para expandir até 99 arquivos aninhados. Maiores --zmax=NUM degradam o desempenho. É improvável que você precise de 99 como --zmax=2 é suficiente para a maioria dos casos de uso prático, como a pesquisa de arquivos ZIP armazenados em arquivos alcatrão.
Quando a opção -z é usada com opções -g , -O , -M ou -t , arquivos e arquivos compactados e não compactados que correspondem aos critérios de seleção do nome do arquivo (GLOB, extensão, bytes mágicos ou tipo de arquivo) são pesquisados apenas. Por exemplo, ugrep -r -z -tc++ pesquisa arquivos C ++, como os arquivos main.cpp e zip e alcatrão que contêm arquivos C ++ como main.cpp . Também estão incluídos na pesquisa arquivos C ++ compactados como main.cpp.gz e main.cpp.xz quando presentes. Além disso, os arquivos CPIO, PAX, TAR, ZIP e 7Z, quando presentes, são pesquisados por arquivos C ++ que eles contêm, como main.cpp . Use a opção --stats para ver uma lista dos padrões do GLOB aplicados para filtrar nomes de caminhos de arquivo na pesquisa recursiva e ao pesquisar conteúdos de arquivo.
Quando a opção -z é usada com opções -g , -O , -M ou -t para pesquisar arquivos CPIO, JAR, PAX, TAR, ZIP e 7Z, arquivos arquivados que correspondem aos critérios de seleção do nome do arquivo são pesquisados apenas.
Os formatos GZIP, compactação e Zip são detectados automaticamente, o que é útil ao ler dados compactados por GZIP da entrada padrão, por exemplo, entrada redirecionada de um tubo. Outros formatos de compressão requerem um sufixo de nome de arquivo: .bz , .bz2 ou .bzip2 para bzip2, .lzma para lzma, .xz para xz, .lz4 para lz4, .zst ou .zstd para zstd, .br para brotli e .bz3 para BZIP3. Também os abrevinos de arquivamento de alcatrão compactados .taz , .tgz e .tpz para GZIP, .tbz , .tbz2 , .tb2 e .tz2 para bzip2, .tlz para lzma, .txz para xz e .tzst para zstd são reconhecidos. Para pesquisar esses formatos com ugrep a partir de entrada padrão, use a opção --label='stdin.bz2' para bzip2, --label='stdin.lzma' para lzma, --label='stdin.xz' para xz, --label='stdin.lz4 para lz4 e --label='stdin.zst para zstd e assim por diante. O nome stdin é arbitrário e pode ser omitido:
| formatar | Nome do arquivo sufixo | Sufixo curto do arquivo Tar/Pax | Sufixo necessário? | Ugrep de Stdin | biblioteca |
|---|---|---|---|---|---|
| gzip | .gz | .taz , .tgz , .tpz | não | automático | Libz |
| compressa | .Z | .taZ , .tZ | não | automático | embutido |
| zip | .zip , .zipx , .ZIP | não | automático | Libz | |
| 7zip | .7z | sim | --label=.7z | embutido | |
| BZIP2 | .bz , .bz2 , .bzip2 | .tb2 , .tbz , .tbz2 , .tz2 | sim | --label=.bz2 | libbz2 |
| lzma | .lzma | .tlz | sim | --label=.lzma | Liblzma |
| xz | .xz | .txz | sim | --label=.xz | Liblzma |
| LZ4 | .lz4 | sim | --label=.lz4 | liblz4 | |
| zstd | .zst , .zstd | .tzst | sim | --label=.zst | libzstd |
| Brotli | .br | sim | --label=.br | libbrotlidec | |
| BZIP3 | .bz3 | sim | --label=.bz3 | libbzip3 |
Os formatos GZIP, BZIP2, XZ, LZ4 e ZSTD suportam arquivos compactados concatenados. Os arquivos compactados concatenados são pesquisados como um único arquivo.
Os métodos de compressão ZIP suportados são armazenados (0), deflate (8), BZIP2 (12), LZMA (14), XZ (95) e ZSTD (93). Os métodos BZIP2, LZMA, XZ e ZSTD exigem que o UGREP seja compilado com as bibliotecas de compressão correspondentes.
A busca de arquivos ZIP criptografados não é suportada (talvez em lançamentos futuros, dependendo de solicitações de aprimoramentos).
A pesquisa de arquivos 7ZIP leva muito mais RAM e mais tempo em comparação com outros métodos. A implementação 7ZIP LZMA SDK não suporta streaming, exigindo um arquivo 7Z procurável físico. Isso significa que os arquivos 7Z não podem ser pesquisados quando aninhados nos arquivos. O melhor é evitar o 7ZIP. O suporte ao 7ZIP pode ser desativado com ./build.sh --disable-7zip para criar o ugrep.
Opção -z usa threads para o paralelismo da tarefa para acelerar a pesquisa de arquivos maiores executando o descompressor simultaneamente com uma pesquisa do fluxo descomprimido.
Para listar todos os arquivos não vazios armazenados em um arquivo package.zip , incluindo o conteúdo de todos os arquivos CPIO, PAX, TAR, ZIP e 7Z que são armazenados nele:
ug --zmax=2 -z -l '' package.zip
O mesmo, mas liste apenas os arquivos de código -fonte do Python, incluindo scripts que invocam o Python, com opção -tPython ( ugrep -tlist para obter detalhes):
ug --zmax=2 -z -l -tPython '' package.zip
Para pesquisar os aplicativos Python distribuídos como um arquivo TAR com suas dependências, inclui como rodas (arquivos ZIP com código Python), pesquisando a palavra my_class em app.tgz :
ug --zmax=2 -z -tPython -w my_class app.tgz
Para pesquisar recursivamente os arquivos C ++, incluindo arquivos compactados pela palavra my_function , enquanto pula os comentários C e C ++:
ug -z -r -tc++ -Fw my_function -f cpp/zap_comments
Para pesquisar dados compactados BZIP2, LZMA, XZ, LZ4 e ZSTD sobre entrada padrão, opção --label pode ser usada para especificar a extensão correspondente ao formato de compressão para forçar a descompressão quando a extensão do BZIP2 não estiver disponível para o UGREP, por exemplo:
cat myfile.bz2 | ugrep -z --label='stdin.bz2' 'xyz'
Para pesquisar o arquivo main.cpp no project.zip por linhas TODO e FIXME :
ug -z -g main.cpp -w -e 'TODO' -e 'FIXME' project.zip
Para pesquisar Tarball project.tar.gz para arquivos C ++ com linhas TODO e FIXME :
ug -z -tc++ -w -e 'TODO' -e 'FIXME' project.tar.gz
Para pesquisar os arquivos que correspondem ao Glob *.txt no project.zip para a Word license em qualquer caso (observe que o argumento -g glob deve ser citado):
ug -z -g '*.txt' -w -i 'license' project.zip
Para exibir e página através de todos os arquivos C ++ no Tarball project.tgz :
ug --pager -z -tc++ '' project.tgz
Para listar os arquivos que correspondem ao Gitignore no estilo Glob /**/projects/project1.* em projects.tgz , selecionando arquivos contendo no arquivo o texto December 12 :
ug -z -l -g '/**/projects/project1.*' -F 'December 12' projects.tgz
Para visualizar os dados meta -inf/manifest.mf em um arquivo jar com -Ojar e -OMF para selecionar o arquivo JAR e o arquivo MF nele ( -Ojar é necessário, caso contrário, o arquivo JAR será ignorado, embora possamos lê -lo de partir de entrada padrão em vez disso):
ug -z -h -OMF,jar '' my.jar
Para extrair arquivos C ++ que contêm FIXME do project.tgz , usamos -m1 com --format="'%z '" para gerar uma lista separada por espaço de nomes de caminho do arquivo localizado no arquivo que corresponde à palavra FIXME :
tar xzf project.tgz `ugrep -z -l -tc++ --format='%z ' -w FIXME project.tgz`
Para realizar uma pesquisa de profundidade com find , use cpio e ugrep para pesquisar nos arquivos:
find . -depth -print | cpio -o | ugrep -z 'xyz'
? Voltar para o índice
--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 listar recursivamente todos os arquivos que começam com #! Shebangs:
ug -l -M'#!' ''
Para listar recursivamente todos os arquivos que começam com # , mas não com #! Shebangs:
ug -l -M'#' -M'^#!' ''
Para listar recursivamente todos os arquivos python (extensão .py ou uma shebang) com -tPython :
ug -l -tPython ''
Para listar recursivamente todos os arquivos que não são de casca com -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 exemplo:
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:
| padrão | partidas |
|---|---|
* | 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 | c | efeito | código | c | efeito |
|---|---|---|---|---|---|
| 0 | n | normal font and color | 2 | f | faint (not widely supported) |
| 1 | h | highlighted bold font | 21 | H | highlighted bold off |
| 4 | você | sublinhado | 24 | Você | underline off |
| 7 | eu | invert video | 27 | EU | invert off |
| 30 | k | black text | 90 | +k | bright gray text |
| 31 | R | texto vermelho | 91 | +r | bright red text |
| 32 | g | green text | 92 | +g | bright green text |
| 33 | sim | yellow text | 93 | +y | bright yellow text |
| 34 | b | blue text | 94 | +b | bright blue text |
| 35 | eu | magenta text | 95 | +m | bright magenta text |
| 36 | c | cyan text | 96 | +c | bright cyan text |
| 37 | c | texto branco | 97 | +w | bright white text |
| 40 | K | fundo preto | 100 | +K | bright gray background |
| 41 | R | dark red background | 101 | +R | bright red background |
| 42 | G | fundo verde escuro | 102 | +G | bright green background |
| 43 | S | dark yellow backgrounda | 103 | +Y | bright yellow background |
| 44 | B | fundo azul escuro | 104 | +B | bright blue background |
| 45 | M | dark magenta background | 105 | +M | bright magenta background |
| 46 | C | dark cyan background | 106 | +C | bright cyan background |
| 47 | C | 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:
| opção | 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| opção | format string (within quotes) |
|---|---|
--format-open | '%+' |
--format | '%[,]$%H%N%K%B%V%~%u' |
--json| opção | 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| opção | 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| opção | format string (within quotes) |
|---|---|
--format-open | '%+' |
--format | '%F%n%s%K%B%~%u' |
The following fields may be used in the FORMAT string:
| campo | saída |
|---|---|
%% | 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 |
Observação:
%~ 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 ψ :
| Padrão | Partidas |
|---|---|
x | matches the character x , where x is not a special character |
. | matches any single character except newline (unless in dotall mode) |
. | partidas . (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 ):
| Padrão | Partidas |
|---|---|
[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 | Partidas |
|---|---|
[: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 | Partidas |
|---|---|
. | 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
