ugrep
v7.1.1
[ BACA | Panduan Pengguna | Pengindeksan | Tolok Ukur | Tanya Jawab ]
opsi -Q membuka kueri TUI untuk mencari file saat Anda mengetik!
ugrep cepat, mudah digunakan, dan dilengkapi dengan banyak fitur baru yang diinginkan pengguna
mencakup TUI interaktif dengan bantuan bawaan, pencarian seperti Google dengan pola AND/OR/NOT, pencarian fuzzy, pencarian (bersarang) arsip zip/7z/tar/pax/cpio, tarball dan file terkompresi gz/Z/bz/ bz2/lzma/xz/lz4/zstd/brotli, mencari dan file biner hexdump, mencari dokumen seperti PDF, doc, docx, dan output dalam JSON, XML, CSV atau format khusus Anda sendiri
Sintaks pola regex yang diperluas Unicode dengan pencocokan pola multi-baris tanpa memerlukan opsi baris perintah khusus
termasuk pengindeks file untuk mempercepat pencarian sistem file yang lambat dan dingin
pengganti drop-in yang sebenarnya untuk GNU grep (dengan asumsi Anda menyalin atau menghubungkan ug ke grep , dan ke egrep dan ke fgrep ), tidak seperti grep populer lainnya yang mengklaim sebagai "alternatif grep" atau "pengganti" ketika mereka benar-benar mengimplementasikan baris perintah yang tidak kompatibel opsi dan gunakan pencocokan regex yang tidak kompatibel, yaitu hanya regex Perl versus POSIX BRE (grep) dan ERE (egrep) ketika ugrep mendukung semua mode regex
tolok ukur menunjukkan bahwa ugrep adalah (salah satu) grep tercepat yang menggunakan pencocokan regex berbasis DFA berkinerja tinggi RE/flex
jika ada sesuatu yang perlu diperbaiki atau ditambahkan ke ugrep, beri tahu saya!
Prioritas #1 adalah jaminan kualitas untuk terus memastikan ugrep tidak memiliki bug dan dapat diandalkan
membuat ugrep berjalan lebih cepat, lihat misalnya #432, #421
berbagi hasil kinerja yang dapat direproduksi
ug untuk penggunaan interaktif, yang memuat file konfigurasi .ugrep opsional dengan preferensi Anda yang terletak di direktori kerja atau direktori home, ug+ juga mencari pdf, dokumen, e-book, metadata gambar
ugrep untuk penggunaan batch seperti GNU grep tanpa file konfigurasi .ugrep, ugrep+ juga mencari pdf, dokumen, e-book, metadata gambar
Cocok dengan pola Unicode secara default dan secara otomatis mencari file yang dikodekan UTF-8, UTF-16 dan UTF-32
Mencocokkan beberapa baris dengan n atau R dalam pola regex, tidak diperlukan opsi khusus untuk melakukannya!
Bantuan bawaan: ug --help , di mana ug --help WHAT menampilkan opsi yang terkait dengan WHAT yang Anda cari
ug --help regex , ug --help globs , ug --help fuzzy , ug --help format .
Ramah pengguna dengan file konfigurasi yang dapat disesuaikan yang digunakan oleh perintah ug yang ditujukan untuk penggunaan interaktif yang memuat file konfigurasi .ugrep dengan preferensi Anda
ug PATTERN ... ugrep --config PATTERN ...
ug --save-config ...options-you-want-to-save... menyimpan file konfigurasi .ugrep di direktori kerja sehingga saat berikutnya Anda menjalankan ug di sana, ia akan menggunakan opsi ini. Lakukan ini di direktori home Anda untuk menyimpan file konfigurasi .ugrep dengan opsi yang biasanya ingin Anda gunakan.
Permintaan interaktif TUI, tekan F1 atau CTRL-Z untuk bantuan dan TAB/SHIFT-TAB untuk menavigasi ke direktori dan file
ug -Q ug -Q -e PATTERN
-Q menggantikan PATTERN pada baris perintah untuk memungkinkan Anda memasukkan pola secara interaktif di TUI. Di TUI gunakan tombol ALT+huruf untuk mengaktifkan/menonaktifkan "opsi huruf" pendek, misalnya ALT-n (opsi -n ) untuk menampilkan/menyembunyikan nomor baris.
Cari isi arsip (zip, tar, pax, jar, cpio, 7z) dan file terkompresi (gz, Z, bz, bz2, lzma, xz, lz4, zstd, brotli)
ug -z PATTERN ... ug -z --zmax=2 PATTERN ...
tentukan -z --zmax=2 untuk mencari file terkompresi dan arsip yang bersarang di dalam arsip. Argumen --zmax dapat berkisar dari 1 (default) hingga 99 untuk hingga 99 langkah dekompresi dan de-arsip untuk mencari arsip yang disarangkan
Telusuri dengan pola kueri Boolean seperti Google menggunakan pola -% dengan AND (atau hanya spasi), OR (atau bilah | ), NOT (atau tanda hubung - ), menggunakan tanda kutip agar sama persis, dan mengelompokkan dengan ( ) (ditunjukkan pada sisi kiri bawah); atau dengan opsi -e (sebagai "atau"), --and , --andnot , dan --not pola regex (ditampilkan di sisi kanan bawah):
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' ...
di mana A , B dan C adalah pola regex arbitrer (gunakan opsi -F untuk mencari string)
tentukan opsi -%% ( --bool --files ) untuk menerapkan kueri Boolean ke file secara keseluruhan: file cocok jika semua kondisi Boolean dipenuhi dengan pola pencocokan di seluruh file. Jika tidak, kondisi Boolean berlaku untuk satu baris secara default, karena utilitas grep umumnya merupakan pencocokan pola berbasis garis. Opsi --stats menampilkan kueri dalam bentuk yang dapat dibaca manusia setelah pencarian selesai.
Telusuri pdf, doc, docx, e-book, dan lainnya dengan ug+ menggunakan filter yang terkait dengan ekstensi nama file:
ug+ PATTERN ...
atau tentukan --filter dengan jenis file untuk menggunakan utilitas filter:
ug --filter='pdf:pdftotext % -' PATTERN ...
ug --filter='doc:antiword %' PATTERN ...
ug --filter='odt,docx,epub,rtf:pandoc --wrap=preserve -t plain % -o -' PATTERN ...
ug --filter='odt,doc,docx,rtf,xls,xlsx,ppt,pptx:soffice --headless --cat %' PATTERN ...
ug --filter='pem:openssl x509 -text,cer,crt,der:openssl x509 -text -inform der' PATTERN ...
ug --filter='latin1:iconv -f LATIN1 -t UTF-8' PATTERN ...
perintah ug+ sama dengan perintah ug , tetapi juga menggunakan filter untuk mencari PDF, dokumen, dan metadata gambar
Tampilkan konteks horizontal dengan opsi -o ( --only-matching ) dan opsi konteks -ABC , misalnya untuk menemukan kecocokan dalam baris yang sangat panjang, seperti sumber Javascript dan JSON:
ug -o -C20 -nk PATTERN longlines.js
-o -C20 cocok dengan semua kecocokan dengan konteks dalam 20 karakter sebelum dan 20 karakter setelah kecocokan (yaitu total 40 karakter Unicode), -nk menampilkan nomor baris dan kolom.
Temukan perkiraan pola yang cocok dengan pencarian fuzzy, dalam jarak Levenshtein yang ditentukan
ug -Z PATTERN ... ug -Z3 PATTTERN ...
-Zn cocok dengan hingga n karakter tambahan, hilang atau diganti, -Z+n cocok dengan hingga n karakter tambahan, -Zn cocok dengan hingga n karakter hilang dan -Z~n cocok dengan hingga n karakter yang diganti. -Z defaultnya adalah -Z1 .
Pencarian seperti Fzf dengan regex (atau string tetap dengan -F ), pencocokan fuzzy dengan hingga 4 karakter tambahan dengan -Z+4 dan kata-kata hanya dengan -w , menggunakan -%% untuk pencarian Boolean seluruh file
ug -Q -%% -l -w -Z+4 --sort=best
-l mencantumkan file yang cocok di TUI, tekan TAB lalu ALT-y untuk melihat file, SHIFT-TAB dan Alt-l untuk kembali melihat daftar file yang cocok diurutkan berdasarkan kecocokan terbaik
Cari file biner dan tampilkan hexdump dengan pola biner yang cocok (teks Unicode atau -U untuk pola byte)
ug --hexdump -U BYTEPATTERN ... ug --hexdump TEXTPATTERN ...
ug -X -U BYTEPATTERN ... ug -X TEXTPATTERN ...
ug -W -U BYTEPATTERN ... ug -W TEXTPATTERN ...
--hexdump=4chC1 menampilkan 4 kolom hex tanpa kolom karakter c , tanpa spasi hex h , dan dengan satu baris hex tambahan C1 sebelum dan sesudah kecocokan.
Sertakan file untuk dicari berdasarkan jenis file atau file "byte ajaib" atau kecualikan dengan ^
ug -t TYPE PATTERN ... ug -t ^TYPE PATTERN ...
ug -M 'MAGIC' PATTERN ... ug -M '^MAGIC' PATTERN ...
Sertakan file dan direktori untuk mencari yang cocok dengan gumpalan gaya gitignore atau kecualikan dengan ^
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 ...
Sertakan file untuk dicari berdasarkan ekstensi nama file (akhiran) atau kecualikan dengan ^ , singkatan dari -g"*.EXT"
ug -O EXT PATTERN ... ug -O ^EXT PATTERN ...
Sertakan file tersembunyi (dotfiles) dan direktori untuk dicari (dihilangkan secara default)
ug -. PATTERN ... ug -g'.*,.*/' PATTERN ...
tentukan hidden di .ugrep Anda untuk selalu mencari file tersembunyi dengan ug .
Kecualikan file yang ditentukan oleh .gitignore dll.
ug --ignore-files PATTERN ... ug --ignore-files=.ignore PATTERN ...
tentukan ignore-files di .ugrep Anda untuk selalu mengabaikannya dengan ug . Tambahkan ignore-files=... sesuai keinginan.
Pola pencarian tidak termasuk pola negatif ("cocok dengan ini tetapi tidak itu")
ug -e PATTERN -N NOTPATTERN ... ug -e '[0-9]+' -N 123 ...
Gunakan pola regex yang telah ditentukan sebelumnya untuk mencari kode sumber, javascript, XML, JSON, HTML, PHP, penurunan harga, dll.
ug PATTERN -f c++/zap_comments -f c++/zap_strings ...
ug PATTERN -f php/zap_html ...
ug -f js/functions ... | ug PATTERN ...
Urutkan file yang cocok berdasarkan nama, kecocokan terbaik, ukuran, dan waktu
ug --sort PATTERN ... ug --sort=size PATTERN ...
ug --sort=changed PATTERN ... ug --sort=created PATTERN ...
ug -Z --sort=best PATTERN ... ug --no-sort PATTERN ...
Hasil keluaran dalam format CSV, JSON, XML, dan yang ditentukan pengguna
ug --csv PATTERN ... ug --json PATTERN ...
ug --xml PATTERN ... ug --format='file=%f line=%n match=%O%~' PATTERN ...
ug --help format menampilkan bantuan pada bidang format % untuk keluaran yang disesuaikan.
Cari dengan pola regex yang kompatibel dengan Perl PCRE dan tampilkan atau ganti subpola yang cocok
ug -P PATTERN ... ug -P --format='%1 and %2%~' 'PATTERN(SUB1)(SUB2)' ...
Ganti pola dalam output dengan -P dan --replace teks pengganti, yang secara opsional berisi % bidang pemformatan, gunakan -y untuk meneruskan sisa file melalui:
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 menampilkan bantuan pada bidang format % untuk digunakan secara opsional dengan --replace .
Cari file dengan format pengkodean tertentu seperti ISO-8859-1 hingga 16, CP 437, CP 850, MACROMAN, KOI8, dll.
ug --encoding=LATIN1 PATTERN ...
Instal ugrep terbaru dengan Homebrew:
$ brew install ugrep
atau instal dengan MacPorts:
$ sudo port install ugrep
Ini menginstal perintah ugrep dan ug , di mana ug sama dengan ugrep tetapi juga memuat file konfigurasi .ugrep ketika ada di direktori kerja atau direktori home.
Instal dengan Winget winget install Genivia.ugrep
Atau instal dengan Chocolatey choco install ugrep
Atau instal dengan Scoop scoop install ugrep
Atau unduh ugrep.exe berfitur lengkap yang dapat dieksekusi sebagai artefak rilis dari https://github.com/Genivia/ugrep/releases. Rilis zip berisi biner ugrep.exe utama serta ug.exe . Perintah ug , dimaksudkan untuk penggunaan interaktif, memuat dan membaca pengaturan dari file konfigurasi .ugrep (bila ada di direktori kerja atau direktori home).
Tambahkan ugrep.exe dan ug.exe ke jalur eksekusi Anda: buka Pengaturan dan cari "Jalur" di Temukan Pengaturan . Pilih variabel lingkungan -> Jalur -> Baru dan tambahkan direktori tempat Anda meletakkan file executable ugrep.exe dan ug.exe .
Tip
Petunjuk praktis tentang penggunaan ugrep.exe dan ug.exe pada baris perintah Windows:
' tetapi gunakan " sebagai gantinya; sebagian besar utilitas perintah Windows menganggap tanda kutip ' sebagai bagian dari argumen baris perintah!-g/GLOB daripada argumen baris perintah GLOB biasa untuk memilih file dan direktori yang akan dicari, terutama untuk pencarian rekursif;"" untuk mencocokkan semua masukan, ini mungkin diabaikan oleh beberapa penerjemah perintah Windows seperti Powershell, dalam hal ini Anda harus menentukan opsi --match sebagai gantinya;R alih-alih n untuk mencocokkan baris baru Unicode apa pun, seperti rn berpasangan dan r dan n tunggal. $ apk add ugrep ugrep-doc
Periksa https://pkgs.alpinelinux.org/packages?name=ugrep untuk info versi.
$ pacman -S ugrep
Periksa https://archlinux.org/packages/extra/x86_64/ugrep untuk info versi.
Pertama aktifkan repositori EPEL, lalu Anda dapat menginstal ugrep.
$ dnf install ugrep
Periksa https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ untuk info versi.
$ apt-get install ugrep
Periksa https://packages.debian.org/ugrep untuk info versi. Untuk membangun dan mencoba ugrep secara lokal, lihat langkah-langkah pembuatan "Semua platform" lebih lanjut di bawah.
$ dnf install ugrep
Periksa https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ untuk info versi.
$ pkg install ugrep
Periksa https://www.freshports.org/textproc/ugrep untuk info versi.
$ pkgman install cmd:ugrep
Periksa https://github.com/haikuports/haikuports/tree/master/app-text/ugrep untuk info versi. Untuk membangun dan mencoba ugrep secara lokal, lihat langkah-langkah pembuatan "Semua platform" lebih lanjut di bawah.
Anda dapat menggunakan penginstal paket NetBSD standar (pkgsrc): http://cdn.netbsd.org/pub/pkgsrc/current/pkgsrc/textproc/ugrep/README.html
$ pkg_add ugrep
Periksa https://openports.pl/path/sysutils/ugrep untuk info versi.
$ zypper install ugrep
Periksa https://build.opensuse.org/package/show/utilities/ugrep untuk info versi.
Pertama aktifkan repositori EPEL, lalu Anda dapat menginstal ugrep.
$ dnf install ugrep
Periksa https://packages.fedoraproject.org/pkgs/ugrep/ugrep/ untuk info versi.
Klon ugrep dengan
$ git clone https://github.com/Genivia/ugrep
Atau kunjungi https://github.com/Genivia/ugrep/releases untuk mengunduh rilis tertentu.
Anda selalu dapat menambahkannya nanti, saat Anda memerlukan fitur berikut:
Opsi -P (ekspresi reguler Perl) memerlukan perpustakaan PCRE2 (disarankan) atau perpustakaan Boost.Regex (fallback opsional). Jika PCRE2 belum diinstal, instal PCRE2 dengan misalnya sudo apt-get install -y libpcre2-dev atau unduh PCRE2 dan ikuti petunjuk instalasi. Alternatifnya, unduh Boost.Regex dan jalankan ./bootstrap.sh dan sudo ./b2 --with-regex install . Lihat Peningkatan: memulai.
Opsi -z (pencarian file dan arsip terkompresi) memerlukan perpustakaan zlib yang diinstal. Itu diinstal pada sebagian besar sistem. Jika belum, instal, misalnya dengan sudo apt-get install -y libz-dev . Untuk mencari file .bz dan .bz2 , instal perpustakaan bzip2 (disarankan), misalnya dengan sudo apt-get install -y libbz2-dev . Untuk mencari file .lzma dan .xz , instal perpustakaan lzma (disarankan), misalnya dengan sudo apt-get install -y liblzma-dev . Untuk mencari file .lz4 , instal perpustakaan lz4 (opsional, tidak wajib), misalnya dengan sudo apt-get install -y liblz4-dev . Untuk mencari file .zst , instal perpustakaan zstd (opsional, tidak wajib), misalnya dengan sudo apt-get install -y libzstd-dev . Untuk mencari file .br , instal perpustakaan brotli (opsional, tidak wajib), misalnya dengan sudo apt-get install -y libbrotli-dev . Untuk mencari file .bz3 , instal perpustakaan bzip3 (opsional, tidak wajib), misalnya dengan sudo apt-get install -y bzip3 .
Tip
Bahkan jika sistem Anda memiliki utilitas baris perintah, seperti bzip2 , itu tidak berarti bahwa perpustakaan pengembangan seperti libbz2 telah diinstal. Perpustakaan pengembangan harus diinstal.
Beberapa sistem Linux mungkin tidak dikonfigurasi untuk memuat pustaka dinamis dari /usr/local/lib , sehingga menyebabkan kesalahan pemuatan pustaka saat menjalankan ugrep . Untuk memperbaikinya, tambahkan export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/usr/local/lib" ke file ~/.bashrc Anda. Atau jalankan sudo ldconfig /usr/local/lib .
Jalankan skrip ./build.sh untuk membangun ugrep :
$ cd ugrep
$ ./build.sh
Ini membangun ugrep yang dapat dieksekusi di direktori ugrep/src dengan ./configure dan make -j , diverifikasi dengan make test . Ketika semua pengujian berhasil, ugrep yang dapat dieksekusi disalin ke ugrep/bin/ugrep dan symlink ugrep/bin/ug -> ugrep/bin/ugrep ditambahkan untuk perintah ug .
Perhatikan bahwa ug sama dengan ugrep tetapi juga memuat file konfigurasi .ugrep ketika ada di direktori kerja atau direktori home. Ini berarti Anda dapat menentukan opsi default untuk ug di .ugrep.
Jalur alternatif ke perpustakaan terinstal atau lokal dapat ditentukan dengan ./build.sh . Untuk mendapatkan bantuan tentang opsi build yang tersedia:
$ ./build.sh --help
Anda dapat membuat executable statis dengan menentukan:
$ ./build.sh --enable-static
Ini mungkin gagal jika perpustakaan tidak terhubung secara statis, seperti brotli. Dalam hal ini coba ./build.sh --enable-static --without-brotli .
Anda dapat membuat ugrep dengan mengaktifkan default khusus, seperti pager:
$ ./build.sh --enable-pager
Opsi untuk memilih default untuk build meliputi:
--help menampilkan opsi pembuatan--enable-static membangun executable statis, jika memungkinkan--enable-hidden selalu mencari file dan direktori tersembunyi--enable-pager selalu menggunakan pager untuk menampilkan output pada terminal--enable-pretty mewarnai keluaran ke terminal dan menambahkan judul nama file--disable-auto-color menonaktifkan warna otomatis, memerlukan opsi ugrep --color=auto untuk menampilkan warna--disable-mmap menonaktifkan file yang dipetakan memori--disable-sse2 menonaktifkan optimasi SSE2 dan AVX--disable-avx2 menonaktifkan optimasi AVX2 dan AVX512BW, tetapi kompilasi dengan SSE2 bila didukung--disable-neon menonaktifkan optimasi ARM NEON/AArch64--with-grep-path jalur -f default jika GREP_PATH tidak ditentukan--with-grep-colors warna default jika GREP_COLORS tidak ditentukan Setelah pembangunan selesai, salin ugrep/bin/ugrep dan ugrep/bin/ug ke lokasi yang sesuai, misalnya di direktori ~/bin Anda. Atau, jika Anda ingin menginstal perintah ugrep dan ug serta halaman manual:
$ sudo make install
Ini juga menginstal file pola dengan pola yang telah ditentukan sebelumnya untuk opsi -f di /usr/local/share/ugrep/patterns/ . Opsi -f pertama-tama memeriksa direktori kerja untuk mengetahui keberadaan file pola, jika tidak ditemukan, periksa variabel lingkungan GREP_PATH untuk memuat file pola, dan jika tidak ditemukan, baca file pola yang telah ditentukan sebelumnya yang diinstal.
Sayangnya, klon git tidak menyimpan stempel waktu yang berarti Anda mungkin mengalami "PERINGATAN: 'aclocal-1.15' hilang di sistem Anda." atau autoheader itu tidak ditemukan saat menjalankan make .
Untuk mengatasi masalah ini, jalankan:
$ autoreconf -fi
$ ./build.sh
GCC 8 dan yang lebih tinggi dapat menghasilkan peringatan seperti "note: parameter passing for argument ... changing in GCC 7.1" . Peringatan ini harus diabaikan.
Dockerfile disertakan untuk membangun ugrep di container Ubuntu.
Pengembang mungkin ingin menggunakan pembersih untuk memverifikasi kode ugrep ketika membuat perubahan signifikan, misalnya untuk mendeteksi data race dengan ThreadSanitizer:
$ ./build.sh CXXFLAGS='-fsanitize=thread -O1 -g'
Kami memeriksa ugrep dengan dentang AddressSanitizer, MemorySanitizer, ThreadSanitizer, dan UndefinisiBehaviorSanitizer. Opsi ini memerlukan overhead runtime yang signifikan dan tidak boleh digunakan untuk build akhir.
? Kembali ke daftar isi
Harap dicatat bahwa perintah ugrep dan ug mencari file biner secara default dan tidak mengabaikan file tertentu .gitignore, yang tidak akan membuat perbandingan kinerja pencarian rekursif menjadi berarti kecuali opsi -I dan --ignore-files digunakan. Untuk menjadikan opsi ini sebagai default untuk ug , cukup tambahkan ignore-binary dan ignore-files ke file konfigurasi .ugrep Anda.
Untuk perbandingan kinerja ugrep terbaru terkini, silakan lihat tolok ukur kinerja ugrep. Ugrep lebih cepat dari GNU grep, Silver Searcher, ack, sift. Kecepatan Ugrep mengalahkan ripgrep di sebagian besar benchmark.
Pertama, mari kita definisikan perintah :grep di Vim untuk mencari file secara rekursif. Untuk melakukannya, tambahkan baris berikut ke .vimrc Anda yang terletak di direktori root:
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
Ini menentukan -j pencarian peka huruf besar-kecil dengan perintah Vim :grep . Untuk penelusuran peka huruf besar-kecil, hapus -j dari grepprg . Beberapa kecocokan pada baris yang sama dicantumkan di jendela perbaikan cepat secara terpisah. Jika ini tidak diinginkan, hapus -u dari grepprg . Dengan perubahan ini, hanya kecocokan pertama dalam satu baris yang ditampilkan. Opsi --ignore-files melewatkan file yang ditentukan dalam file .gitignore , jika ada. Untuk membatasi kedalaman pencarian rekursif hanya pada direktori saat ini, tambahkan -1 ke grepprg .
Anda sekarang dapat menjalankan perintah Vim :grep di Vim untuk mencari file pada PATH tertentu untuk PATTERN yang cocok:
:grep PATTERN [PATH]
Jika Anda menghilangkan PATH , maka direktori kerja akan dicari. Gunakan % sebagai PATH untuk mencari hanya file yang sedang dibuka di Vim:
:grep PATTERN %
Perintah :grep menampilkan hasil di jendela perbaikan cepat yang memungkinkan Anda melompat ke kecocokan yang ditemukan dengan cepat.
Untuk membuka jendela perbaikan cepat dengan daftar kecocokan terbaru:
:copen
Klik dua kali pada baris di jendela ini (atau pilih baris dan tekan ENTER) untuk melompat ke file dan lokasi di file yang cocok. Masukkan perintah :cn dan :cp untuk melompat ke pertandingan berikutnya atau sebelumnya. Untuk memperbarui hasil pencarian di jendela perbaikan cepat, ambil saja hasil tersebut. Misalnya, untuk mencari kode sumber C++ bertanda FIXME secara rekursif di direktori kerja:
:grep -tc++ FIXME
Untuk menutup jendela perbaikan cepat:
:cclose
Anda dapat menggunakan opsi ugrep dengan perintah :grep , misalnya untuk memilih komentar satu baris dan beberapa baris dalam file saat ini:
:grep -f c++/comments %
Hanya baris pertama dari komentar multi-baris yang ditampilkan dalam perbaikan cepat, untuk menghemat ruang. Untuk menampilkan semua baris kecocokan multi-baris, hapus %-G dari grepformat .
Alat Vim yang populer adalah ctrlp.vim, yang diinstal dengan:
$ cd ~/.vim
$ git clone https://github.com/kien/ctrlp.vim.git bundle/ctrlp.vim
CtrlP menggunakan ugrep dengan menambahkan baris berikut ke .vimrc Anda :
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
di mana -I melewatkan file biner, opsi --ignore-files melewatkan file yang ditentukan dalam file .gitignore , jika ada, dan opsi -3 membatasi pencarian direktori hingga tiga tingkat (direktori kerja dan hingga dua tingkat di bawahnya).
Mulai Vim lalu masukkan perintah:
:helptags ~/.vim/bundle/ctrlp.vim/doc
Untuk melihat dokumentasi CtrlP di Vim, masukkan perintah:
:help ctrlp.txt
? Kembali ke daftar isi
Berkat Manuel Uberti, kini Anda dapat menggunakan ugrep di Emacs. Untuk menggunakan ugrep alih-alih GNU grep di Emacs, tambahkan baris berikut ke file .emacs.d/init.el Anda:
(setq-default xref-search-program ‘ugrep)
Ini berarti perintah Emacs seperti project-find-regexp yang mengandalkan Xref kini dapat memanfaatkan kekuatan ugrep .
Selain itu, dimungkinkan untuk menggunakan grep dalam perintah grep Emacs. Misalnya, Anda dapat menjalankan lgrep dengan ugrep dengan mengkustomisasi grep-template menjadi seperti berikut:
(setq-default grep-template "ugrep --color=always -0Iinr -e <R>")
Jika Anda tidak memiliki Emacs versi 29 (atau lebih tinggi), Anda dapat mengunduh dan membuat Emacs dari cabang master Emacs, atau mengaktifkan integrasi Xref dengan ugrep secara manual:
(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))
? Kembali ke daftar isi
Ugrep yang siap pakai mendukung semua opsi baris perintah grep GNU/BSD standar dan juga meningkatkan banyak opsi tersebut. Untuk detailnya lihat peningkatan penting pada grep.
Jika Anda ingin tetap menggunakan pola Unicode non-UTF GNU/BSD grep ASCII/LATIN1, gunakan opsi -U untuk menonaktifkan pencocokan pola Unicode penuh.
Faktanya, mengeksekusi ugrep dengan opsi -U , -Y , -. dan --sort membuatnya berperilaku persis seperti egrep , hanya mencocokkan pola Unicode non-UTF ASCII/LATIN1, memungkinkan pola kosong untuk mencocokkan dan mencari file tersembunyi alih-alih mengabaikannya. Lihat kesetaraan grep.
Anda dapat membuat alias grep yang nyaman dengan atau tanpa opsi -U , -Y , -. dan --sort atau sertakan opsi lain sesuai keinginan.
Atau Anda dapat membuat executable grep , egrep dan fgrep dengan menyalin ugrep ke nama tersebut. Ketika executable ugrep (atau ugrep.exe ) disalin sebagai grep ( grep.exe ), egrep ( egrep.exe ), fgrep ( fgrep.exe ), lalu opsi -U , -Y dan -. secara otomatis diaktifkan bersama dengan -G untuk grep , -E untuk egrep dan -F untuk fgrep . Selain itu, ketika disalin sebagai zgrep , zegrep dan zfgrep , opsi -z diaktifkan. Misalnya, ketika ugrep disalin sebagai zegrep , opsi -z , -E , -Y , -. dan --sort diaktifkan.
Demikian pula, symlink dan hard link ke ugrep juga berfungsi dengan baik untuk membuat pengganti grep , egrep dan fgrep . Misalnya, untuk membuat symlink egrep :
sudo ln -s `which ugrep` /opt/local/bin/egrep
/opt/local/bin hanyalah sebuah contoh dan mungkin ada atau tidak ada di $path Anda dan mungkin ditemukan atau tidak ditemukan saat menjalankan egrep tergantung pada $path Anda.
ugrep setara dengan grep GNU/BSD ketika opsi berikut digunakan:
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
Di mana:
-U menonaktifkan pencocokan pola karakter lebar Unicode, jadi misalnya pola xa3 cocok dengan byte A3 alih-alih titik kode Unicode U+00A3 yang diwakili oleh urutan UTF-8 C2 A3. Secara default di ugrep, xa3 cocok dengan U+00A3. Kami tidak menyarankan penggunaan -U untuk pencarian pola teks, hanya untuk pencarian biner atau untuk mencari file latin-1 (iso-8859-1) tanpa melaporkan file ini sebagai biner (sejak ugrep v3.5.0).-Y mengaktifkan pencocokan kosong, jadi misalnya pola a* cocok dengan setiap baris, bukan urutan a . Secara default di ugrep, pola a* cocok dengan urutan a . Selain itu, dalam ugrep pola a*b*c* cocok dengan apa yang seharusnya cocok secara default. Lihat peningkatan.-. mencari file tersembunyi (dotfiles). Secara default, file tersembunyi diabaikan, seperti kebanyakan utilitas Unix.--sort menentukan keluaran yang diurutkan berdasarkan nama jalur, menampilkan file pencocokan yang diurutkan terlebih dahulu diikuti dengan pencocokan rekursif yang diurutkan dalam subdirektori. Jika tidak, file yang cocok dilaporkan tanpa urutan tertentu untuk meningkatkan kinerja;-Dread dan -dread adalah default grep GNU/BSD namun tidak direkomendasikan, lihat penyempurnaan untuk penjelasannya.? Kembali ke daftar isi
Alias yang umum digunakan untuk ditambahkan ke .bashrc guna meningkatkan produktivitas:
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)
? Kembali ke daftar isi
-Q .n .-U ).--bool ).--ignore-files .-Z .-z .-z .-z dan --zmax=NUM hingga NUM level.--filter menggunakan utilitas konversi format pihak ketiga sebagai plugin.-r untuk mencari direktori secara rekursif.-. ).-E sebagai egrep, sedangkan -G mengaktifkan BRE).-J1 ).-W (keluaran kecocokan biner dalam hex dengan teks cocok dengan output seperti biasa) dan -X (output semua kecocokan dalam hex).--format ).-f menggunakan variabel lingkungan GREP_PATH atau pola yang telah ditentukan sebelumnya yang diinstal di /usr/local/share/ugrep/patterns . Jika -f ditentukan dan juga satu atau lebih pola -e ditentukan, maka opsi -F , -x , dan -w tidak berlaku untuk pola -f . Hal ini untuk menghindari kebingungan ketika -f digunakan dengan pola yang telah ditentukan sebelumnya yang mungkin tidak lagi berfungsi dengan baik dengan opsi ini.-O , -M , dan -t menentukan masing-masing ekstensi file, pola byte ajaib tanda tangan file, dan tipe file yang telah ditentukan sebelumnya. Hal ini memungkinkan pencarian jenis file tertentu di pohon direktori, misalnya dengan opsi pencarian rekursif -R dan -r . Pilihan -O , -M , dan -t juga berlaku untuk file yang diarsipkan dalam file cpio, jar, pax, tar, zip dan 7z.-k , --column-number untuk menampilkan nomor kolom, dengan mempertimbangkan jarak tab dengan memperluas tab, seperti yang ditentukan oleh opsi --tabs .-P (ekspresi reguler Perl) mendukung referensi balik (dengan --format ) dan tampilan di belakang, yang menggunakan pustaka PCRE2 atau Boost.Regex untuk pencocokan regex Perl yang cepat dengan sintaksis mirip PCRE.-b dengan opsi -o atau dengan opsi -u , ugrep menampilkan offset byte yang tepat dari kecocokan pola alih-alih offset byte dari awal baris yang cocok yang dilaporkan oleh GNU/BSD grep.-u , --ungroup untuk tidak mengelompokkan beberapa kecocokan per baris. Opsi ini menampilkan kembali baris input yang cocok untuk setiap kecocokan pola tambahan pada baris tersebut. Opsi ini sangat berguna dengan opsi -c untuk melaporkan jumlah total kecocokan pola per file, bukan jumlah baris yang cocok per file.-Y memungkinkan pencocokan pola kosong. Grepping dengan pola pencocokan kosong adalah hal yang aneh dan memberikan hasil yang berbeda dengan grep GNU versus grep BSD. Pencocokan kosong tidak dihasilkan oleh ugrep secara default, sehingga menghindari kesalahan yang mungkin menghasilkan hasil "acak". Misalnya, dengan grep GNU/BSD, pola a* cocok dengan setiap baris dalam masukan, dan benar-benar cocok dengan xyz tiga kali (transisi kosong sebelum dan antara x , y , dan z ). Mengizinkan kecocokan kosong memerlukan opsi ugrep -Y . Pola yang dimulai dengan ^ atau diakhiri dengan $ , seperti ^h*$ , cocok dengan kosong. Pola-pola ini secara otomatis mengaktifkan opsi -Y .-D, --devices=ACTION skip secara default, bukan read . Hal ini mencegah terjadinya hang pada pipa bernama di direktori yang dicari secara rekursif, seperti yang mungkin terjadi pada grep GNU/BSD yang read perangkat secara default.-d, --directories=ACTION skip secara default, bukan read . Secara default, direktori yang ditentukan pada baris perintah dicari, tetapi tidak secara rekursif masuk lebih dalam ke dalam subdirektori.-N PATTERN , yang merupakan pola dalam bentuk (?^X) yang melewatkan semua masukan X , sehingga menghapus X dari pencarian. Misalnya, pola negatif dapat digunakan untuk melewatkan string dan komentar saat mencari pengidentifikasi dalam kode sumber dan menemukan kecocokan yang tidak ada dalam string dan komentar. Pola zap yang telah ditentukan sebelumnya menggunakan pola negatif, misalnya, gunakan -f cpp/zap_comments untuk mengabaikan kecocokan pola di komentar C++.GREP_OPTIONS , karena perilaku ugrep harus portabel dan dapat diprediksi pada setiap sistem. GNU grep juga mengabaikan GREP_OPTIONS karena alasan ini. Silakan gunakan perintah ug yang memuat file konfigurasi .ugrep yang terletak di direktori kerja atau di direktori home jika ada, atau gunakan alias shell untuk membuat perintah baru dengan opsi pencarian tertentu.? Kembali ke daftar isi
Untuk melakukan pencarian menggunakan file konfigurasi .ugrep ditempatkan di direktori kerja atau direktori home (perhatikan bahwa ug sama dengan ugrep --config ):
ug PATTERN FILE...
Untuk menyimpan file konfigurasi .ugrep ke direktori kerja, lalu edit file ini di direktori home Anda untuk menyesuaikan preferensi Anda untuk default ug :
ug --save-config
Untuk mencari direktori kerja dan secara rekursif lebih dalam untuk main (perhatikan bahwa -r symlink berulang diaktifkan secara default jika tidak ada argumen file yang ditentukan):
ug main
Sama, tetapi hanya mencari file kode sumber C++ secara rekursif, mengabaikan semua file lainnya:
ug -tc++ main
Sama, menggunakan kueri interaktif TUI, dimulai dengan pola pencarian awal main (perhatikan bahwa -Q dengan pola awal memerlukan opsi -e karena pola biasanya ditentukan secara interaktif dan semua argumen baris perintah dianggap sebagai file/direktori):
ug -Q -tc++ -e main
Untuk mencari #define (dan # define dll) menggunakan pola regex dalam file C++ (perhatikan bahwa pola harus dikutip untuk mencegah penggumpalan shell * dan ? ):
ug -tc++ '#[t ]*define'
Untuk mencari main sebagai sebuah kata ( -w ) secara rekursif tanpa mengikuti symlink ( -r ) dalam direktori myproject , menampilkan nomor baris ( -n ) dan kolom ( -k ) yang cocok di sebelah baris yang cocok:
ug -r -nkw main myproject
Sama, tetapi hanya mencari myproject tanpa mengulang lebih dalam (perhatikan bahwa argumen direktori dicari pada satu tingkat secara default):
ug -nkw main myproject
Sama, tetapi cari myproject dan satu tingkat subdirektori lebih dalam (dua tingkat) dengan -2 :
ug -2 -nkw main myproject
Sama, tetapi hanya mencari file C++ di myproject dan subdirektorinya dengan -tc++ :
ug -tc++ -2 -nkw main myproject
Sama, tetapi juga mencari di dalam arsip (misalnya file zip dan tar) dan file terkompresi dengan -z :
ug -z -tc++ -2 -nkw main myproject
Cari direktori kerja secara rekursif untuk main sambil mengabaikan file gitignore (misalnya dengan asumsi .gitignore ada di direktori kerja atau di bawahnya):
ug --ignore-files -tc++ -nkw main
Untuk membuat daftar semua file di direktori kerja dan lebih dalam yang tidak diabaikan oleh file .gitignore :
ug --ignore-files -l ''
Untuk menampilkan daftar ekstensi nama file dan "byte ajaib" (shebangs) yang dicari sesuai dengan argumen -t :
ug -tlist
Untuk membuat daftar semua file shell secara rekursif, berdasarkan ekstensi dan shebang dengan -l (perhatikan bahwa '' cocok dengan file yang tidak kosong):
ug -l -tShell ''
? Kembali ke daftar isi
Untuk mencari main dalam kode sumber sambil mengabaikan string dan blok komentar, Anda dapat menggunakan pola negatif dengan opsi -N untuk melewati kecocokan yang tidak diinginkan dalam string dan blok komentar yang dikutip C/C++:
ug -r -nkw -e 'main' -N '"(\.|\r?n|[^\n"])*"|//.*|/*(.*n)*?.**+/' myproject
Ini banyak pekerjaan untuk mengetik dengan benar! Jika Anda seperti saya, saya tidak ingin menghabiskan waktu mengutak-atik pola regex ketika saya mengerjakan sesuatu yang lebih penting. Ada cara yang lebih mudah dengan menggunakan pola standar ugrep ( -f ) yang diinstal dengan alat ugrep :
ug -r -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
Kueri ini juga mencari file lain selain kode sumber C/C++, seperti README, Makefile, dan seterusnya. Kami juga melewatkan symlink dengan -r . Jadi mari kita perbaiki kueri ini dengan memilih file C/C ++ hanya menggunakan opsi -tc,c++ dan sertakan symlink ke file dan direktori dengan -R :
ug -R -tc,c++ -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
Bagaimana jika Anda hanya ingin mencari pengidentifikasi main tetapi tidak sebagai fungsi main( ? Dalam hal ini, gunakan pola negatif untuk ini untuk melewatkan mainh*( pola cocok:
ug -R -tc,c++ -nkw -e 'main' -N 'mainh*(' -f c/zap_strings -f c/zap_comments myproject
Ini menggunakan opsi -e dan -N untuk secara eksplisit menentukan pola dan pola negatif, masing -masing, yang pada dasarnya membentuk pola main|(?^mainh*() , di mana h cocok dengan ruang dan tab. Secara umum , pola negatif berguna untuk menyaring kecocokan pola yang tidak kami minati.
Sebagai contoh lain, katakanlah kita mungkin ingin mencari kata FIXME di blok komentar C/C ++. Untuk melakukannya kita dapat memilih blok komentar terlebih dahulu dengan pola c/comments UGrep yang telah ditentukan dan kemudian memilih baris dengan FIXME menggunakan pipa:
ug -R -tc,c++ -nk -f c/comments myproject | ug -w 'FIXME'
Hasil pemfilteran dengan pipa umumnya lebih mudah daripada menggunakan dan-atau-logika yang digunakan beberapa alat pencarian. Pendekatan ini mengikuti semangat UNIX untuk menjaga utilitas tetap sederhana dan menggunakannya dalam kombinasi untuk tugas yang lebih kompleks.
Mari kita hasilkan daftar semua pengidentifikasi yang ditemukan dalam kode sumber Java saat melewatkan string dan komentar:
ug -R -tjava -f java/names myproject | sort -u
Ini cocok dengan pengidentifikasi Java Unicode menggunakan regex p{JavaIdentifierStart}p{JavaIdentifierPart}* didefinisikan dalam patterns/java/names .
Dengan alat-alat GREP dan GREP tradisional, dibutuhkan upaya besar untuk mencari file sumber C/C ++ secara rekursif yang mendefinisikan fungsi qsort , yang membutuhkan sesuatu seperti ini:
ug -R --include='*.c' --include='*.cpp' '^([ t]*[[:word:]:*&]+)+[ t]+qsort[ t]*([^;n]+$' myproject
Untungnya, dengan UGrep kami dapat dengan mudah memilih semua definisi fungsi dalam file dengan ekstensi .c atau .cpp dengan menggunakan opsi -Oc,cpp dan dengan menggunakan functions pola yang telah ditentukan yang diinstal dengan alat untuk menghasilkan semua definisi fungsi. Kemudian kami memilih yang kami inginkan:
ug -R -Oc,cpp -nk -f c/functions | ug 'qsort'
Perhatikan bahwa kami dapat menggunakan -tc,c++ untuk memilih file C/C ++, tetapi ini juga termasuk file header ketika kami hanya ingin mencari file .c dan .cpp .
Kami juga dapat melewatkan file dan direktori dari dicari yang didefinisikan dalam .gitignore . Untuk melakukannya kami menggunakan --ignore-files untuk mengecualikan file dan direktori dari pencarian rekursif yang cocok dengan Globs di .gitignore , ketika satu atau lebih file .gitignore ditemukan:
ug -R -tc++ --ignore-files -f c++/defines
Ini mencari file C ++ ( -tc++ ) di direktori kerja untuk #define line ( -f c++/defines ), sambil melewatkan file dan direktori yang dideklarasikan dalam .gitignore . Jika Anda menemukan ini terlalu lama untuk mengetik maka tentukan alias untuk mencari direktori github:
alias ugit='ugrep -R --ignore-files'
ugit -tc++ -f c++/defines
Untuk menyoroti kecocokan saat didorong melalui rantai pipa yang harus kita gunakan --color=always :
ugit --color=always -tc++ -f c++/defines | ugrep -w 'FOO.*'
Ini mengembalikan daftar warna-warna dari semua #define FOO... makro dalam file kode sumber C/C ++, melewatkan file yang ditentukan dalam .gitignore .
Perhatikan bahwa pelengkap --exclude tidak --include , karena pengecualian selalu lebih diutamakan daripada inklusi, jadi kami tidak dapat dengan andal membuat daftar file yang diabaikan dengan --include-from='.gitignore' . Hanya file yang secara eksplisit yang ditentukan dengan --include dan direktori yang secara eksplisit ditentukan dengan --include-dir dikunjungi. --include-from daftar globs yang dianggap baik file dan direktori untuk ditambahkan ke --include dan --include-dir , masing-masing. Ini berarti bahwa ketika nama direktori dan jalur direktori tidak secara eksplisit terdaftar dalam file ini maka tidak akan dikunjungi menggunakan --include-from .
Karena UGrep memeriksa jika inputnya valid unicode yang dikodekan UTF (kecuali -U digunakan), dimungkinkan untuk menggunakannya sebagai filter untuk mengabaikan output non-UTF yang dihasilkan oleh suatu program:
program | ugrep -I ''
Jika program menghasilkan output yang valid maka output dilewati, jika tidak, output disaring opsi -I . Jika output awalnya valid untuk porsi yang sangat besar tetapi diikuti oleh output yang tidak valid, maka UGREP pada awalnya dapat menunjukkan output hingga tetapi tidak termasuk output yang tidak valid setelah itu output lebih lanjut diblokir.
Untuk memfilter garis yang valid ASCII atau UTF-encoded, saat menghapus garis yang tidak:
program | ugrep '[p{Unicode}--[n]]+'
Perhatikan bahwa p{Unicode} cocok n tetapi kami tidak ingin mencocokkan seluruh file! Hanya baris dengan [p{Unicode}--[n]]+ .
? Kembali ke daftar isi
Halaman UGrep Man:
man ugrep
Untuk menampilkan halaman bantuan:
ug --help
Untuk menampilkan opsi yang menyebutkan WHAT :
ug --help WHAT
Untuk menampilkan daftar nilai opsi -t TYPES :
ug -tlist
Dalam kueri interaktif TUI, tekan F1 atau Ctrl-Z untuk bantuan dan opsi:
ug -Q
? Kembali ke daftar isi
--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.
Perintah ug dimaksudkan untuk pencarian interaktif yang bergantung pada konteks dan setara dengan perintah ugrep --config untuk memuat file konfigurasi .ugrep saat hadir di direktori kerja atau, ketika tidak ditemukan, di direktori home:
ug PATTERN ...
ugrep --config PATTERN ...
Perintah ug juga mengurutkan file berdasarkan nama per direktori yang dicari. File konfigurasi berisi NAME=VALUE per baris, di mana NAME adalah nama opsi panjang (tanpa -- ) dan =VALUE adalah argumen, yang opsional dan dapat dihilangkan tergantung pada opsi. Garis dan garis kosong yang dimulai dengan # diabaikan:
# 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
Opsi baris perintah diuraikan dalam urutan berikut: Pertama file konfigurasi (default atau bernama) dimuat, kemudian opsi dan argumen yang tersisa pada baris perintah diuraikan.
Opsi --stats Menampilkan file konfigurasi yang digunakan setelah pencarian.
File konfigurasi bernama dimaksudkan untuk merampingkan tugas pencarian khusus, dengan mengurangi jumlah opsi baris perintah menjadi hanya satu ---FILE untuk menggunakan kumpulan opsi yang ditentukan dalam FILE . Opsi --config=FILE dan formulir singkatnya ---FILE Muat file konfigurasi yang ditentukan yang terletak di direktori kerja atau, ketika tidak ditemukan, terletak di direktori home:
ug ---FILE PATTERN ...
ugrep ---FILE PATTERN ...
Kesalahan dihasilkan ketika FILE tidak ditemukan atau tidak dapat dibaca.
File konfigurasi yang disebutkan dapat digunakan untuk menentukan kumpulan opsi yang khusus untuk persyaratan tugas dalam alur kerja pengembangan suatu proyek. Misalnya untuk melaporkan masalah yang belum terselesaikan dengan memeriksa kode sumber dan dokumentasi untuk komentar dengan item FixMe dan TODO. File konfigurasi bernama tersebut dapat dilokalisasi ke proyek dengan menempatkannya di direktori proyek, atau dapat dibuat global dengan menempatkannya di direktori home. Untuk umpan balik visual, skema warna khusus untuk tugas ini dapat ditentukan dengan colors opsi dalam FILE konfigurasi untuk membantu mengidentifikasi output yang dihasilkan oleh konfigurasi bernama yang bertentangan dengan konfigurasi default.
Opsi --save-config menyimpan file konfigurasi .ugrep ke direktori kerja menggunakan konfigurasi saat ini dimuat dengan --config . Ini menyimpan konfigurasi saat ini yang dikombinasikan dengan opsi tambahan saat ditentukan juga. Hanya opsi -opsi yang tidak dapat bertentangan dengan opsi dan opsi lain yang tidak dapat berdampak negatif pada hasil pencarian akan disimpan.
Opsi --save-config=FILE menyimpan konfigurasi ke FILE yang ditentukan. Konfigurasi ditulis ke output standar saat FILE adalah - .
Atau, file konfigurasi dapat dibuat atau dimodifikasi secara manual. File konfigurasi dapat mencakup satu atau lebih config[=FILE] untuk secara tidak langsung memuat FILE specfified, tetapi pemuatan konfigurasi rekursif dilarang. Cara paling sederhana untuk manuall membuat file konfigurasi adalah dengan menentukan config di bagian atas file, diikuti oleh opsi panjang untuk mengganti default.
? Kembali ke daftar isi
-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.
Opsi ini memulai antarmuka pengguna untuk memasuki pola pencarian secara interaktif:
-c untuk menghitung kecocokan. Menekan Alt -C kembali menonaktifkan -c . Opsi dapat diaktifkan dengan tombol ALT saat mencari atau saat melihat layar bantuan. Jika tombol ALT/META tidak didukung (misalnya X11 Xterm), maka tekan Ctrl-O diikuti oleh kunci yang sesuai dengan opsi.-g file dan direktori yang cocok dengan Globs, daftar pola Glob yang dipisahkan secara koma. Presssing ESC mengembalikan kontrol ke prompt pola kueri (Globs disimpan). Ketika glob didahului oleh A ! Atau ^ , lewati file yang namanya cocok dengan glob ketika glob berisi / , nama path penuh dicocokkan. Jika tidak, basa -basi dicocokkan. Ketika glob berakhir dengan A / , direktori dicocokkan.Q> (normal), F> (string tetap), G> (dasar regex), P> (pencocokan perl), dan Z> (pencocokan fuzzy). Ketika --glob= prompt ditampilkan, daftar pola Glob gaya Gitignore yang dipisahkan secara koma dapat dimasukkan. Presssing ESC mengembalikan kontrol ke prompt pola.--view .--view=COMMAND . Jika tidak, variabel lingkungan PAGER atau EDITOR digunakan untuk memohon perintah dengan Ctrl-y. Nama file harus diaktifkan dan terlihat dalam output untuk menggunakan fitur ini.--color .DELAY yang rendah seperti 1. Namun, nilai yang lebih rendah dapat meningkatkan beban sistem sebagai hasil dari berulang kali memulai dan membatalkan pencarian oleh setiap tombol yang ditekan.--heading diaktifkan secara default. Tekan Alt-+ untuk mematikan heading.Pemetaan Kunci Kueri TUI:
| kunci | fungsi |
|---|---|
Alt-key | Toggle opsi baris perintah uGrep yang sesuai dengan key |
Alt-/ xxxx / | Masukkan titik kode heks unicode u+xxxx |
Esc Ctrl-C | kembali atau keluar |
Ctrl-Q | Keluar Cepat dan Keluaran Hasil yang dipilih dalam mode seleksi |
Tab | chdir ke direktori file yang ditampilkan di bagian atas layar atau pilih file |
Shift-Tab | chdir satu level up atau hapus pilihan |
Enter | Masukkan mode seleksi dan beralihnya baris yang dipilih untuk output saat keluar |
Up Ctrl-P | bergerak ke atas |
Down Ctrl-N | bergerak ke bawah |
Left Ctrl-B | bergerak ke kiri |
Ctrl-F Right | bergerak ke kanan |
PgUp Ctrl-G | Pindahkan tampilan dengan halaman |
PgDn Ctrl-D | pindahkan tampilan ke bawah oleh halaman |
Alt-Up | Pindahkan Display Up oleh 1/2 Halaman (MacOS Shift-Up ) |
Alt-Down | Pindahkan tampilan ke bawah dengan 1/2 halaman (MacOS Shift-Down ) |
Alt-Left | Pindahkan tampilan ditinggalkan oleh 1/2 halaman (MacOS Shift-Left ) |
Alt-Right | Pindahkan Tampilan Kanan dengan 1/2 Halaman (MacOS Shift-Right ) |
Home Ctrl-A | Pindahkan kursor ke awal garis |
End Ctrl-E | Pindahkan kursor ke ujung garis |
Ctrl-K | Hapus setelah kursor |
Ctrl-L | Layar Refresh |
key Ctrl-O + | Toggle Opsi Baris Perintah UGrep yang sesuai dengan key , sama seperti Alt-key |
Ctrl-R F4 | Lompat ke Bookmark |
Ctrl-S | Lompat ke dir/file/konteks berikutnya |
Ctrl-T F5 | Toggle Split Screen ( --split memulai TUI layar terbelah) |
Ctrl-U | Hapus sebelum kursor |
Ctrl-V | Karakter kata demi kata |
Ctrl-W | Lompat kembali satu dir/file/konteks |
Ctrl-X F3 | Setel bookmark |
Ctrl-Y F2 | melihat atau mengedit file yang ditampilkan di bagian atas layar |
Ctrl-Z F1 | Lihat Bantuan dan Opsi |
Ctrl-^ | chdir kembali ke direktori kerja awal |
Ctrl-] | Toggle Color/Mono |
Ctrl- | proses penghentian |
Untuk mencari secara interaktif file di direktori kerja dan di bawah ini:
ug -Q
Sama, tetapi terbatas hanya pada file C ++ dan mengabaikan file .gitignore :
ug -Q -tc++ --ignore-files
Untuk mencari secara interaktif semua makefile di direktori kerja dan di bawah ini:
ug -Q -g 'Makefile*' -g 'makefile*'
Sama, tetapi hingga 2 level direktori (bekerja dan satu tingkat subdirektori):
ug -Q -2 -g 'Makefile*' -g 'makefile*'
Untuk secara interaktif melihat konten main.cpp dan mencarinya, di mana -y menunjukkan garis yang tidak cocok sebagai konteks:
ug -Q -y main.cpp
Untuk secara interaktif mencari main.cpp , dimulai dengan pola pencarian TODO dan konteks pencocokan 5 baris (konteks dapat diaktifkan dan dinonaktifkan secara interaktif, ini juga mengesampingkan ukuran konteks default 2 baris):
ug -Q -C5 -e TODO main.cpp
Untuk melihat dan mencari isi arsip (misalnya zip, tarball):
ug -Q -z archive.tar.gz
Untuk secara interaktif memilih file dari project.zip ke Decompress dengan unzip , menggunakan mode pemilihan UGREP Query (tekan ENTER untuk memilih baris):
unzip project.zip `zipinfo -1 project.zip | ugrep -Q`
? Kembali ke daftar isi
-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.
Jika tidak ada argumen file yang ditentukan dan input dibaca dari terminal, pencarian rekursif dilakukan seolah -olah -r ditentukan. Untuk memaksa membaca dari input standar, tentukan - sebagai argumen file.
Untuk mencantumkan semua file yang tidak kosong secara rekursif di direktori yang berfungsi:
ug -r -l ''
Untuk membuat daftar semua file yang tidak kosong di direktori kerja tetapi tidak lebih dalam (karena argumen file diberikan, dalam kasus ini . Untuk direktori kerja):
ug -l '' .
Untuk membuat daftar semua file yang tidak kosong di direktori mydir tetapi tidak lebih dalam (karena argumen file diberikan):
ug -l '' mydir
Untuk membuat daftar semua file yang tidak kosong di direktori mydir dan lebih dalam saat mengikuti symlink:
ug -R -l '' mydir
Untuk mencantumkan semua file yang tidak kosong secara rekursif di jalur yang ditentukan, saat mengunjungi subdirektori saja, IE direktori mydir/ dan subdirektori pada satu tingkat mydir/*/ dikunjungi (perhatikan bahwa -2 -l dapat disingkat -l2 ):
ug -2 -l '' mydir
Untuk mendaftar secara rekursif semua file yang tidak kosong di direktori mydir , tidak mengikuti tautan simbolik (kecuali saat pada baris perintah seperti mydir ):
ug -rl '' mydir
Untuk mendaftar secara rekursif semua makefiles yang cocok dengan teks CPP :
ug -l -tmake 'CPP'
Untuk mendaftar secara rekursif semua Makefile.* Pencocokan bin_PROGRAMS :
ug -l -g'Makefile.*' 'bin_PROGRAMS'
Untuk mencantumkan semua file yang tidak kosong secara rekursif dengan ekstensi .sh, dengan -Osh :
ug -l -Osh ''
Untuk mencantumkan semua skrip shell secara rekursif berdasarkan ekstensi dan shebangs dengan -tShell :
ug -l -tShell ''
Untuk mencantumkan semua skrip shell secara rekursif hanya berdasarkan ekstensi dengan -tshell :
ug -l -tshell ''
? Kembali ke daftar isi
--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.
Perhatikan bahwa opsi --and , --not , dan --andnot memerlukan -e PATTERN .
Opsi -% membuat semua pola berbasis boolean, mendukung operasi logis berikut yang tercantum dari tingkat prioritas tertinggi ke yang terendah:
| operator | alternatif | hasil |
|---|---|---|
"x" | Cocokkan x secara harfiah dan persis seperti yang ditentukan (menggunakan regex standar lolos Q dan E ) | |
( ) | Pengelompokan ekspresi boolean | |
-x | NOT x | pertandingan terbalik, IE pertandingan jika x tidak cocok |
x|y | x OR y | cocok dengan garis dengan x atau y |
xy | x AND y | cocok dengan garis dengan x dan y |
x dan y adalah subpatterns yang tidak dimulai dengan simbol khusus | , - , dan ( (gunakan kutipan atau melarikan diri untuk mencocokkan ini);
- NOT sama dan diutamakan lebih dari OR , yang berarti -x|y == (-x)|y misalnya.
| dan OR sama dan diutamakan lebih AND , yang berarti bahwa xy|z == x (y|z) misalnya;
Opsi --stats menampilkan kueri boolean dalam bentuk yang dapat dibaca manusia yang dikonversi ke CNF (bentuk normal konjungtif), setelah pencarian selesai. Untuk menunjukkan CNF tanpa pencarian, baca dari input standar diakhiri oleh EOF, seperti echo | ugrep -% '...' --stats .
Subpatterns-highlighted dalam output, kecuali yang dinegasikan dengan NOT (subpattern NOT mungkin masih muncul di garis yang cocok saat menggunakan pola atau tidak seperti x|-y ). Perhatikan bahwa subpattern mungkin tumpang tindih. Dalam hal ini hanya subpattern yang cocok pertama adalah warna-warna.
Beberapa baris dapat dicocokkan ketika subpatterns cocok dengan Newline. Namun ada satu pengecualian: Subpattern yang diakhiri dengan (?=X) Lookaheads mungkin tidak cocok ketika X mencakup beberapa baris.
Pola kosong cocok dengan garis apa pun (standar GREP). Oleh karena itu, -% 'x|""|y' cocok dengan segalanya dan x dan y tidak berwarna warna. Opsi -y harus digunakan untuk menunjukkan setiap baris sebagai konteks, misalnya -y 'x|y' .
Permintaan interaktif seperti FZF (pencarian boolean dengan string tetap dengan pencocokan fuzzy untuk memungkinkan EG hingga 4 karakter tambahan yang cocok dengan -Z+4 dalam kata -kata dengan -w ), tekan tab dan alt -y untuk melihat file dengan kecocokan. Tekan Shift-Tab dan Alt-L untuk kembali ke daftar file yang cocok:
ug -Q -%% -l -w -F -Z+4 --sort=best
Untuk secara rekursif menemukan semua file yang berisi hot dan dog di mana saja di file dengan opsi --files :
ug -%% 'hot dog'
ug --files -e hot --and dog
Untuk menemukan garis yang mengandung hot dan dog di myfile.txt :
ug -% 'hot dog' myfile.txt
ug -e hot --and dog myfile.txt
Untuk menemukan garis yang berisi place dan kemudian juga hotdog atau taco (atau keduanya) di myfile.txt :
ug -% 'hotdog|taco place' myfile.txt
ug -e hotdog -e taco --and place myfile.txt
Sama, tetapi mengecualikan garis pencocokan diner :
ug -% 'hotdog|taco place -diner' myfile.txt
ug -e hotdog -e taco --and place --andnot diner myfile.txt
Untuk menemukan garis dengan diner atau garis yang cocok dengan fast dan food tetapi tidak bad di myfile.txt :
ug -% 'diner|(fast food -bad)' myfile.txt
Untuk menemukan garis dengan fast food (tepat) atau garis dengan diner tetapi tidak bad atau old di myfile.txt :
ug -% '"fast food"|diner -bad -old' myfile.txt
Sama, tetapi menggunakan ekspresi boolean yang berbeda yang memiliki arti yang sama:
ug -% '"fast food"|diner -(bad|old)' myfile.txt
Untuk menemukan garis dengan diner yang menyiratkan good di myfile.txt (yaitu, tunjukkan garis dengan good tanpa diner dan tunjukkan garis dengan diner tetapi hanya mereka yang good , yang tersirat secara logis!):
ug -% 'good|-diner' myfile.txt
ug -e good --not diner myfile.txt
Untuk menemukan garis dengan foo dan -bar dan "baz" di myfile.txt (bukan itu - " harus dicocokkan menggunakan melarikan diri dan dengan --and -e -bar ):
ug -% 'foo -bar "baz"' myfile.txt
ug -e foo --and -e -bar --and '"baz"' myfile.txt
Untuk mencari myfile.cpp untuk baris dengan TODO atau FIXME tetapi tidak keduanya pada baris yang sama, seperti xor:
ug -% 'TODO|FIXME -(TODO FIXME)' myfile.cpp
ug -e TODO -e FIXME --and --not TODO --not FIXME myfile.cpp
? Kembali ke daftar isi
-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 $.
Lihat juga Pola Kueri Boolean dengan -%, -%%, -dan -tidak untuk opsi kueri Boolean yang lebih kuat daripada opsi GNU/BSD GREP tradisional.
Untuk menampilkan baris dalam file myfile.sh tetapi tidak cocok dengan garis ^[ t]*# :
ug -v '^[ t]*#' myfile.sh
Untuk mencari myfile.cpp untuk baris dengan FIXME dan urgent , tetapi tidak Scotty :
ugrep FIXME myfile.cpp | ugrep urgent | ugrep -v Scotty
Sama, tetapi menggunakan -% untuk pertanyaan boolean:
ug -% 'FIXME urgent -Scotty' myfile.cpp
Untuk mencari desimal menggunakan pola d+ yang tidak dimulai dengan 0 menggunakan pola negatif 0d+ dan tidak termasuk 555 :
ug -e 'd+' -N '0d+' -N 555 myfile.cpp
Untuk mencari kata -kata yang dimulai dengan disp tanpa mencocokkan display dalam file myfile.py dengan menggunakan "pola negatif" -N '/<display>' di mana -N menentukan pola negatif tambahan untuk melewatkan kecocokan:
ug -e '<disp' -N '<display>' myfile.py
Untuk mencari baris dengan display kata dalam file myfile.py melewatkan kata ini dalam string dan komentar, di mana -f menentukan pola dalam file yang merupakan pola yang telah ditentukan dalam kasus ini:
ug -n -w 'display' -f python/zap_strings -f python/zap_comments myfile.py
Untuk menampilkan garis yang bukan garis kosong:
ug -x -e '.*' -N 'h*' myfile.py
Sama, tetapi menggunakan -v dan -x dengan h* , yaitu pola ^h*$ :
ug -v -x 'h*' myfile.py
Untuk mendaftar secara rekursif semua file Python yang tidak berisi display kata, memungkinkan kata terjadi di string dan komentar:
ug -RL -tPython -w 'display' -f python/zap_strings -f python/zap_comments
? Kembali ke daftar isi
--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.)
File biner, ASCII dan UTF-8 tidak memerlukan opsi ini untuk mencari mereka. Juga file UTF-16 dan UTF-32 tidak memerlukan opsi ini untuk mencari mereka, dengan asumsi bahwa file UTF-16 dan UTF-32 dimulai dengan BOM UTF (tanda pesanan byte) seperti biasa. Pengkodean file lainnya memerlukan opsi --encoding=ENCODING :
| pengkodean | parameter |
|---|---|
| ASCII | tidak ada |
| UTF-8 | tidak ada |
| UTF-16 dengan bom | tidak ada |
| UTF-32 dengan bom | tidak ada |
| UTF-16 Be W/O BOM | UTF-16 atau UTF-16BE |
| UTF-16 LE W/O BOM | UTF-16LE |
| UTF-32 W/O BOM | UTF-32 atau UTF-32BE |
| UTF-32 W/O BOM | UTF-32LE |
| Latin-1 | LATIN1 atau 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 |
| Kode DOS Halaman 437 | CP437 |
| Kode DOS Halaman 850 | CP850 |
| Kode DOS Halaman 858 | CP858 |
| Kode Windows Halaman 1250 | CP1250 |
| Windows Code Page 1251 | CP1251 |
| Windows Code Page 1252 | CP1252 |
| Windows Code Page 1253 | CP1253 |
| Windows Code Page 1254 | CP1254 |
| Windows Code Page 1255 | CP1255 |
| Windows Code Page 1256 | CP1256 |
| Windows Code Page 1257 | CP1257 |
| Windows Code Page 1258 | CP1258 |
| KOI8-R | KOI8-R |
| Koi8-u | KOI8-U |
| KOI8-RU | KOI8-RU |
Perhatikan bahwa pola Regex selalu ditentukan dalam UTF-8 (termasuk ASCII). Untuk mencari file biner dengan pola biner, lihat mencari dan menampilkan file biner dengan -u, -w, dan -x.
Untuk mendaftar secara rekursif semua file yang adalah ASCII (yaitu 7-bit):
ug -L '[^[:ascii:]]'
Untuk mendaftar secara rekursif semua file yang non-ASCII, yaitu file UTF-8, UTF-16, dan UTF-32 dengan karakter unicode non-ASCII (U+0080 dan lebih tinggi):
ug -l '[^[:ascii:]]'
Untuk memeriksa apakah suatu file berisi unicode non-ASCII (U+0080 dan lebih tinggi):
ug -q '[^[:ascii:]]' myfile && echo "contains Unicode"
Untuk menghapus karakter unicode yang tidak valid dari file (perhatikan bahwa -o mungkin tidak berfungsi karena data biner terdeteksi dan ditolak dan newline ditambahkan, tetapi --format="%o% tidak memeriksa biner dan menyalin kecocokan" apa adanya " ):
ug "[p{Unicode}n]" --format="%o" badfile.txt
Untuk membuat daftar file secara rekursif dengan konten UTF yang tidak valid (yaitu urutan atau file UTF-8 yang tidak valid atau file yang berisi poin kode UTF-8/16/32 yang berada di luar rentang Unicode yang valid) dengan mencocokkan titik kode apa pun dengan . dan dengan menggunakan pola negatif -N 'p{Unicode}' untuk mengabaikan setiap karakter unicode yang valid:
ug -l -e '.' -N 'p{Unicode}'
Untuk menampilkan garis yang berisi emoji wajah tertawa:
ug '[?-?]' emojis.txt
Hasil yang sama diperoleh dengan menggunakan x{hhhh} untuk memilih rentang karakter unicode:
ug '[x{1F600}-x{1F60F}]' emojis.txt
Untuk menampilkan garis yang berisi nama Gödel (atau Goedel), Escher, atau Bach:
ug 'G(ö|oe)del|Escher|Bach' GEB.txt wiki.txt
Untuk mencari lorem di huruf besar atau atas dalam file UTF-16 yang ditandai dengan BOM UTF-16:
ug -iw 'lorem' utf16lorem.txt
Untuk mencari utf16lorem.txt ketika file ini tidak memiliki BOM UTF-16, menggunakan --encoding :
ug --encoding=UTF-16 -iw 'lorem' utf16lorem.txt
Untuk mencari file spanish-iso.txt dikodekan dalam ISO-8859-1:
ug --encoding=ISO-8859-1 -w 'año' spanish-iso.txt
? Kembali ke daftar isi
-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.
Beberapa baris dapat dicocokkan dengan pola yang cocok dengan karakter baru. Gunakan opsi -o untuk mengeluarkan kecocokan saja, bukan baris lengkap yang cocok.
Untuk mencocokkan istirahat garis n , sertakan n dalam pola agar sesuai dengan karakter LF. Jika Anda ingin mencocokkan istirahat garis rn dan n , gunakan r?n atau cukup gunakan R untuk mencocokkan jeda garis unicode rn , r , v , f , n , u +0085, U+2028 dan U+2029.
Untuk mencocokkan C/C ++ /*...*/ Komentar Multi-Line:
ug '/*(.*n)*?.**+/' myfile.cpp
Untuk mencocokkan komentar C/C ++ menggunakan pola c/comments yang telah ditentukan dengan -fc/comments , terbatas pada bagian yang cocok hanya dengan opsi -o :
ug -of c/comments myfile.cpp
Sama seperti sed -n '/begin/,/end/p' : untuk mencocokkan semua garis antara garis yang berisi begin dan baris pertama setelah itu berisi end , menggunakan pengulangan malas:
ug -o '.*begin(.|n)*?end.*' myfile.txt
? Kembali ke daftar isi
-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.
Untuk menampilkan dua baris konteks sebelum dan sesudah garis yang cocok:
ug -C2 'FIXME' myfile.cpp
Untuk menunjukkan tiga baris konteks setelah garis yang cocok:
ug -A3 'FIXME.*' myfile.cpp:
Untuk menampilkan satu baris konteks sebelum setiap baris pencocokan dengan definisi fungsi C (nama C adalah non-Usicode):
ug -B1 -f c/functions myfile.c
Untuk menampilkan satu baris konteks sebelum setiap baris pencocokan dengan definisi fungsi C ++ (nama C ++ mungkin unicode):
ug -B1 -f c++/functions myfile.cpp
Untuk menampilkan garis non -pencocokan sebagai konteks untuk garis yang cocok dengan -y :
ug -y -f c++/functions myfile.cpp
Untuk menampilkan hexdump dari garis yang cocok dengan satu baris konteks hexdump:
ug -C1 -UX 'xaaxbbxcc' a.out
Konteks dalam satu baris ditampilkan dengan opsi -o dengan opsi konteks:
ug -o -C20 'pattern' myfile.cpp
Sama, tetapi dengan output yang cantik dengan judul, nomor baris dan nomor kolom ( -k ) dan menampilkan konteks:
ug --pretty -oC20 'pattern' myfile.cpp
? Kembali ke daftar isi
-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.
Jenis file terdaftar dengan ugrep -tlist . Daftar ini didasarkan pada ekstensi nama file dan "ajaib byte". Jika Anda memiliki jenis file yang tidak terdaftar, gunakan opsi -O dan/atau -M . Anda mungkin ingin mendefinisikan alias, misalnya alias ugft='ugrep -Oft' sebagai singkatan untuk mencari file dengan sufiks nama file .ft .
Untuk secara rekursif menampilkan definisi fungsi dalam file C/C ++ ( .h , .hpp , .c , .cpp dll.) Dengan nomor baris dengan -tc++ , -o , -n , dan -f c++/functions :
ug -on -tc++ -f c++/functions
Untuk secara rekursif menampilkan definisi fungsi di file .c dan .cpp dengan nomor baris dengan -Oc,cpp , -o , -n , dan -f c++/functions :
ug -on -Oc,cpp -f c++/functions
Untuk mendaftar secara rekursif semua file shell dengan -tShell agar mencocokkan ekstensi nama file dan file dengan shell shebangs, kecuali file dengan akhiran .sh :
ug -l -tShell -O^sh ''
Untuk mendaftar secara rekursif semua file non -shell dengan -t^Shell :
ug -l -t^Shell ''
Untuk mendaftar secara rekursif semua file shell dengan shell shebangs yang tidak memiliki ekstensi nama file shell:
ug -l -tShell -t^shell ''
Untuk mencari baris dengan FIXME dalam komentar C/C ++, tidak termasuk FIXME dalam string multi-line:
ug -n 'FIXME' -f c++/zap_strings myfile.cpp
Untuk membaca pola TODO dan FIXME dari input standar untuk mencocokkan garis dalam input, sementara tidak termasuk kecocokan dalam string C ++:
ug -on -f - -f c++/zap_strings myfile.cpp <<END
TODO
FIXME
END
Untuk menampilkan elemen XML dan tag atribut dalam file XML, terbatas pada bagian yang cocok dengan -o , tidak termasuk tag yang ditempatkan di (multi -line) komentar:
ug -o -f xml/tags -f xml/zap_comments myfile.xml
? Kembali ke daftar isi
-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.
File dikompres dengan gzip ( .gz ), kompres ( .Z ), bzip2 ( .bz , .bz2 , .bzip2 ), lzma ( .lzma ), xz ( .xz ), lz4 ( .lz4 ), zstd ( .zst , .zstd ), brotli ( .br ) dan bzip3 ( .bz3 ) dicari dengan Opsi -z Ketika pustaka yang sesuai diinstal dan dikompilasi dengan UGrep. Opsi ini tidak memerlukan file untuk dikompresi. File yang tidak terkompresi dicari juga, meskipun lebih lambat.
Format kompresi lainnya dapat dicari dengan filter UGREP .
Arsip (CPIO, JAR, PAX, TAR, ZIP dan 7Z) dicari dengan opsi -z . File reguler dalam arsip yang cocok adalah output dengan arsip pathnames terlampir dalam kawat gigi { dan } . Format tar yang didukung adalah V7, Ustar, GNU, Oldgnu, dan Pax. Format CPIO yang didukung adalah ODC, NewC, dan CRC. Tidak didukung adalah format CPIO biner lama yang tidak dapat dipotong. Format Arsip CPIO, TAR, dan PAX secara otomatis diakui dengan opsi -z berdasarkan kontennya, terlepas dari akhiran nama file mereka.
Secara default, arsip tidak terkompresi yang disimpan dalam arsip ZIP juga dicari: semua file CPIO, PAX, dan tar yang disimpan dalam arsip ZIP dan 7Z secara otomatis dikenali dan dicari. Namun, secara default, file terkompresi yang disimpan dalam arsip tidak dikenali, misalnya file zip yang disimpan dalam file tar tidak dicari tetapi semua file dan arsip terkompresi dicari seolah -olah mereka adalah file biner tanpa mendekompresinya.
Tentukan --zmax=NUM untuk mencari arsip yang berisi file dan arsip terkompresi hingga level NUM . Nilai NUM dapat berkisar dari 1 hingga 99 hingga 99 langkah dekompresi dan de-arskiving untuk memperluas hingga 99 arsip bersarang. Lebih besar --zmax=NUM nilai menurunkan kinerja. Tidak mungkin Anda membutuhkan 99 karena --zmax=2 sudah cukup untuk sebagian besar kasus penggunaan praktis, seperti mencari file zip yang disimpan dalam file tar.
Ketika opsi -z digunakan dengan opsi -g , -O , -M , atau -t , arsip dan file terkompresi dan tidak terkompresi yang cocok dengan kriteria pemilihan nama file (glob, ekstensi, byte ajaib, atau jenis file) dicari saja. Misalnya, ugrep -r -z -tc++ mencari file C ++ seperti arsip main.cpp dan zip dan tar yang berisi file C ++ seperti main.cpp . Juga termasuk dalam pencarian adalah file C ++ terkompresi seperti main.cpp.gz dan main.cpp.xz saat ada. Juga arsip CPIO, PAX, TAR, ZIP, dan 7Z saat ini dicari untuk file C ++ yang dikandungnya, seperti main.cpp . Gunakan opsi --stats untuk melihat daftar pola glob yang diterapkan untuk memfilter nama path file dalam pencarian rekursif dan saat mencari konten arsip.
Ketika opsi -z digunakan dengan opsi -g , -O , -M , atau -t untuk mencari arsip CPIO, JAR, PAX, TAR, ZIP dan 7Z, file yang diarsipkan yang cocok dengan kriteria pemilihan nama file dicari saja.
Format GZIP, kompres, dan ZIP terdeteksi secara otomatis, yang berguna saat membaca data yang dikompresi GZIP dari input standar, misalnya input yang dialihkan dari pipa. Format kompresi lainnya memerlukan sufiks nama file: .bz , .bz2 , atau .bzip2 untuk bzip2, .lzma untuk lzma, .xz untuk xz, .lz4 untuk lz4, .zst atau .zstd untuk zstd, .br untuk brotli dan .bz3 untuk bzip3. Juga singkatan arsip tar terkompresi .taz , .tgz dan .tpz untuk gzip, .tbz , .tbz2 , .tb2 , dan .tz2 untuk bzip2, .tlz untuk lzma, .txz untuk xz, dan .tzst untuk zstd diakui. Untuk mencari format ini dengan UGrep dari input standar, gunakan opsi --label='stdin.bz2' untuk bzip2, --label='stdin.lzma' untuk lzma, --label='stdin.xz' untuk xz, --label='stdin.lz4 untuk lz4 dan --label='stdin.zst untuk zstd dan sebagainya. Nama stdin sewenang -wenang dan dapat dihilangkan:
| format | Suffix nama file | Tar/Pax Archive Short Suffix | Sufiks dibutuhkan? | Ugrep dari Stdin | perpustakaan |
|---|---|---|---|---|---|
| gzip | .gz | .taz , .tgz , .tpz | TIDAK | otomatis | libz |
| kompres | .Z | .taZ , .tZ | TIDAK | otomatis | bawaan |
| ritsleting | .zip , .zipx , .ZIP | TIDAK | otomatis | libz | |
| 7zip | .7z | Ya | --label=.7z | bawaan | |
| bzip2 | .bz , .bz2 , .bzip2 | .tb2 , .tbz , .tbz2 , .tz2 | Ya | --label=.bz2 | libbz2 |
| LZMA | .lzma | .tlz | Ya | --label=.lzma | Liblzma |
| xz | .xz | .txz | Ya | --label=.xz | Liblzma |
| lz4 | .lz4 | Ya | --label=.lz4 | liblz4 | |
| zstd | .zst , .zstd | .tzst | Ya | --label=.zst | libzstd |
| Brotli | .br | Ya | --label=.br | libbrotlidec | |
| BZIP3 | .bz3 | Ya | --label=.bz3 | libbzip3 |
Format GZIP, BZIP2, XZ, LZ4 dan ZSTD mendukung file terkompresi yang digabungkan. File terkompresi yang digabungkan dicari sebagai satu file tunggal.
Metode kompresi zip yang didukung disimpan (0), mengempis (8), BZIP2 (12), LZMA (14), XZ (95) dan ZSTD (93). Metode BZIP2, LZMA, XZ dan ZSTD mengharuskan UGREP untuk dikompilasi dengan pustaka kompresi yang sesuai.
Mencari arsip ZIP terenkripsi tidak didukung (mungkin dalam rilis mendatang, tergantung pada permintaan peningkatan).
Mencari arsip 7ZIP membutuhkan lebih banyak RAM dan lebih banyak waktu dibandingkan dengan metode lain. Implementasi 7ZIP LZMA SDK tidak mendukung streaming, membutuhkan file 7z yang dapat dicari secara fisik. Ini berarti bahwa file 7z tidak dapat dicari saat bersarang di dalam arsip. Yang terbaik adalah menghindari 7zip. Dukungan untuk 7ZIP dapat dinonaktifkan dengan ./build.sh --disable-7zip untuk membangun uGrep.
Opsi -z menggunakan utas untuk paralelisme tugas untuk mempercepat mencari file yang lebih besar dengan menjalankan dekompresor secara bersamaan dengan pencarian aliran yang didekompresi.
Untuk membuat daftar semua file non-kosong yang disimpan dalam arsip package.zip .
ug --zmax=2 -z -l '' package.zip
Sama, tetapi hanya daftar file kode sumber Python, termasuk skrip yang memohon Python, dengan opsi -tPython ( ugrep -tlist untuk detailnya):
ug --zmax=2 -z -l -tPython '' package.zip
Untuk mencari aplikasi Python yang didistribusikan sebagai file tar dengan dependensi mereka termasuk sebagai roda (file zip dengan kode python), mencari kata my_class di app.tgz :
ug --zmax=2 -z -tPython -w my_class app.tgz
Untuk secara rekursif mencari file C ++ termasuk file terkompresi untuk kata my_function , saat melewatkan komentar C dan C ++:
ug -z -r -tc++ -Fw my_function -f cpp/zap_comments
Untuk mencari data terkompresi BZIP2, LZMA, XZ, LZ4 dan ZSTD pada input standar, opsi --label dapat digunakan untuk menentukan ekstensi yang sesuai dengan format kompresi untuk memaksa dekompresi ketika ekstensi BZIP2 tidak tersedia untuk UGREP, misalnya: misalnya:
cat myfile.bz2 | ugrep -z --label='stdin.bz2' 'xyz'
Untuk mencari file main.cpp di project.zip untuk baris TODO dan FIXME :
ug -z -g main.cpp -w -e 'TODO' -e 'FIXME' project.zip
Untuk mencari Tarball project.tar.gz untuk file C ++ dengan baris TODO dan FIXME :
ug -z -tc++ -w -e 'TODO' -e 'FIXME' project.tar.gz
Untuk mencari file yang cocok dengan glob *.txt di project.zip untuk license kata dalam kasus apa pun (perhatikan bahwa argumen -g glob harus dikutip):
ug -z -g '*.txt' -w -i 'license' project.zip
Untuk menampilkan dan halaman melalui semua file C ++ di Tarball project.tgz :
ug --pager -z -tc++ '' project.tgz
Untuk mendaftar file yang cocok dengan GITIGNOR-gaya glob /**/projects/project1.* di projects.tgz , dengan memilih file yang berisi dalam arsip teks December 12 :
ug -z -l -g '/**/projects/project1.*' -F 'December 12' projects.tgz
Untuk melihat data meta -inf/manifest.mf dalam file jar dengan -Ojar dan -OMF untuk memilih file jar dan file mf di dalamnya ( -Ojar diperlukan, jika tidak file jar akan dilewati meskipun kita bisa membacanya darinya Input standar sebagai gantinya):
ug -z -h -OMF,jar '' my.jar
Untuk mengekstrak file C ++ yang berisi FIXME dari project.tgz , kami menggunakan -m1 dengan --format="'%z '" untuk menghasilkan daftar jalur path yang dipisahkan ruang yang terletak di arsip yang cocok dengan kata FIXME :
tar xzf project.tgz `ugrep -z -l -tc++ --format='%z ' -w FIXME project.tgz`
Untuk melakukan pencarian kedalaman-pertama dengan find , lalu gunakan cpio dan ugrep untuk mencari file:
find . -depth -print | cpio -o | ugrep -z 'xyz'
? Kembali ke daftar isi
--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.
Untuk mendaftar secara rekursif semua file yang dimulai dengan #! Shebangs:
ug -l -M'#!' ''
Untuk mencantumkan semua file yang dimulai dengan # tetapi tidak dengan #! Shebangs:
ug -l -M'#' -M'^#!' ''
Untuk mencantumkan semua file Python secara rekursif (ekstensi .py atau shebang) dengan -tPython :
ug -l -tPython ''
Untuk mendaftar secara rekursif semua file non -shell dengan -t^Shell :
ug -l -t^Shell ''
Untuk membuat daftar file python secara rekursif (ekstensi .py atau shebang) yang memiliki pernyataan impor, termasuk file tersembunyi dengan -. :
ug -l. -tPython -f python/imports
? Kembali ke daftar isi
-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.
Awal dari suatu pola selalu cocok dengan karakter pertama dari kecocokan perkiraan sebagai strategi praktis untuk mencegah banyak kecocokan "acak" palsu untuk pola pendek. Ini juga sangat meningkatkan kecepatan pencarian. Buat karakter pertama opsional untuk mencocokkan secara opsional, misalnya p?attern atau gunakan titik sebagai awal pola agar sesuai dengan karakter lebar (tapi ini lambat).
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.
? Kembali ke daftar isi
--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'
? Kembali ke daftar isi
--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. Misalnya:
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.
? Kembali ke daftar isi
--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
? Kembali ke daftar isi
-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'
? Kembali ke daftar isi
--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
? Kembali ke daftar isi
-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:
| pola | pertandingan |
|---|---|
* | 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
? Kembali ke daftar isi
--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'
? Kembali ke daftar isi
-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
? Kembali ke daftar isi
-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'
? Kembali ke daftar isi
--color[=WHEN], --colour[=WHEN]
Mark up the matching text with the expression stored in the
GREP_COLOR or GREP_COLORS environment variable. The possible
values of WHEN can be `never', `always', or `auto', where `auto'
marks up matches only when output on a terminal. The default is
`auto'.
--colors=COLORS, --colours=COLORS
Use COLORS to mark up text. COLORS is a colon-separated list of
one or more parameters `sl=' (selected line), `cx=' (context line),
`mt=' (matched text), `ms=' (match selected), `mc=' (match
context), `fn=' (file name), `ln=' (line number), `cn=' (column
number), `bn=' (byte offset), `se=' (separator), `qp=' (TUI
prompt), `qe=' (TUI errors), `qr=' (TUI regex), `qm=' (TUI regex
meta characters), `ql=' (TUI regex lists and literals), `qb=' (TUI
regex braces). Parameter values are ANSI SGR color codes or `k'
(black), `r' (red), `g' (green), `y' (yellow), `b' (blue), `m'
(magenta), `c' (cyan), `w' (white), or leave empty for no color.
Upper case specifies background colors. A `+' qualifies a color as
bright. A foreground and a background color may be combined with
font properties `n' (normal), `f' (faint), `h' (highlight), `i'
(invert), `u' (underline). Parameter `hl' enables file name
hyperlinks. Parameter `rv' reverses the `sl=' and `cx=' parameters
when option -v is specified. Selectively overrides GREP_COLORS.
Legacy grep single parameter codes may be specified, for example
--colors='7;32' or --colors=ig to set ms (match selected).
--tag[=TAG[,END]]
Disables colors to mark up matches with TAG. END marks the end of
a match if specified, otherwise TAG. The default is `___'.
--pager[=COMMAND]
When output is sent to the terminal, uses COMMAND to page through
the output. COMMAND defaults to environment variable PAGER when
defined or `less'. Enables --heading and --line-buffered.
--pretty[=WHEN]
When output is sent to a terminal, enables --color, --heading, -n,
--sort, --tree and -T when not explicitly disabled. WHEN can be
`never', `always', or `auto'. The default is `auto'.
--tree, -^
Output directories with matching files in a tree-like format for
option -c or --count, -l or --files-with-matches, -L or
--files-without-match. This option is enabled by --pretty when the
output is sent to a terminal.
To change the color palette, set the GREP_COLORS environment variable or use --colors=COLORS . The value is a colon-separated list of ANSI SGR parameters that defaults to cx=33:mt=1;31:fn=1;35:ln=1;32:cn=1;32:bn=1;32:se=36 :
| param | hasil |
|---|---|
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:
| kode | C | memengaruhi | kode | C | memengaruhi |
|---|---|---|---|---|---|
| 0 | N | normal font and color | 2 | F | faint (not widely supported) |
| 1 | H | highlighted bold font | 21 | H | highlighted bold off |
| 4 | kamu | menggarisbawahi | 24 | kamu | underline off |
| 7 | Saya | invert video | 27 | SAYA | invert off |
| 30 | k | teks hitam | 90 | +k | bright gray text |
| 31 | R | teks merah | 91 | +r | bright red text |
| 32 | G | green text | 92 | +g | bright green text |
| 33 | kamu | yellow text | 93 | +y | bright yellow text |
| 34 | B | blue text | 94 | +b | bright blue text |
| 35 | M | magenta text | 95 | +m | bright magenta text |
| 36 | C | cyan text | 96 | +c | bright cyan text |
| 37 | w | white text | 97 | +w | bright white text |
| 40 | K | latar belakang hitam | 100 | +K | bright gray background |
| 41 | R | latar belakang merah tua | 101 | +R | bright red background |
| 42 | G | dark green background | 102 | +G | bright green background |
| 43 | Y | dark yellow backgrounda | 103 | +Y | bright yellow background |
| 44 | B | latar belakang biru tua | 104 | +B | bright blue background |
| 45 | M | dark magenta background | 105 | +M | bright magenta background |
| 46 | C | dark cyan background | 106 | +C | bright cyan background |
| 47 | W | dark white background | 107 | +W | bright white background |
See Wikipedia ANSI escape code - SGR parameters
For quick and easy color specification, the corresponding single-letter color names may be used in place of numeric SGR codes and semicolons are not required to separate color names. Color names and numeric codes may be mixed.
For example, to display matches in underlined bright green on bright selected lines, aiding in visualizing white space in matches and file names:
export GREP_COLORS='sl=1:cx=33:ms=1;4;32;100:mc=1;4;32:fn=1;32;100:ln=1;32:cn=1;32:bn=1;32:se=36'
The same, but with single-letter color names:
export GREP_COLORS='sl=h:cx=y:ms=hug+K:mc=hug:fn=hg+K:ln=hg:cn=hg:bn=hg:se=c'
Another color scheme that works well:
export GREP_COLORS='cx=hb:ms=hiy:mc=hic:fn=hi+y+K:ln=hg:cn=hg:bn=hg:se='
Modern Windows command interpreters support ANSI escape codes. Named or numeric colors can be set with SET GREP_COLORS , for example:
SET GREP_COLORS=sl=1;37:cx=33:mt=1;31:fn=1;35:ln=1;32:cn=1;32:bn=1;32:se=36
To disable colors on Windows:
SET GREP_COLORS=""
Color intensities may differ per platform and per terminal program used, which affects readability.
Option -y outputs every line of input, including non-matching lines as context. The use of color helps distinguish matches from non-matching context.
To copy silver searcher's color palette:
export GREP_COLORS='mt=30;43:fn=1;32:ln=1;33:cn=1;33:bn=1;33'
To produce color-highlighted results ( --color is redundance since it is the default):
ug --color -r -n -k -tc++ 'FIXME.*'
To page through the results with pager ( less -R by default):
ug --pager -r -n -k -tc++ 'FIXME'
To display a hexdump of a zip file itself (ie without decompressing), with color-highlighted matches of the zip magic bytes PKx03x04 ( --color is redundant since it is the default):
ug --color -y -UX 'PKx03x04' some.zip
To use predefined patterns to list all #include and #define in C++ files:
ug --pretty -r -n -tc++ -f c++/includes -f c++/defines
Same, but overriding the color of matches as inverted yellow (reverse video) and headings with yellow on blue using --pretty :
ug --pretty --colors="ms=yi:fn=hyB" -r -n -tc++ -f c++/includes -f c++/defines
To list all #define FOO... macros in C++ files, color-highlighted:
ug --color=always -r -n -tc++ -f c++/defines | ug 'FOO.*'
Same, but restricted to .cpp files only:
ug --color=always -r -n -Ocpp -f c++/defines | ug 'FOO.*'
To search tarballs for matching names of PDF files (assuming bash is our shell):
for tb in *.tar *.tar.gz *.tgz; do echo "$tb"; tar tfz "$tb" | ugrep '.*.pdf$'; done
? Kembali ke daftar isi
--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
? Kembali ke daftar isi
--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:
| pilihan | hasil |
|---|---|
--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| pilihan | format string (within quotes) |
|---|---|
--format-open | '%+' |
--format | '%[,]$%H%N%K%B%V%~%u' |
--json| pilihan | 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| pilihan | 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| pilihan | format string (within quotes) |
|---|---|
--format-open | '%+' |
--format | '%F%n%s%K%B%~%u' |
The following fields may be used in the FORMAT string:
| bidang | keluaran |
|---|---|
%% | 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 |
Catatan:
%~ 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
? Kembali ke daftar isi
--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
? Kembali ke daftar isi
--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
? Kembali ke daftar isi
-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*$'
? Kembali ke daftar isi
-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
? Kembali ke daftar isi
--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'
? Kembali ke daftar isi
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+'
? Kembali ke daftar isi
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 '`[^`]*`'
? Kembali ke daftar isi
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)
? Kembali ke daftar isi
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 ψ :
| Pola | Cocok |
|---|---|
x | matches the character x , where x is not a special character |
. | matches any single character except newline (unless in dotall mode) |
. | matches . (dot), special characters are escaped with a backslash |
n | matches a newline, others are a (BEL), b (BS), t (HT), v (VT), f (FF), and r (CR) |
| matches the NUL character |
cX | matches the control character X mod 32 (eg cA is x01 ) |
141 | matches an 8-bit character with octal value 141 , ie a |
x7f | matches an 8-bit character with hexadecimal value 7f |
x{3B1} | matches Unicode character U+03B1, ie α |
u{3B1} | matches Unicode character U+03B1, ie α |
o{141} | matches Unicode character U+0061, ie a , in octal |
p{C} | matches a character in Unicode category C |
Q...E | matches the quoted content between Q and E literally |
[abc] | matches one of a , b , or c |
[0-9] | matches a digit 0 to 9 |
[^0-9] | matches any character except a digit and excluding n |
φ? | matches φ zero or one time (optional) |
φ* | matches φ zero or more times (repetition) |
φ+ | matches φ one or more times (repetition) |
φ{2,5} | matches φ two to five times (repetition) |
φ{2,} | matches φ at least two times (repetition) |
φ{2} | matches φ exactly two times (repetition) |
φ?? | matches φ zero or once as needed (lazy optional) |
φ*? | matches φ a minimum number of times as needed (lazy repetition) |
φ+? | matches φ a minimum number of times at least once as needed (lazy repetition) |
φ{2,5}? | matches φ two to five times as needed (lazy repetition) |
φ{2,}? | matches φ at least two times or more as needed (lazy repetition) |
φψ | matches φ then matches ψ (concatenation) |
φ⎮ψ | matches φ or matches ψ (alternation) |
(φ) | matches φ as a group |
(?:φ) | matches φ as a group without capture |
(?=φ) | matches φ without consuming it, ie lookahead (without option -P : nothing may occur after (?=φ) ) |
(?^φ) | matches φ and ignores it, marking everything in the pattern as a non-match |
^φ | matches φ at the start of input or start of a line (nothing may occur before ^ ) |
φ$ | matches φ at the end of input or end of a line (nothing may occur after $ ) |
Aφ | matches φ at the start of input (nothing may occur before A ) |
φz | matches φ at the end of input (nothing may occur after z ) |
bφ | matches φ starting at a word boundary (without option -P : nothing may occur before b ) |
φb | matches φ ending at a word boundary (without option -P : nothing may occur after b ) |
Bφ | matches φ starting at a non-word boundary (without option -P : nothing may occur before B ) |
φB | matches φ ending at a non-word boundary (without option -P : nothing may occur after B ) |
<φ | matches φ that starts a word (without option -P : nothing may occur before < ) |
>φ | matches φ that starts a non-word (without option -P : nothing may occur before > ) |
φ< | matches φ that ends a non-word (without option -P : nothing may occur after < ) |
φ> | matches φ that ends a word (without option -P : nothing may occur after > ) |
(?i:φ) | matches φ ignoring case |
(?s:φ) | . (dot) in φ matches newline |
(?x:φ) | ignore all whitespace and comments in φ |
(?#:X) | all of X is skipped as a comment |
The order of precedence for composing larger patterns from sub-patterns is as follows, from high to low precedence:
(φ) , (?:φ) , (?=φ) , and inline modifiers (?imsux:φ)? , * , + , {n,m}φψ^ , $ , < , > , b , B , A , zφ|ψ(?imsux)φ? Kembali ke daftar isi
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 ):
| Pola | Cocok |
|---|---|
[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.
? Kembali ke daftar isi
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 | Cocok |
|---|---|
[: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 | Cocok |
|---|---|
. | 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.
? Kembali ke daftar isi
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.
? Kembali ke daftar isi
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
