ugrep
v7.1.1
[ อ่านต่อ | คู่มือผู้ใช้ | การจัดทำดัชนี | เกณฑ์มาตรฐาน | ถามตอบ ]
ตัวเลือก -Q เปิดแบบสอบถาม TUI เพื่อค้นหาไฟล์ในขณะที่คุณพิมพ์!
ugrep นั้นรวดเร็ว ใช้งานง่าย และมาพร้อมกับฟีเจอร์ใหม่ๆ มากมายที่ผู้ใช้ต้องการ
รวม TUI แบบโต้ตอบพร้อมความช่วยเหลือในตัว การค้นหาแบบ Google ที่มีรูปแบบ AND/OR/NOT การค้นหาแบบคลุมเครือ การค้นหา (ซ้อนกัน) zip/7z/tar/pax/cpio archives tarballs และไฟล์บีบอัด gz/Z/bz/ bz2/lzma/xz/lz4/zstd/brotli, ค้นหาและไฟล์ไบนารี hexdump, ค้นหาเอกสารเช่น PDF, doc, docx และเอาต์พุตใน JSON, XML, CSV หรือรูปแบบที่คุณกำหนดเอง
ไวยากรณ์รูปแบบ regex แบบขยาย Unicode พร้อมการจับคู่รูปแบบหลายบรรทัดโดยไม่ต้องใช้ตัวเลือกบรรทัดคำสั่งพิเศษ
รวมถึงตัวสร้างดัชนีไฟล์เพื่อเพิ่มความเร็วในการค้นหาระบบไฟล์ที่ช้าและเย็น
การแทนที่แบบดรอปอินที่แท้จริงสำหรับ GNU grep (สมมติว่าคุณคัดลอกหรือเชื่อมโยง ug ไปยัง grep และเพื่อ egrep และ fgrep ) ซึ่งแตกต่างจาก grep ยอดนิยมอื่น ๆ ที่อ้างว่าเป็น "ทางเลือก grep" หรือ "การแทนที่" เมื่อสิ่งเหล่านั้นใช้บรรทัดคำสั่งที่เข้ากันไม่ได้จริง ตัวเลือกและใช้ตัวจับคู่ regex ที่เข้ากันไม่ได้ เช่น Perl regex เท่านั้นกับ POSIX BRE (grep) และ ERE (egrep) เมื่อ ugrep รองรับ regex ทั้งหมด โหมด
การวัดประสิทธิภาพแสดงให้เห็นว่า ugrep เป็น (หนึ่งใน) grep ที่เร็วที่สุดโดยใช้ RE/flex regex matcher ที่ใช้ DFA ประสิทธิภาพสูง
หากควรปรับปรุงหรือเพิ่มสิ่งใดใน ugrep โปรดแจ้งให้เราทราบ!
ลำดับความสำคัญอันดับ 1 คือการประกันคุณภาพเพื่อให้แน่ใจว่า ugrep ไม่มีข้อบกพร่องและเชื่อถือได้
ทำให้ ugrep ทำงานเร็วขึ้นอีก ดูตัวอย่าง #432, #421
แบ่งปันผลลัพธ์ประสิทธิภาพที่สามารถทำซ้ำได้
ug มีไว้สำหรับการใช้งานแบบโต้ตอบ ซึ่งจะโหลดไฟล์การกำหนดค่า .ugrep เสริมพร้อมการตั้งค่าของคุณที่อยู่ในไดเร็กทอรีการทำงานหรือโฮมไดเร็กตอรี่ นอกจากนี้ ug+ ยังค้นหาไฟล์ PDF, เอกสาร, e-books, ข้อมูลเมตาของรูปภาพด้วย
ugrep สำหรับการใช้งานเป็นกลุ่ม เช่น GNU grep ที่ไม่มีไฟล์การกำหนดค่า .ugrep นอกจากนี้ ugrep+ ยังค้นหาไฟล์ PDF, เอกสาร, e-books, ข้อมูลเมตาของรูปภาพ
จับคู่รูปแบบ Unicode ตามค่าเริ่มต้นและค้นหาไฟล์ที่เข้ารหัส UTF-8, UTF-16 และ UTF-32 โดยอัตโนมัติ
จับคู่หลายบรรทัดด้วย n หรือ R ในรูปแบบ regex ไม่จำเป็นต้องมีตัวเลือกพิเศษในการทำเช่นนั้น!
ความช่วยเหลือในตัว: ug --help โดยที่ ug --help WHAT แสดงตัวเลือกที่เกี่ยวข้องกับ WHAT คุณกำลังมองหา
ug --help regex , ug --help globs , ug --help fuzzy , ug --help format
ใช้งานง่ายด้วยไฟล์การกำหนดค่าที่ปรับแต่งได้ซึ่งใช้โดยคำสั่ง ug มีไว้สำหรับการใช้งานแบบโต้ตอบที่โหลดไฟล์การกำหนดค่า .ugrep พร้อมการตั้งค่าของคุณ
ug PATTERN ... ugrep --config PATTERN ...
ug --save-config ...options-you-want-to-save... บันทึกไฟล์ .ugrep config ในไดเร็กทอรีการทำงาน เพื่อให้ครั้งต่อไปที่คุณเรียกใช้ ug ที่นั่น จะใช้ตัวเลือกเหล่านี้ ทำสิ่งนี้ในโฮมไดเร็กตอรี่ของคุณเพื่อบันทึกไฟล์กำหนดค่า .ugrep พร้อมตัวเลือกที่คุณต้องการใช้โดยทั่วไป
TUI การสืบค้นเชิงโต้ตอบ กด F1 หรือ CTRL-Z เพื่อขอความช่วยเหลือ และ TAB/SHIFT-TAB เพื่อนำทางไปยัง dirs และไฟล์
ug -Q ug -Q -e PATTERN
-Q แทนที่ PATTERN บนบรรทัดคำสั่งเพื่อให้คุณป้อนรูปแบบแบบโต้ตอบใน TUI ใน TUI ใช้ปุ่ม ALT+ตัวอักษรเพื่อสลับเปิด/ปิด "ตัวเลือกตัวอักษร" แบบสั้น เช่น ALT-n (ตัวเลือก -n ) เพื่อแสดง/ซ่อนหมายเลขบรรทัด
ค้นหาเนื้อหาของไฟล์เก็บถาวร (zip, tar, pax, jar, cpio, 7z) และไฟล์บีบอัด (gz, Z, bz, bz2, lzma, xz, lz4, zstd, brotli)
ug -z PATTERN ... ug -z --zmax=2 PATTERN ...
ระบุ -z --zmax=2 เพื่อค้นหาไฟล์บีบอัดและไฟล์เก็บถาวรที่ซ้อนอยู่ภายในไฟล์เก็บถาวร อาร์กิวเมนต์ --zmax อาจมีตั้งแต่ 1 (ค่าเริ่มต้น) ถึง 99 สำหรับขั้นตอนการบีบอัดและยกเลิกการเก็บถาวรสูงสุด 99 ขั้นตอนเพื่อค้นหาไฟล์เก็บถาวรที่ซ้อนกัน
ค้นหาด้วยรูปแบบข้อความค้นหาแบบบูลีนที่เหมือนกับ Google โดยใช้รูปแบบ -% ด้วย AND (หรือเพียงแค่เว้นวรรค), OR (หรือแท่ง | ), NOT (หรือขีดกลาง - ) โดยใช้เครื่องหมายคำพูดเพื่อให้ตรงกันทุกประการ และจัดกลุ่มด้วย ( ) (แสดงบน ด้านซ้ายด้านล่าง); หรือมีตัวเลือก -e (เป็น "หรือ") --and , --andnot และ --not รูปแบบ regex (แสดงทางด้านขวาด้านล่าง):
ug -% 'A B C' ... ug -e 'A' --and 'B' --and 'C' ...
ug -% 'A|B C' ... ug -e 'A' -e 'B' --and 'C' ...
ug -% 'A -B -C' ... ug -e 'A' --andnot 'B' --andnot 'C' ...
ug -% 'A -(B|C)'... ug -e 'A' --andnot 'B' --andnot 'C' ...
ug -% '"abc" "def"' ... ug -e 'QabcE' --and 'QdefE' ...
โดยที่ A , B และ C เป็นรูปแบบ regex โดยพลการ (ใช้ตัวเลือก -F เพื่อค้นหาสตริง)
ระบุตัวเลือก -%% ( --bool --files ) เพื่อใช้แบบสอบถามบูลีนกับไฟล์โดยรวม: ไฟล์จะจับคู่หากเงื่อนไขบูลีนทั้งหมดเป็นไปตามรูปแบบการจับคู่ทั้งไฟล์ มิฉะนั้น เงื่อนไขบูลีนจะมีผลกับบรรทัดเดียวตามค่าเริ่มต้น เนื่องจากโดยทั่วไปยูทิลิตี้ grep เป็นตัวจับคู่รูปแบบตามบรรทัด ตัวเลือก --stats แสดงข้อความค้นหาในรูปแบบที่มนุษย์สามารถอ่านได้หลังจากการค้นหาเสร็จสิ้น
ค้นหา pdf, doc, docx, e-book และอื่นๆ ด้วย ug+ โดยใช้ตัวกรองที่เกี่ยวข้องกับนามสกุลไฟล์:
ug+ PATTERN ...
หรือระบุ --filter ด้วยประเภทไฟล์เพื่อใช้ยูทิลิตี้ตัวกรอง:
ug --filter='pdf:pdftotext % -' PATTERN ...
ug --filter='doc:antiword %' PATTERN ...
ug --filter='odt,docx,epub,rtf:pandoc --wrap=preserve -t plain % -o -' PATTERN ...
ug --filter='odt,doc,docx,rtf,xls,xlsx,ppt,pptx:soffice --headless --cat %' PATTERN ...
ug --filter='pem:openssl x509 -text,cer,crt,der:openssl x509 -text -inform der' PATTERN ...
ug --filter='latin1:iconv -f LATIN1 -t UTF-8' PATTERN ...
คำสั่ง ug+ เหมือนกับคำสั่ง ug แต่ยังใช้ตัวกรองเพื่อค้นหา PDF เอกสาร และข้อมูลเมตาของรูปภาพด้วย
แสดงบริบทแนวนอนด้วยตัวเลือก -o ( --only-matching ) และตัวเลือกบริบท -ABC เช่น เพื่อค้นหารายการที่ตรงกันในบรรทัดที่ยาวมาก เช่น แหล่งที่มาของ Javascript และ JSON:
ug -o -C20 -nk PATTERN longlines.js
-o -C20 เหมาะกับการจับคู่ทั้งหมดที่มีบริบทเป็นอักขระ 20 ตัวก่อนและ 20 ตัวอักษรหลังการจับคู่ (เช่น รวมอักขระ Unicode ทั้งหมด 40 ตัว) -nk เอาต์พุตบรรทัดและหมายเลขคอลัมน์
ค้นหารูปแบบโดยประมาณที่ตรงกันด้วยการค้นหาแบบคลุมเครือ ภายในระยะทาง Levenshtein ที่ระบุ
ug -Z PATTERN ... ug -Z3 PATTTERN ...
-Zn จับคู่อักขระพิเศษที่หายไปหรือถูกแทนที่สูงสุด n ตัว -Z+n จับคู่อักขระพิเศษสูงสุด n ตัว -Zn จับคู่อักขระที่หายไปสูงสุด n และ -Z~n จับคู่อักขระที่ถูกแทนที่สูงสุด n ตัว -Z มีค่าเริ่มต้นเป็น -Z1
การค้นหาแบบ Fzf ด้วย regex (หรือสตริงคงที่ด้วย -F ) การจับคู่แบบคลุมเครือด้วยอักขระพิเศษสูงสุด 4 ตัวด้วย -Z+4 และคำเฉพาะด้วย -w ใช้ -%% สำหรับการค้นหาบูลีนทั้งไฟล์
ug -Q -%% -l -w -Z+4 --sort=best
-l แสดงรายการไฟล์ที่ตรงกันใน TUI กด TAB จากนั้น ALT-y เพื่อดูไฟล์ SHIFT-TAB และ Alt-l เพื่อกลับไปดูรายการไฟล์ที่ตรงกันโดยเรียงลำดับตามการจับคู่ที่ดีที่สุด
ค้นหาไฟล์ไบนารีและแสดง hexdumps ด้วยการจับคู่รูปแบบไบนารี (ข้อความ Unicode หรือ -U สำหรับรูปแบบไบต์)
ug --hexdump -U BYTEPATTERN ... ug --hexdump TEXTPATTERN ...
ug -X -U BYTEPATTERN ... ug -X TEXTPATTERN ...
ug -W -U BYTEPATTERN ... ug -W TEXTPATTERN ...
--hexdump=4chC1 แสดง 4 คอลัมน์ของเลขฐานสิบหกโดยไม่มีคอลัมน์อักขระ c ไม่มีการเว้นวรรคเลขฐานสิบหก h และมีบรรทัดเลขฐานสิบหกพิเศษหนึ่งบรรทัด C1 ก่อนและหลังการแข่งขัน
รวมไฟล์เพื่อค้นหาตามประเภทไฟล์หรือไฟล์ "magic bytes" หรือยกเว้นด้วย ^
ug -t TYPE PATTERN ... ug -t ^TYPE PATTERN ...
ug -M 'MAGIC' PATTERN ... ug -M '^MAGIC' PATTERN ...
รวมไฟล์และไดเร็กทอรีเพื่อค้นหาที่ตรงกับ globs สไตล์ gitignore หรือแยกออกด้วย ^
ug -g 'FILEGLOB' PATTERN ... ug -g '^FILEGLOB' PATTERN ...
ug -g 'DIRGLOB/' PATTERN ... ug -g '^DIRGLOB/' PATTERN ...
ug -g 'PATH/FILEGLOB' PATTERN ... ug -g '^PATH/FILEGLOB' PATTERN ...
ug -g 'PATH/DIRGLOB/' PATTERN ... ug -g '^PATH/DIRGLOB/' PATTERN ...
รวมไฟล์เพื่อค้นหาด้วยนามสกุลไฟล์ (ส่วนต่อท้าย) หรือยกเว้นด้วย ^ ซึ่งเป็นชวเลขสำหรับ -g"*.EXT"
ug -O EXT PATTERN ... ug -O ^EXT PATTERN ...
รวมไฟล์ที่ซ่อน (dotfiles) และไดเร็กทอรีที่จะค้นหา (ละไว้ตามค่าเริ่มต้น)
ug -. PATTERN ... ug -g'.*,.*/' PATTERN ...
ระบุ hidden ใน .ugrep ของคุณเพื่อค้นหาไฟล์ที่ซ่อนด้วย ug เสมอ
ยกเว้นไฟล์ที่ระบุโดย .gitignore ฯลฯ
ug --ignore-files PATTERN ... ug --ignore-files=.ignore PATTERN ...
ระบุ ignore-files ใน .ugrep ของคุณเพื่อละเว้นไฟล์เหล่านั้นด้วย ug เสมอ เพิ่ม ignore-files=... เพิ่มเติมตามต้องการ
รูปแบบการค้นหาที่ไม่รวมรูปแบบเชิงลบ ("จับคู่สิ่งนี้แต่ไม่เป็นเช่นนั้น")
ug -e PATTERN -N NOTPATTERN ... ug -e '[0-9]+' -N 123 ...
ใช้รูปแบบ regex ที่กำหนดไว้ล่วงหน้าเพื่อค้นหาซอร์สโค้ด, จาวาสคริปต์, XML, JSON, HTML, PHP, มาร์กดาวน์ ฯลฯ
ug PATTERN -f c++/zap_comments -f c++/zap_strings ...
ug PATTERN -f php/zap_html ...
ug -f js/functions ... | ug PATTERN ...
จัดเรียงไฟล์ที่ตรงกันตามชื่อ ตรงที่สุด ขนาด และเวลา
ug --sort PATTERN ... ug --sort=size PATTERN ...
ug --sort=changed PATTERN ... ug --sort=created PATTERN ...
ug -Z --sort=best PATTERN ... ug --no-sort PATTERN ...
ผลลัพธ์เอาต์พุตในรูปแบบ CSV, JSON, XML และรูปแบบที่ผู้ใช้ระบุ
ug --csv PATTERN ... ug --json PATTERN ...
ug --xml PATTERN ... ug --format='file=%f line=%n match=%O%~' PATTERN ...
ug --help format แสดงความช่วยเหลือในรูปแบบ % ฟิลด์สำหรับเอาต์พุตที่กำหนดเอง
ค้นหาด้วยรูปแบบ regex ที่เข้ากันได้กับ Perl ของ PCRE และแสดงหรือแทนที่การจับคู่รูปแบบย่อย
ug -P PATTERN ... ug -P --format='%1 and %2%~' 'PATTERN(SUB1)(SUB2)' ...
แทนที่รูปแบบในเอาต์พุตด้วย -P และ --replace ข้อความแทนที่ โดยอาจมีฟิลด์การจัดรูปแบบ % หรือไม่ก็ได้ โดยใช้ -y เพื่อส่งผ่านส่วนที่เหลือของไฟล์ผ่าน:
ug --replace='TEXT' PATTERN ... ug -y --replace='TEXT' PATTERN ...
ug --replace='(%m:%o)' PATTERN ... ug -y --replace='(%m:%o)' PATTERN ...
ug -P --replace='%1' PATTERN ... ug -y -P --replace='%1' PATTERN ...
ug --help format แสดงความช่วยเหลือในรูปแบบ % ฟิลด์ที่จะเลือกใช้กับ --replace
ค้นหาไฟล์ด้วยรูปแบบการเข้ารหัสเฉพาะ เช่น ISO-8859-1 ถึง 16, CP 437, CP 850, MACROMAN, KOI8 เป็นต้น
ug --encoding=LATIN1 PATTERN ...
ติดตั้ง ugrep ล่าสุดด้วย Homebrew:
$ brew install ugrep
หรือติดตั้งด้วย MacPorts:
$ sudo port install ugrep
การดำเนินการนี้จะติดตั้งคำสั่ง ugrep และ ug โดยที่ ug เหมือนกับ ugrep แต่ยังโหลดไฟล์การกำหนดค่า .ugrep เมื่อมีอยู่ในไดเร็กทอรีทำงานหรือโฮมไดเร็กทอรี
ติดตั้งด้วย Winget winget install Genivia.ugrep
หรือติดตั้งด้วย Chocolatey choco install ugrep
หรือติดตั้งด้วย Scoop scoop install ugrep
หรือดาวน์โหลดไฟล์ปฏิบัติการ ugrep.exe ที่มีคุณสมบัติครบถ้วนในรูปแบบ release artifact จาก https://github.com/Genivia/ugrep/releases รุ่นซิปประกอบด้วยไบนารี ugrep.exe หลักและ ug.exe คำสั่ง ug มีไว้สำหรับการใช้งานเชิงโต้ตอบ โหลดและอ่านการตั้งค่าจากไฟล์คอนฟิกูเรชัน .ugrep (เมื่อมีอยู่ในไดเร็กทอรีการทำงานหรือโฮมไดเร็กทอรี)
เพิ่ม ugrep.exe และ ug.exe ไปยังเส้นทางการดำเนินการของคุณ: ไปที่ การตั้งค่า และค้นหา "เส้นทาง" ใน ค้นหาการตั้งค่า เลือก ตัวแปรสภาพแวดล้อม -> เส้นทาง -> ใหม่ และเพิ่มไดเร็กทอรีที่คุณวางไฟล์ปฏิบัติการ ugrep.exe และ ug.exe
เคล็ดลับ
คำแนะนำที่เป็นประโยชน์เกี่ยวกับการใช้ ugrep.exe และ ug.exe บนบรรทัดคำสั่งของ Windows:
' เดี่ยว แต่ใช้ " แทน ยูทิลิตี้คำสั่ง Windows ส่วนใหญ่พิจารณาส่วนเครื่องหมายคำพูด ' เดี่ยวของอาร์กิวเมนต์บรรทัดคำสั่ง!-g/GLOB แทนอาร์กิวเมนต์บรรทัดคำสั่ง GLOB ปกติเพื่อเลือกไฟล์และไดเร็กทอรีที่จะค้นหา โดยเฉพาะอย่างยิ่งสำหรับการค้นหาแบบเรียกซ้ำ"" เพื่อให้ตรงกับอินพุตทั้งหมด สิ่งนี้อาจถูกละเลยโดยล่ามคำสั่ง Windows บางตัว เช่น Powershell ในกรณีนี้คุณต้องระบุตัวเลือก --match แทนR แทน n เพื่อจับคู่การขึ้นบรรทัดใหม่ของ Unicode เช่น คู่ rn และ single r และ n $ apk add ugrep ugrep-doc
ตรวจสอบhttps://pkgs.alpinelinux.org/packages?name=ugrepสำหรับข้อมูลเวอร์ชัน
$ pacman -S ugrep
ตรวจสอบhttps://archlinux.org/packages/extra/x86_64/ugrepสำหรับข้อมูลเวอร์ชัน
ขั้นแรกให้เปิดใช้งานที่เก็บ EPEL จากนั้นจึงติดตั้ง ugrep ได้
$ dnf install ugrep
ตรวจสอบhttps://packages.fedoraproject.org/pkgs/ugrep/ugrep/ สำหรับข้อมูลเวอร์ชัน
$ apt-get install ugrep
ตรวจสอบhttps://packages.debian.org/ugrepสำหรับข้อมูลเวอร์ชัน หากต้องการสร้างและลองใช้ ugrep ในเครื่อง โปรดดูขั้นตอนการสร้าง "ทุกแพลตฟอร์ม" เพิ่มเติมด้านล่าง
$ dnf install ugrep
ตรวจสอบhttps://packages.fedoraproject.org/pkgs/ugrep/ugrep/ สำหรับข้อมูลเวอร์ชัน
$ pkg install ugrep
ตรวจสอบhttps://www.freshports.org/textproc/ugrepสำหรับข้อมูลเวอร์ชัน
$ pkgman install cmd:ugrep
ตรวจสอบhttps://github.com/haikuports/haikuports/tree/master/app-text/ugrepสำหรับข้อมูลเวอร์ชัน หากต้องการสร้างและลองใช้ ugrep ในเครื่อง โปรดดูขั้นตอนการสร้าง "ทุกแพลตฟอร์ม" เพิ่มเติมด้านล่าง
คุณสามารถใช้ตัวติดตั้งแพ็คเกจ NetBSD มาตรฐาน (pkgsrc): http://cdn.netbsd.org/pub/pkgsrc/current/pkgsrc/textproc/ugrep/README.html
$ pkg_add ugrep
ตรวจสอบhttps://openports.pl/path/sysutils/ugrepสำหรับข้อมูลเวอร์ชัน
$ zypper install ugrep
ตรวจสอบhttps://build.opensuse.org/package/show/utilities/ugrepสำหรับข้อมูลเวอร์ชัน
ขั้นแรกให้เปิดใช้งานที่เก็บ EPEL จากนั้นจึงติดตั้ง ugrep ได้
$ dnf install ugrep
ตรวจสอบhttps://packages.fedoraproject.org/pkgs/ugrep/ugrep/ สำหรับข้อมูลเวอร์ชัน
โคลน ugrep ด้วย
$ git clone https://github.com/Genivia/ugrep
หรือไปที่ https://github.com/Genivia/ugrep/releases เพื่อดาวน์โหลดรุ่นเฉพาะ
คุณสามารถเพิ่มสิ่งเหล่านี้ได้ในภายหลังเมื่อคุณต้องการคุณสมบัติเหล่านี้:
ตัวเลือก -P (นิพจน์ทั่วไป Perl) ต้องใช้ไลบรารี PCRE2 (แนะนำ) หรือไลบรารี Boost.Regex (ทางเลือกสำรอง) หากไม่ได้ติดตั้ง PCRE2 ให้ติดตั้ง PCRE2 ด้วยเช่น sudo apt-get install -y libpcre2-dev หรือดาวน์โหลด PCRE2 แล้วทำตามคำแนะนำในการติดตั้ง หรือดาวน์โหลด Boost.Regex และเรียกใช้ ./bootstrap.sh และ sudo ./b2 --with-regex install ดูบูสต์: การเริ่มต้นใช้งาน
ตัวเลือก -z (การค้นหาไฟล์บีบอัดและไฟล์เก็บถาวร) จำเป็นต้องติดตั้งไลบรารี zlib มีการติดตั้งบนระบบส่วนใหญ่ ถ้าไม่เช่นนั้น ให้ทำการติดตั้ง เช่น sudo apt-get install -y libz-dev หากต้องการค้นหาไฟล์ .bz และ .bz2 ให้ติดตั้งไลบรารี bzip2 (แนะนำ) เช่น sudo apt-get install -y libbz2-dev หากต้องการค้นหาไฟล์ .lzma และ .xz ให้ติดตั้งไลบรารี lzma (แนะนำ) เช่น sudo apt-get install -y liblzma-dev หากต้องการค้นหาไฟล์ .lz4 ให้ติดตั้งไลบรารี lz4 (ไม่จำเป็น ไม่จำเป็น) เช่น sudo apt-get install -y liblz4-dev หากต้องการค้นหาไฟล์ .zst ให้ติดตั้งไลบรารี zstd (ไม่จำเป็น ไม่จำเป็น) เช่น sudo apt-get install -y libzstd-dev หากต้องการค้นหาไฟล์ .br ให้ติดตั้งไลบรารี brotli (ไม่จำเป็น ไม่จำเป็น) เช่น sudo apt-get install -y libbrotli-dev หากต้องการค้นหาไฟล์ .bz3 ให้ติดตั้งไลบรารี bzip3 (ไม่จำเป็น ไม่จำเป็น) เช่น sudo apt-get install -y bzip3
เคล็ดลับ
แม้ว่าระบบของคุณจะมียูทิลิตีบรรทัดคำสั่ง เช่น bzip2 แต่นั่นไม่ได้หมายความว่ามีการติดตั้งไลบรารีการพัฒนา เช่น libbz2 เสมอไป ควรติดตั้ง ไลบรารีการพัฒนา
ระบบ Linux บางระบบอาจไม่ได้รับการกำหนดค่าให้โหลดไลบรารีแบบไดนามิกจาก /usr/local/lib ทำให้เกิดข้อผิดพลาดในการโหลดไลบรารีเมื่อเรียกใช้ ugrep เพื่อแก้ไขปัญหานี้ ให้เพิ่ม export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/usr/local/lib" ลงในไฟล์ ~/.bashrc ของคุณ หรือเรียกใช้ sudo ldconfig /usr/local/lib
ดำเนินการสคริปต์ ./build.sh เพื่อสร้าง ugrep :
$ cd ugrep
$ ./build.sh
สิ่งนี้จะสร้างไฟล์ปฏิบัติการ ugrep ในไดเร็กทอรี ugrep/src ด้วย ./configure และ make -j ตรวจสอบด้วย make test เมื่อการทดสอบทั้งหมดผ่านไป ไฟล์ปฏิบัติการ ugrep จะถูกคัดลอกไปยัง ugrep/bin/ugrep และ symlink ugrep/bin/ug -> ugrep/bin/ugrep จะถูกเพิ่มสำหรับคำสั่ง ug
โปรดทราบว่า ug นั้นเหมือนกับ ugrep แต่ยังโหลดไฟล์การกำหนดค่า .ugrep เมื่อมีอยู่ในไดเร็กทอรีทำงานหรือโฮมไดเร็กทอรี ซึ่งหมายความว่าคุณสามารถกำหนดตัวเลือกเริ่มต้นสำหรับ ug ใน .ugrep ได้
เส้นทางอื่นไปยังไลบรารีที่ติดตั้งหรือในเครื่องอาจระบุด้วย . ./build.sh หากต้องการความช่วยเหลือเกี่ยวกับตัวเลือกบิวด์ที่มีให้:
$ ./build.sh --help
คุณสามารถสร้างไฟล์เรียกทำงานแบบคงที่ได้โดยการระบุ:
$ ./build.sh --enable-static
สิ่งนี้อาจล้มเหลวหากไลบรารีไม่ลิงก์แบบคงที่ เช่น brotli ในกรณีนั้นลอง ./build.sh --enable-static --without-brotli
คุณสามารถสร้าง ugrep โดยเปิดใช้งานค่าเริ่มต้นที่กำหนดเองได้ เช่น เพจเจอร์:
$ ./build.sh --enable-pager
ตัวเลือกในการเลือกค่าเริ่มต้นสำหรับบิวด์ได้แก่:
--help แสดงตัวเลือกการสร้าง--enable-static build static executables ถ้าเป็นไปได้--enable-hidden ค้นหาไฟล์และไดเร็กทอรีที่ซ่อนอยู่เสมอ--enable-pager ใช้เพจเจอร์เสมอเพื่อแสดงเอาต์พุตบนเทอร์มินัล--enable-pretty colorize เอาท์พุทไปยังเทอร์มินัลและเพิ่มส่วนหัวของชื่อไฟล์--disable-auto-color ปิดใช้งานสีอัตโนมัติ ต้องใช้ตัวเลือก ugrep --color=auto เพื่อแสดงสี--disable-mmap ปิดการใช้งานไฟล์ที่แมปหน่วยความจำ--disable-sse2 ปิดใช้งานการเพิ่มประสิทธิภาพ SSE2 และ AVX--disable-avx2 ปิดใช้งานการเพิ่มประสิทธิภาพ AVX2 และ AVX512BW แต่คอมไพล์ด้วย SSE2 เมื่อได้รับการสนับสนุน--disable-neon ปิดการใช้งานการเพิ่มประสิทธิภาพ ARM NEON/AArch64--with-grep-path เป็นค่าเริ่มต้น -f path หากไม่ได้กำหนด GREP_PATH--with-grep-colors เป็นสีเริ่มต้นหากไม่ได้กำหนด GREP_COLORS หลังจากบิลด์เสร็จสมบูรณ์ ให้คัดลอก ugrep/bin/ugrep และ ugrep/bin/ug ไปยังตำแหน่งที่สะดวก เช่น ในไดเร็กทอรี ~/bin ของคุณ หรือหากคุณต้องการติดตั้งคำสั่ง ugrep และ ug และ man page:
$ sudo make install
นอกจากนี้ยังติดตั้งไฟล์รูปแบบด้วยรูปแบบที่กำหนดไว้ล่วงหน้าสำหรับตัวเลือก -f ที่ /usr/local/share/ugrep/patterns/ ตัวเลือก -f จะตรวจสอบไดเร็กทอรีการทำงานว่ามีไฟล์รูปแบบอยู่หรือไม่ หากไม่พบ ให้ตรวจสอบตัวแปรสภาพแวดล้อม GREP_PATH เพื่อโหลดไฟล์รูปแบบ และหากไม่พบ ให้อ่านไฟล์รูปแบบที่กำหนดไว้ล่วงหน้าที่ติดตั้งไว้
น่าเสียดายที่ git clone ไม่ได้เก็บการประทับเวลาไว้ ซึ่งหมายความว่าคุณอาจพบ "คำเตือน: 'alocal-1.15' หายไปในระบบของคุณ" หรือไม่พบ autoheader เมื่อรัน make
เมื่อต้องการแก้ไขปัญหานี้ ให้เรียกใช้:
$ autoreconf -fi
$ ./build.sh
GCC 8 และสูงกว่าอาจสร้างคำเตือนของการเรียงลำดับ "หมายเหตุ: การส่งพารามิเตอร์สำหรับอาร์กิวเมนต์ ... เปลี่ยนใน GCC 7.1" คำเตือนเหล่านี้ควรถูกละเว้น
รวม Dockerfile เพื่อสร้าง ugrep ในคอนเทนเนอร์ Ubuntu
นักพัฒนาอาจต้องการใช้สารฆ่าเชื้อเพื่อตรวจสอบรหัส ugrep เมื่อทำการเปลี่ยนแปลงที่สำคัญ เช่น เพื่อตรวจจับการแข่งขันของข้อมูลด้วย ThreadSanitizer:
$ ./build.sh CXXFLAGS='-fsanitize=thread -O1 -g'
เราตรวจสอบ ugrep ด้วย AddressSanitizer, MemorySanitizer, ThreadSanitizer และ UndefiorSanitizer ดังกราว ตัวเลือกเหล่านี้มีค่าใช้จ่ายรันไทม์จำนวนมาก และไม่ควรใช้สำหรับบิวด์ขั้นสุดท้าย
- กลับไปที่สารบัญ
โปรดทราบว่าคำสั่ง ugrep และ ug จะค้นหาไฟล์ไบนารี่ตามค่าเริ่มต้น และจะไม่ละเว้นไฟล์ที่ระบุ .gitignore ซึ่งจะไม่ทำให้การเปรียบเทียบประสิทธิภาพการค้นหาแบบเรียกซ้ำมีความหมาย เว้นแต่จะใช้ตัวเลือก -I และ --ignore-files หากต้องการให้ตัวเลือกเหล่านี้เป็นค่าเริ่มต้นสำหรับ ug เพียงเพิ่มไฟล์ ignore-binary และ ignore-files ลงในไฟล์การกำหนดค่า .ugrep ของคุณ
สำหรับการเปรียบเทียบประสิทธิภาพที่ทันสมัยของ ugrep ล่าสุด โปรดดูเกณฑ์มาตรฐานประสิทธิภาพของ ugrep Ugrep เร็วกว่า GNU grep, Silver Searcher, ack, sift ความเร็วของ Ugrep เหนือกว่า ripgrep ในการวัดประสิทธิภาพส่วนใหญ่
ก่อนอื่น เรามากำหนดคำสั่ง :grep ใน Vim เพื่อค้นหาไฟล์แบบวนซ้ำกัน โดยเพิ่มบรรทัดต่อไปนี้ใน .vimrc ของคุณที่อยู่ในไดเร็กทอรีราก:
if executable('ugrep')
set grepprg=ugrep -RInk -j -u --tabs=1 --ignore-files
set grepformat=%f:%l:%c:%m,%f+%l+%c+%m,%-G%f\|%l\|%c\|%m
endif
สิ่งนี้ระบุการค้นหาที่ไม่คำนึงถึงขนาดตัวพิมพ์ -j ด้วยคำสั่ง Vim :grep สำหรับการค้นหาแบบคำนึงถึงขนาดตัวพิมพ์ ให้ลบ -j ออกจาก grepprg รายการที่ตรงกันหลายรายการในบรรทัดเดียวกันจะแสดงรายการในหน้าต่างแก้ไขด่วนแยกกัน หากไม่ต้องการ ให้ลบ -u ออกจาก grepprg ด้วยการเปลี่ยนแปลงนี้ ระบบจะแสดงเฉพาะรายการที่ตรงกันรายการแรกเท่านั้น ตัวเลือก --ignore-files ข้ามไฟล์ที่ระบุในไฟล์ .gitignore หากมี หากต้องการจำกัดความลึกของการค้นหาแบบเรียกซ้ำเฉพาะในไดเร็กทอรีปัจจุบันเท่านั้น ให้ผนวก -1 ต่อท้าย grepprg
ตอนนี้คุณสามารถเรียกใช้คำสั่ง Vim :grep ใน Vim เพื่อค้นหาไฟล์บน PATH ที่ระบุสำหรับการจับคู่ PATTERN :
:grep PATTERN [PATH]
หากคุณละเว้น PATH ไดเร็กทอรีการทำงานจะถูกค้นหา ใช้ % เป็น PATH เพื่อค้นหาเฉพาะไฟล์ที่เปิดอยู่ในปัจจุบันใน Vim:
:grep PATTERN %
คำสั่ง :grep จะแสดงผลลัพธ์ในหน้าต่าง Quickfix ที่ช่วยให้คุณสามารถข้ามไปยังรายการที่ตรงกันได้อย่างรวดเร็ว
หากต้องการเปิดหน้าต่าง Quickfix พร้อมรายการการแข่งขันล่าสุด:
:copen
ดับเบิลคลิกที่บรรทัดในหน้าต่างนี้ (หรือเลือกบรรทัดแล้วกด ENTER) เพื่อข้ามไปยังไฟล์และตำแหน่งในไฟล์ที่ตรงกัน ป้อนคำสั่ง :cn และ :cp เพื่อข้ามไปยังนัดถัดไปหรือก่อนหน้า ตามลำดับ หากต้องการอัปเดตผลการค้นหาในหน้าต่าง Quickfix เพียง grep พวกเขา ตัวอย่างเช่น หากต้องการค้นหาซอร์สโค้ด C++ ที่ทำเครื่องหมายว่า FIXME แบบวนซ้ำในไดเร็กทอรีการทำงาน:
:grep -tc++ FIXME
หากต้องการปิดหน้าต่างการแก้ไขด่วน:
:cclose
คุณสามารถใช้ตัวเลือก ugrep กับคำสั่ง :grep ได้ เช่น เพื่อเลือกความคิดเห็นบรรทัดเดียวและหลายบรรทัดในไฟล์ปัจจุบัน:
:grep -f c++/comments %
เฉพาะบรรทัดแรกของความคิดเห็นหลายบรรทัดเท่านั้นที่จะแสดงใน Quickfix เพื่อประหยัดพื้นที่ หากต้องการแสดงทุกบรรทัดของการจับคู่แบบหลายบรรทัด ให้ลบ %-G ออกจาก grepformat
เครื่องมือ Vim ยอดนิยมคือ ctrlp.vim ซึ่งติดตั้งด้วย:
$ cd ~/.vim
$ git clone https://github.com/kien/ctrlp.vim.git bundle/ctrlp.vim
CtrlP ใช้ ugrep โดยเพิ่มบรรทัดต่อไปนี้ใน .vimrc :
if executable('ugrep')
set runtimepath^=~/.vim/bundle/ctrlp.vim
let g:ctrlp_match_window='bottom,order:ttb'
let g:ctrlp_user_command='ugrep "" %s -Rl -I --ignore-files -3'
endif
โดยที่ -I ข้ามไฟล์ไบนารี ตัวเลือก --ignore-files ข้ามไฟล์ที่ระบุในไฟล์ .gitignore หากมีอยู่ และตัวเลือก -3 จำกัดการค้นหาไดเร็กทอรีไว้ที่สามระดับ (ไดเร็กทอรีการทำงานและสูงสุดสองระดับด้านล่าง)
เริ่ม Vim จากนั้นป้อนคำสั่ง:
:helptags ~/.vim/bundle/ctrlp.vim/doc
หากต้องการดูเอกสาร CtrlP ใน Vim ให้ป้อนคำสั่ง:
:help ctrlp.txt
- กลับไปที่สารบัญ
ขอบคุณ Manuel Uberti ตอนนี้คุณสามารถใช้ ugrep ใน Emacs ได้แล้ว หากต้องการใช้ ugrep แทน GNU grep ภายใน Emacs ให้เพิ่มบรรทัดต่อไปนี้ในไฟล์ .emacs.d/init.el ของคุณ:
(setq-default xref-search-program ‘ugrep)
ซึ่งหมายความว่าคำสั่ง Emacs เช่น project-find-regexp ที่ใช้ Xref สามารถใช้ประโยชน์จากพลังของ ugrep ได้แล้ว
นอกจากนี้ คุณสามารถใช้ grep ในคำสั่ง grep ของ Emacs ได้ ตัวอย่างเช่น คุณสามารถรัน lgrep ด้วย ugrep ได้โดยปรับแต่ง grep-template ดังต่อไปนี้:
(setq-default grep-template "ugrep --color=always -0Iinr -e <R>")
หากคุณไม่มี Emacs เวอร์ชัน 29 (หรือสูงกว่า) คุณสามารถดาวน์โหลดและสร้าง Emacs ได้จากสาขาหลักของ Emacs หรือเปิดใช้งานการรวม Xref กับ ugrep ด้วยตนเอง:
(with-eval-after-load 'xref
(push '(ugrep . "xargs -0 ugrep <C> --null -ns -e <R>")
xref-search-program-alist)
(setq-default xref-search-program 'ugrep))
- กลับไปที่สารบัญ
ugrep ที่พร้อมใช้งานทันทีรองรับตัวเลือกบรรทัดคำสั่ง grep GNU/BSD มาตรฐานทั้งหมดและปรับปรุงหลายตัวเลือกด้วย สำหรับรายละเอียด โปรดดูการปรับปรุงที่โดดเด่นเหนือ grep
หากคุณต้องการยึดติดกับรูปแบบ Unicode ที่ไม่ใช่ UTF grep ASCII/LATIN1 ของ GNU/BSD ให้ใช้ตัวเลือก -U เพื่อปิดใช้งานการจับคู่รูปแบบ Unicode แบบเต็ม
ในความเป็นจริงการดำเนินการ ugrep ด้วยตัวเลือก -U , -Y , -. และ --sort ทำให้มันทำงานเหมือนกับ egrep โดยจับคู่เฉพาะรูปแบบ ASCII/LATIN1 ที่ไม่ใช่ UTF Unicode เท่านั้น โดยอนุญาตให้มีรูปแบบว่างเพื่อจับคู่และค้นหาไฟล์ที่ซ่อนไว้ แทนที่จะเพิกเฉยตามลำดับ ดูความเท่าเทียมกันของ grep
คุณสามารถสร้างนามแฝง grep ที่สะดวกโดยมีหรือไม่มีตัวเลือก -U , -Y , -. และ --sort หรือรวมตัวเลือกอื่นๆ ตามต้องการ
หรือคุณสามารถสร้างไฟล์ปฏิบัติการ grep , egrep และ fgrep ได้โดยการคัดลอก ugrep ไปยังชื่อเหล่านั้น เมื่อไฟล์ปฏิบัติการ ugrep (หรือ ugrep.exe ) ถูกคัดลอกเป็น grep ( grep.exe ), egrep ( egrep.exe ), fgrep ( fgrep.exe ) จากนั้นตัวเลือก -U , -Y และ -. จะเปิดใช้งานโดยอัตโนมัติพร้อมกับ -G สำหรับ grep , -E สำหรับ egrep และ -F สำหรับ fgrep นอกจากนี้ เมื่อคัดลอกเป็น zgrep , zegrep และ zfgrep ตัวเลือก -z จะถูกเปิดใช้งาน ตัวอย่างเช่น เมื่อคัดลอก ugrep เป็น zegrep ตัวเลือก -z , -E , -Y , -. และ --sort เปิดใช้งานอยู่
ในทำนองเดียวกัน symlink และฮาร์ดลิงก์ไปยัง ugrep ก็ทำงานได้ดีเช่นกันเพื่อสร้างการแทนที่ grep , egrep และ fgrep ตัวอย่างเช่น หากต้องการสร้าง symlink egrep :
sudo ln -s `which ugrep` /opt/local/bin/egrep
/opt/local/bin เป็นเพียงตัวอย่างและอาจอยู่ใน $path ของคุณหรือไม่ก็ได้ และอาจพบหรือไม่พบเมื่อรัน egrep ทั้งนี้ขึ้นอยู่กับ $path ของคุณ
ugrep เทียบเท่ากับ GNU/BSD grep เมื่อใช้ตัวเลือกต่อไปนี้:
grep = ugrep -G -U -Y -. --sort -Dread -dread
egrep = ugrep -E -U -Y -. --sort -Dread -dread
fgrep = ugrep -F -U -Y -. --sort -Dread -dread
zgrep = ugrep -z -G -U -Y -. --sort -Dread -dread
zegrep = ugrep -z -E -U -Y -. --sort -Dread -dread
zfgrep = ugrep -z -F -U -Y -. --sort -Dread -dread
ที่ไหน:
-U ปิดใช้งานการจับคู่รูปแบบอักขระแบบกว้างของ Unicode ดังนั้น ตัวอย่างเช่น รูปแบบ xa3 จะจับคู่ไบต์ A3 แทนที่จะเป็นจุดโค้ด Unicode U+00A3 ที่แสดงด้วยลำดับ UTF-8 C2 A3 โดยค่าเริ่มต้นใน ugrep xa3 จะตรงกับ U+00A3 เราไม่แนะนำให้ใช้ -U สำหรับการค้นหารูปแบบข้อความ เฉพาะสำหรับการค้นหาแบบไบนารี่หรือเพื่อค้นหาไฟล์ latin-1 (iso-8859-1) โดยไม่รายงานว่าไฟล์เหล่านี้เป็นไบนารี่ (ตั้งแต่ ugrep v3.5.0)-Y เปิดใช้งานการจับคู่ที่ว่างเปล่า ตัวอย่างเช่น รูปแบบ a* จะจับคู่ทุกบรรทัดแทนที่จะเป็นลำดับของ a s ตามค่าเริ่มต้นใน ugrep รูปแบบ a* จะจับคู่ลำดับของ a s ยิ่งไปกว่านั้น ใน ugrep รูปแบบ a*b*c* จะตรงกับสิ่งที่ควรจะจับคู่ตามค่าเริ่มต้น ดูการปรับปรุง-. ค้นหาไฟล์ที่ซ่อนอยู่ (dotfiles) ตามค่าเริ่มต้น ไฟล์ที่ซ่อนจะถูกละเว้น เช่นเดียวกับยูทิลิตี้ Unix ส่วนใหญ่--sort ระบุเอาต์พุตที่เรียงลำดับตามชื่อพาธ โดยแสดงไฟล์ที่ตรงกันที่เรียงลำดับก่อนแล้วตามด้วยการจับคู่แบบเรียกซ้ำที่เรียงลำดับในไดเรกทอรีย่อย มิฉะนั้น ไฟล์ที่ตรงกันจะถูกรายงานโดยไม่มีลำดับใดเป็นพิเศษเพื่อปรับปรุงประสิทธิภาพ-Dread และ -dread เป็นค่าเริ่มต้น grep ของ GNU/BSD แต่ไม่แนะนำ โปรดดูคำอธิบายที่การปรับปรุง- กลับไปที่สารบัญ
นามแฝงที่ใช้กันทั่วไปเพื่อเพิ่มใน .bashrc เพื่อเพิ่มประสิทธิภาพการทำงาน:
alias uq = 'ug -Q' # interactive TUI search (uses .ugrep config)
alias uz = 'ug -z' # compressed files and archives search (uses .ugrep config)
alias ux = 'ug -U --hexdump' # binary pattern search (uses .ugrep config)
alias ugit = 'ug -R --ignore-files' # works like git-grep & define your preferences in .ugrep config
alias grep = 'ug -G' # search with basic regular expressions (BRE) like grep
alias egrep = 'ug -E' # search with extended regular expressions (ERE) like egrep
alias fgrep = 'ug -F' # find string(s) like fgrep
alias zgrep = 'ug -zG' # search compressed files and archives with BRE
alias zegrep = 'ug -zE' # search compressed files and archives with ERE
alias zfgrep = 'ug -zF' # find string(s) in compressed files and/or archives
alias xdump = 'ugrep -X ""' # hexdump files without searching (don't use .ugrep config)
alias zmore = 'ugrep+ -z -I -+ --pager ""' # view compressed, archived and regular files (don't use .ugrep config)
- กลับไปที่สารบัญ
-Qn-U )--bool )--ignore-files-Z ด้วยตัวเลือก-z-z-z และ --zmax=NUM สำหรับความลึกสูงสุด NUM ระดับ--filter โดยใช้ยูทิลิตี้การแปลงรูปแบบของบุคคลที่สามเป็นปลั๊กอิน-r เพื่อค้นหาไดเรกทอรีแบบวนซ้ำ-. )-E เป็น egrep ในขณะที่ -G เปิดใช้งาน BRE)-J1 )-W (เอาต์พุตการจับคู่ไบนารี่ในรูปแบบ hex พร้อมข้อความจับคู่เอาต์พุตตามปกติ) และ -X (เอาต์พุตการจับคู่ทั้งหมดในรูปแบบฐานสิบหก)--format )-f ใช้ตัวแปรสภาพแวดล้อม GREP_PATH หรือรูปแบบที่กำหนดไว้ล่วงหน้าที่ติดตั้งใน /usr/local/share/ugrep/patterns หากระบุ -f และระบุรูป -e ตั้งแต่หนึ่งรูปแบบขึ้นไปด้วย ดังนั้นอ็อพชัน -F , -x และ -w จะไม่ใช้กับรูปแบบ -f เพื่อหลีกเลี่ยงความสับสนเมื่อใช้ -f กับรูปแบบที่กำหนดไว้ล่วงหน้าซึ่งอาจทำงานไม่ถูกต้องกับตัวเลือกเหล่านี้อีกต่อไป-O , -M และ -t ระบุนามสกุลไฟล์ รูปแบบไบต์เมจิกลายเซ็นไฟล์ และประเภทไฟล์ที่กำหนดไว้ล่วงหน้า ตามลำดับ ซึ่งช่วยให้สามารถค้นหาไฟล์บางประเภทในแผนผังไดเร็กทอรี เช่น ด้วยตัวเลือกการค้นหาแบบเรียกซ้ำ -R และ -r ตัวเลือก -O , -M และ -t ยังใช้กับไฟล์ที่เก็บถาวรในไฟล์ cpio, jar, pax, tar, zip และ 7z-k , --column-number เพื่อแสดงหมายเลขคอลัมน์ โดยคำนึงถึงระยะห่างของแท็บด้วยการขยายแท็บ ตามที่ระบุโดยตัวเลือก --tabs-P (นิพจน์ทั่วไป Perl) รองรับการอ้างอิงย้อนกลับ (ด้วย --format ) และ lookbehinds ซึ่งใช้ไลบรารี PCRE2 หรือ Boost.Regex สำหรับการจับคู่ Perl regex ที่รวดเร็วด้วยไวยากรณ์ที่เหมือน PCRE-b พร้อมด้วย option -o หรือด้วย option -u ugrep จะแสดงออฟเซ็ตไบต์ที่แน่นอนของการจับคู่รูปแบบแทนที่จะเป็นไบต์ออฟเซ็ตของจุดเริ่มต้นของบรรทัดที่ตรงกันที่รายงานโดย GNU/BSD grep-u , --ungroup เพื่อไม่ให้จัดกลุ่มการแข่งขันหลายรายการต่อบรรทัด ตัวเลือกนี้จะแสดงบรรทัดอินพุตที่ตรงกันอีกครั้งสำหรับการจับคู่รูปแบบเพิ่มเติมแต่ละรายการในบรรทัด ตัวเลือกนี้มีประโยชน์อย่างยิ่งกับตัวเลือก -c เพื่อรายงานจำนวนรวมของรูปแบบที่ตรงกันต่อไฟล์ แทนที่จะเป็นจำนวนบรรทัดที่ตรงกันต่อไฟล์-Y เปิดใช้งานการจับคู่รูปแบบว่าง การทำ Grepping ด้วยรูปแบบการจับคู่ที่ว่างเปล่านั้นแปลกและให้ผลลัพธ์ที่แตกต่างกันกับ GNU grep กับ BSD grep การจับคู่ที่ว่างเปล่าจะไม่ส่งออกตาม ugrep ตามค่าเริ่มต้น ซึ่งจะช่วยหลีกเลี่ยงข้อผิดพลาดที่อาจทำให้เกิดผลลัพธ์ "สุ่ม" ตัวอย่างเช่น ด้วย GNU/BSD grep รูปแบบ a* จะจับคู่ทุกบรรทัดในอินพุต และจริงๆ แล้วจับคู่ xyz สามครั้ง (ช่วงการเปลี่ยนภาพว่างก่อนและระหว่าง x , y และ z ) การอนุญาตให้มีการจับคู่ที่ว่างเปล่าต้องใช้ตัวเลือก ugrep -Y รูปแบบที่ขึ้นต้นด้วย ^ หรือลงท้ายด้วย $ เช่น ^h*$ จะจับคู่ค่าว่าง รูปแบบเหล่านี้จะเปิดใช้งานตัวเลือก -Y โดยอัตโนมัติ-D, --devices=ACTION ถูก skip ตามค่าเริ่มต้นแทนที่จะ read วิธีนี้จะป้องกันการค้างบนไปป์ที่มีชื่อในไดเร็กทอรีที่ถูกค้นหาแบบวนซ้ำโดยไม่คาดคิด ดังที่อาจเกิดขึ้นกับ GNU/BSD grep ที่ read อุปกรณ์ตามค่าเริ่มต้น-d, --directories=ACTION ถูก skip โดยค่าเริ่มต้น แทนที่จะ read ตามค่าเริ่มต้น ไดเร็กทอรีที่ระบุบนบรรทัดคำสั่งจะถูกค้นหา แต่จะไม่ได้เจาะลึกเข้าไปในไดเร็กทอรีย่อยแบบเรียกซ้ำ-N PATTERN ซึ่งเป็นรูปแบบของแบบฟอร์ม (?^X) ที่ข้ามอินพุต X ทั้งหมด ดังนั้นจะลบ X ออกจากการค้นหา ตัวอย่างเช่น รูปแบบเชิงลบสามารถใช้เพื่อข้ามสตริงและความคิดเห็นเมื่อค้นหาตัวระบุในซอร์สโค้ด และค้นหารายการที่ตรงกันซึ่งไม่ได้อยู่ในสตริงและความคิดเห็น รูปแบบ zap ที่กำหนดไว้ล่วงหน้าใช้รูปแบบเชิงลบ เช่น ใช้ -f cpp/zap_comments เพื่อละเว้นการจับคู่รูปแบบในความคิดเห็น C++GREP_OPTIONS เนื่องจากพฤติกรรมของ ugrep จะต้องพกพาได้และสามารถคาดเดาได้ในทุกระบบ GNU grep ละทิ้ง GREP_OPTIONS ด้วยเหตุผลนี้ โปรดใช้คำสั่ง ug ที่โหลดไฟล์การกำหนดค่า .ugrep ที่อยู่ในไดเร็กทอรีการทำงานหรือในโฮมไดเร็กทอรีเมื่อมีอยู่ หรือใช้นามแฝงของเชลล์เพื่อสร้างคำสั่งใหม่พร้อมตัวเลือกการค้นหาเฉพาะ- กลับไปที่สารบัญ
หากต้องการดำเนินการค้นหาโดยใช้ไฟล์กำหนดค่า .ugrep ที่อยู่ในไดเร็กทอรีทำงานหรือโฮมไดเร็กตอรี่ (โปรดทราบว่า ug เหมือนกับ ugrep --config ):
ug PATTERN FILE...
หากต้องการบันทึกไฟล์การกำหนดค่า .ugrep ลงในไดเร็กทอรีการทำงาน ให้แก้ไขไฟล์นี้ในไดเร็กทอรีหลักของคุณเพื่อปรับแต่งค่ากำหนดสำหรับค่าเริ่มต้นของ ug :
ug --save-config
หากต้องการค้นหาไดเร็กทอรีการทำงานและเจาะลึก main ซ้ำ ๆ (โปรดทราบว่า -r recurse symlinks ถูกเปิดใช้งานตามค่าเริ่มต้นหากไม่มีการระบุอาร์กิวเมนต์ของไฟล์):
ug main
เหมือนกัน แต่ค้นหาเฉพาะไฟล์ซอร์สโค้ด C ++ ซ้ำ ๆ โดยไม่สนใจไฟล์อื่น ๆ ทั้งหมด:
ug -tc++ main
เช่นเดียวกัน การใช้ TUI คิวรีแบบโต้ตอบ เริ่มต้นด้วยรูปแบบการค้นหาเริ่มต้น main (โปรดทราบว่า -Q ที่มีรูปแบบเริ่มต้นต้องใช้ตัวเลือก -e เนื่องจากโดยปกติแล้วรูปแบบจะถูกระบุแบบโต้ตอบและอาร์กิวเมนต์บรรทัดคำสั่งทั้งหมดถือเป็นไฟล์/ไดเร็กทอรี):
ug -Q -tc++ -e main
หากต้องการค้นหา #define (และ # define ฯลฯ ) โดยใช้รูปแบบ regex ในไฟล์ C++ (โปรดทราบว่าควรอ้างอิงรูปแบบเพื่อป้องกันการใช้เชลล์ * และ ? ):
ug -tc++ '#[t ]*define'
หากต้องการค้นหา main เป็นคำ ( -w ) ซ้ำ ๆ โดยไม่ต้องติดตาม symlink ( -r ) ในไดเร็กทอรี myproject โดยแสดงหมายเลขบรรทัดที่ตรงกัน ( -n ) และคอลัมน์ ( -k ) ถัดจากบรรทัดที่ตรงกัน:
ug -r -nkw main myproject
เหมือนกัน แต่ค้นหาเฉพาะ myproject โดยไม่ต้องเรียกซ้ำอีกครั้ง (โปรดทราบว่าอาร์กิวเมนต์ของไดเรกทอรีจะถูกค้นหาในระดับหนึ่งตามค่าเริ่มต้น):
ug -nkw main myproject
เหมือนกัน แต่ค้นหา myproject และหนึ่งระดับไดเรกทอรีย่อยที่ลึกลงไป (สองระดับ) ด้วย -2 :
ug -2 -nkw main myproject
เหมือนกัน แต่ค้นหาเฉพาะไฟล์ C++ ใน myproject และไดเรกทอรีย่อยด้วย -tc++ :
ug -tc++ -2 -nkw main myproject
เหมือนกัน แต่ยังค้นหาภายในไฟล์เก็บถาวร (เช่นไฟล์ zip และ tar) และไฟล์บีบอัดด้วย -z :
ug -z -tc++ -2 -nkw main myproject
ค้นหาไดเร็กทอรีการทำงานซ้ำ ๆ สำหรับ main ในขณะที่ละเว้นไฟล์ gitignored (เช่นสมมติว่า .gitignore อยู่ในไดเร็กทอรีทำงานหรือต่ำกว่า):
ug --ignore-files -tc++ -nkw main
หากต้องการแสดงรายการไฟล์ทั้งหมดในไดเร็กทอรีการทำงานและส่วนลึกที่ไม่ถูกละเลยโดยไฟล์ . .gitignore :
ug --ignore-files -l ''
หากต้องการแสดงรายการนามสกุลไฟล์และ "magic bytes" (shebangs) ที่ถูกค้นหาโดยสอดคล้องกับอาร์กิวเมนต์ -t :
ug -tlist
หากต้องการแสดงรายการไฟล์เชลล์ทั้งหมดแบบวนซ้ำตามนามสกุลและ shebangs ด้วย -l (โปรดทราบว่า '' ตรงกับไฟล์ที่ไม่ว่างเปล่า):
ug -l -tShell ''
- กลับไปที่สารบัญ
หากต้องการค้นหา main ในซอร์สโค้ดโดยไม่สนใจสตริงและบล็อกความคิดเห็น คุณสามารถใช้ รูปแบบเชิงลบ พร้อมตัวเลือก -N เพื่อข้ามการจับคู่ที่ไม่ต้องการในสตริงที่ยกมาและบล็อกความคิดเห็นของ C/C++:
ug -r -nkw -e 'main' -N '"(\.|\r?n|[^\n"])*"|//.*|/*(.*n)*?.**+/' myproject
งานนี้มีเยอะมากต้องพิมพ์ให้ถูกต้อง! หากคุณเป็นเหมือนฉัน ฉันไม่ต้องการใช้เวลาเล่นซอกับรูปแบบ regex เมื่อฉันกำลังทำงานบางอย่างที่สำคัญกว่า มีวิธีที่ง่ายขึ้นโดยใช้รูปแบบที่กำหนดไว้ล่วงหน้าของ UGREP ( -f ) ที่ติดตั้งด้วยเครื่องมือ ugrep :
ug -r -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
แบบสอบถามนี้ยังค้นหาผ่านไฟล์อื่น ๆ นอกเหนือจากซอร์สโค้ด c/c ++ เช่น readmes, makefiles และอื่น ๆ นอกจากนี้เรายังข้าม symlinks ด้วย -r ดังนั้นลองปรับแต่งคิวรีนี้โดยเลือกไฟล์ C/C ++ โดยใช้ตัวเลือก -tc,c++ และรวม Symlinks ไปยังไฟล์และไดเรกทอรีด้วย -R :
ug -R -tc,c++ -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
ถ้าคุณต้องการมองหาตัวระบุ main แต่ไม่ใช่ฟังก์ชั่น main( ในกรณีนี้ให้ใช้รูปแบบเชิงลบสำหรับสิ่งนี้เพื่อข้าม mainh*( การจับคู่รูปแบบ:
ug -R -tc,c++ -nkw -e 'main' -N 'mainh*(' -f c/zap_strings -f c/zap_comments myproject
สิ่งนี้ใช้ตัวเลือก -e และ -N เพื่อระบุรูปแบบและรูปแบบเชิงลบอย่างชัดเจนตามลำดับซึ่งเป็นหลักการสร้างรูปแบบ main|(?^mainh*() โดยที่ h ตรงกับพื้นที่และแท็บโดยทั่วไป รูปแบบเชิงลบมีประโยชน์ในการกรองการจับคู่รูปแบบที่เราไม่สนใจ
เป็นอีกตัวอย่างหนึ่งสมมติว่าเราอาจต้องการค้นหาคำว่า FIXME ในบล็อกความคิดเห็น C/C ++ ในการทำเช่นนั้นก่อนอื่นเราสามารถเลือกบล็อกความคิดเห็นด้วยรูปแบบ c/comments ที่กำหนดไว้ล่วงหน้าของ UGREP จากนั้นเลือกบรรทัดด้วย FIXME โดยใช้ท่อ:
ug -R -tc,c++ -nk -f c/comments myproject | ug -w 'FIXME'
การกรองผลลัพธ์ด้วยท่อโดยทั่วไปนั้นง่ายกว่าการใช้และตรรกะหรือตรรกะที่เครื่องมือค้นหาบางอย่างใช้ วิธีการนี้เป็นไปตามจิตวิญญาณของ UNIX เพื่อให้ระบบสาธารณูปโภคง่ายและใช้ร่วมกันสำหรับงานที่ซับซ้อนมากขึ้น
มาสร้างรายการที่จัดเรียงของตัวระบุทั้งหมดที่พบในซอร์สโค้ด Java ในขณะที่ข้ามสตริงและความคิดเห็น:
ug -R -tjava -f java/names myproject | sort -u
สิ่งนี้ตรงกับตัวระบุ java unicode โดยใช้ regex p{JavaIdentifierStart}p{JavaIdentifierPart}* กำหนดไว้ใน patterns/java/names
ด้วยเครื่องมือ GREP และ GREP แบบดั้งเดิมมันใช้ความพยายามอย่างมากในการค้นหาไฟล์ต้นฉบับ C/C ++ ที่กำหนดฟังก์ชั่น qsort อย่างซ้ำซากซึ่งต้องการสิ่งนี้:
ug -R --include='*.c' --include='*.cpp' '^([ t]*[[:word:]:*&]+)+[ t]+qsort[ t]*([^;n]+$' myproject
โชคดีที่ด้วย UGREP เราสามารถเลือกคำจำกัดความของฟังก์ชั่นทั้งหมดในไฟล์ที่มีส่วนขยาย .c หรือ .cpp โดยใช้ตัวเลือก -Oc,cpp และโดยใช้ functions รูปแบบที่กำหนดไว้ล่วงหน้าซึ่งติดตั้งด้วยเครื่องมือเพื่อสร้างคำจำกัดความฟังก์ชั่นทั้งหมด จากนั้นเราเลือกอันที่เราต้องการ:
ug -R -Oc,cpp -nk -f c/functions | ug 'qsort'
โปรดทราบว่าเราสามารถใช้ -tc,c++ เพื่อเลือกไฟล์ C/C ++ แต่สิ่งนี้ยังรวมถึงไฟล์ส่วนหัวเมื่อเราต้องการค้นหาไฟล์ .c และ .cpp เท่านั้น
นอกจากนี้เรายังสามารถข้ามไฟล์และไดเรกทอรีจากการค้นหาที่กำหนดไว้ใน. .gitignore ในการทำเช่นนั้นเราใช้ --ignore-files เพื่อยกเว้นไฟล์และไดเรกทอรีใด ๆ จากการค้นหาแบบเรียกซ้ำที่ตรงกับ globs ใน .gitignore เมื่อพบไฟล์ .gitignore gitignore หนึ่งไฟล์ขึ้นไป:
ug -R -tc++ --ignore-files -f c++/defines
สิ่งนี้จะค้นหาไฟล์ C ++ ( -tc++ ) ในไดเรกทอรีการทำงานสำหรับสาย #define ( -f c++/defines ) ในขณะที่ข้ามไฟล์และไดเรกทอรีที่ประกาศใน. .gitignore หากคุณพบสิ่งนี้นานเกินไปที่จะพิมพ์ให้กำหนดนามแฝงเพื่อค้นหาไดเรกทอรี gitHub:
alias ugit='ugrep -R --ignore-files'
ugit -tc++ -f c++/defines
เพื่อเน้นการจับคู่เมื่อผลักผ่านห่วงโซ่ของท่อเราควรใช้ --color=always :
ugit --color=always -tc++ -f c++/defines | ugrep -w 'FOO.*'
สิ่งนี้จะส่งคืนรายการสีที่มีสีสูงของ #define FOO... มาโครในไฟล์ซอร์สโค้ด C/C ++, ข้ามไฟล์ที่กำหนดไว้ใน. .gitignore
โปรดทราบว่าส่วนประกอบของ --exclude ไม่ใช่ --include เนื่องจากการยกเว้นมักจะมีความสำคัญมากกว่าการรวมดังนั้นเราจึงไม่สามารถแสดงรายการไฟล์ที่ถูกละเว้นด้วย --include-from='.gitignore' มีเพียงไฟล์ที่ระบุไว้อย่างชัดเจนกับ --include รวมถึงไดเรกทอรีที่ระบุไว้อย่างชัดเจนด้วย --include-dir --include-from จากรายการ Globs ที่ได้รับการพิจารณาทั้งไฟล์และไดเรกทอรีเพื่อเพิ่ม --include และ --include-dir ตามลำดับ ซึ่งหมายความว่าเมื่อชื่อไดเรกทอรีและเส้นทางไดเรกทอรีไม่ได้แสดงรายการอย่างชัดเจนในไฟล์นี้จะไม่ถูกเยี่ยมชมโดยใช้ --include-from
เนื่องจาก UGREP ตรวจสอบว่าอินพุตเป็น unicode ที่เข้ารหัส UTF ที่ถูกต้อง (เว้นแต่ -U ใช้) จึงเป็นไปได้ที่จะใช้เป็นตัวกรองเพื่อละเว้นเอาต์พุตที่ไม่ใช่ UTF ที่ผลิตโดยโปรแกรม:
program | ugrep -I ''
หากโปรแกรมสร้างเอาต์พุตที่ถูกต้องแล้วเอาต์พุตจะถูกส่งผ่านมิฉะนั้นเอาต์พุตจะถูกกรองตัวเลือก -I หากเอาต์พุตเริ่มต้นในตอนแรกสำหรับส่วนที่มีขนาดใหญ่มาก แต่ตามมาด้วยเอาต์พุตที่ไม่ถูกต้อง UGREP อาจแสดงผลลัพธ์ในตอนแรก แต่ไม่รวมเอาต์พุตที่ไม่ถูกต้องหลังจากนั้นเอาต์พุตเพิ่มเติมจะถูกบล็อก
เพื่อกรองเส้นที่ถูกต้อง ASCII หรือ UTF ที่เข้ารหัสในขณะที่ลบบรรทัดที่ไม่ได้:
program | ugrep '[p{Unicode}--[n]]+'
โปรดทราบว่า p{Unicode} ตรงกับ n แต่เราไม่ต้องการจับคู่ไฟล์ทั้งหมด! เพียงแค่เส้นที่มี [p{Unicode}--[n]]+
- กลับไปที่สารบัญ
หน้า Ugrep Man:
man ugrep
เพื่อแสดงหน้าวิธีใช้:
ug --help
เพื่อแสดงตัวเลือกที่กล่าวถึง WHAT :
ug --help WHAT
เพื่อแสดงรายการตัวเลือก -t TYPES :
ug -tlist
ในการสืบค้นแบบอินเทอร์แอคทีฟ TUI ให้กด F1 หรือ Ctrl-Z เพื่อขอความช่วยเหลือและตัวเลือก:
ug -Q
- กลับไปที่สารบัญ
--config[=FILE], ---[FILE]
Use configuration FILE. The default FILE is `.ugrep'. The working
directory is checked first for FILE, then the home directory. The
options specified in the configuration FILE are parsed first,
followed by the remaining options specified on the command line.
The ug command automatically loads a `.ugrep' configuration file,
unless --config=FILE or --no-config is specified.
--no-config
Do not load the default .ugrep configuration file.
--save-config[=FILE] [OPTIONS]
Save configuration FILE to include OPTIONS. Update FILE when
first loaded with --config=FILE. The default FILE is `.ugrep',
which is automatically loaded by the ug command. When FILE is a
`-', writes the configuration to standard output. Only part of the
OPTIONS are saved that do not cause searches to fail when combined
with other options. Additional options may be specified by editing
the saved configuration file. A configuration file may be modified
manually to specify one or more config[=FILE] to indirectly load
the specified FILEs, but recursive config loading is not allowed.
คำสั่ง ug มีไว้สำหรับการค้นหาแบบโต้ตอบที่ขึ้นกับบริบทและเทียบเท่ากับคำสั่ง ugrep --config เพื่อโหลดไฟล์การกำหนดค่า .ugrep เมื่ออยู่ในไดเรกทอรีการทำงานหรือเมื่อไม่พบในโฮมไดเร็กตอรี่:
ug PATTERN ...
ugrep --config PATTERN ...
คำสั่ง ug ยังเรียงลำดับไฟล์ตามชื่อต่อไดเรกทอรีที่ค้นหา ไฟล์การกำหนดค่ามีคู่ NAME=VALUE ต่อบรรทัดโดยที่ NAME คือชื่อของตัวเลือกยาว (ไม่มี -- ) และ =VALUE เป็นอาร์กิวเมนต์ซึ่งเป็นทางเลือกและอาจถูกละเว้นขึ้นอยู่กับตัวเลือก เส้นที่ว่างเปล่าและบรรทัดเริ่มต้นด้วย # จะถูกละเว้น:
# Color scheme
colors=cx=hb:ms=hiy:mc=hic:fn=hi+y+K:ln=hg:cn=hg:bn=hg:se=
# Disable searching hidden files and directories
no-hidden
# ignore files specified in .ignore and .gitignore in recursive searches
ignore-files=.ignore
ignore-files=.gitignore
ตัวเลือกบรรทัดคำสั่งจะถูกแยกวิเคราะห์ในลำดับต่อไปนี้: ก่อนที่จะโหลดไฟล์กำหนดค่า (ค่าเริ่มต้นหรือชื่อ) แล้วตัวเลือกที่เหลือและอาร์กิวเมนต์ในบรรทัดคำสั่งจะถูกแยกวิเคราะห์
ตัวเลือก --stats แสดงไฟล์การกำหนดค่าที่ใช้หลังจากค้นหา
ไฟล์การกำหนดค่าที่มีชื่อมีวัตถุประสงค์เพื่อปรับปรุงงานการค้นหาที่กำหนดเองโดยลดจำนวนตัวเลือกบรรทัดคำสั่งเป็นไฟล์เดียว ---FILE เพื่อใช้คอลเลกชันของตัวเลือกที่ระบุใน FILE ตัวเลือก --config=FILE และแบบฟอร์มตัวย่อ ---FILE โหลดไฟล์กำหนดค่าที่ระบุไว้ในไดเรกทอรีการทำงานหรือเมื่อไม่พบอยู่ในไดเรกทอรีโฮมไดเรกทอรี:
ug ---FILE PATTERN ...
ugrep ---FILE PATTERN ...
ข้อผิดพลาดจะเกิดขึ้นเมื่อไม่พบ FILE หรือไม่สามารถอ่านได้
ไฟล์การกำหนดค่าที่มีชื่อสามารถใช้เพื่อกำหนดคอลเลกชันของตัวเลือกที่เฉพาะเจาะจงกับข้อกำหนดของงานในเวิร์กโฟลว์การพัฒนาของโครงการ ตัวอย่างเช่นเพื่อรายงานปัญหาที่ไม่ได้รับการแก้ไขโดยการตรวจสอบซอร์สโค้ดและเอกสารประกอบสำหรับความคิดเห็นด้วยรายการ FixMe และ Tode ไฟล์การกำหนดค่าที่มีชื่อดังกล่าวสามารถแปลเป็นภาษาท้องถิ่นกับโครงการโดยวางไว้ในไดเรกทอรีโครงการหรือสามารถทำทั่วโลกได้โดยวางไว้ในโฮมไดเร็กตอรี่ สำหรับข้อเสนอแนะด้วยภาพสามารถระบุรูปแบบสีที่เฉพาะเจาะจงสำหรับงานนี้ด้วย colors ตัวเลือกใน FILE การกำหนดค่าเพื่อช่วยระบุผลลัพธ์ที่ผลิตโดยการกำหนดค่าที่มีชื่อเมื่อเทียบกับการกำหนดค่าเริ่มต้น
ตัวเลือก --save-config บันทึกไฟล์การกำหนดค่า .ugrep ไปยังไดเรกทอรีการทำงานโดยใช้การกำหนดค่าปัจจุบันที่โหลดด้วย --config สิ่งนี้จะบันทึกการกำหนดค่าปัจจุบันรวมกับตัวเลือกเพิ่มเติมเมื่อระบุด้วย เฉพาะตัวเลือกเหล่านั้นที่ไม่สามารถขัดแย้งกับตัวเลือกและตัวเลือกอื่น ๆ ที่ไม่สามารถบันทึกผลการค้นหาในทางลบเท่านั้น
ตัวเลือก --save-config=FILE บันทึกการกำหนดค่าไปยัง FILE ที่ระบุ การกำหนดค่าถูกเขียนไปยังเอาต์พุตมาตรฐานเมื่อ FILE คือ -
อีกวิธีหนึ่งคือไฟล์การกำหนดค่าอาจถูกสร้างหรือแก้ไขด้วยตนเอง ไฟล์การกำหนดค่าอาจรวมถึง config[=FILE] อย่างน้อยหนึ่งรายการเพื่อโหลด FILE specfified ทางอ้อม แต่ห้ามโหลดการกำหนดค่าแบบเรียกซ้ำ วิธีที่ง่ายที่สุดในการผลิตสร้างไฟล์การกำหนดค่าคือการระบุ config ที่ด้านบนของไฟล์ตามด้วยตัวเลือกยาวเพื่อแทนที่ค่าเริ่มต้น
- กลับไปที่สารบัญ
-Q[=DELAY], --query[=DELAY]
Query mode: start a TUI to perform interactive searches. This mode
requires an ANSI capable terminal. An optional DELAY argument may
be specified to reduce or increase the response time to execute
searches after the last key press, in increments of 100ms, where
the default is 3 (300ms delay). No whitespace may be given between
-Q and its argument DELAY. Initial patterns may be specified with
-e PATTERN, i.e. a PATTERN argument requires option -e. Press F1
or CTRL-Z to view the help screen. Press F2 or CTRL-Y to invoke a
command to view or edit the file shown at the top of the screen.
The command can be specified with option --view, or defaults to
environment variable PAGER when defined, or EDITOR. Press Tab and
Shift-Tab to navigate directories and to select a file to search.
Press Enter to select lines to output. Press ALT-l for option -l
to list files, ALT-n for -n, etc. Non-option commands include
ALT-] to increase context. See also options --no-confirm, --delay,
--split and --view.
--no-confirm
Do not confirm actions in -Q query TUI. The default is confirm.
--delay=DELAY
Set the default -Q key response delay. Default is 3 for 300ms.
--split
Split the -Q query TUI screen on startup.
--view[=COMMAND]
Use COMMAND to view/edit a file in -Q query TUI by pressing CTRL-Y.
ตัวเลือกนี้เริ่มต้นอินเทอร์เฟซผู้ใช้เพื่อป้อนรูปแบบการค้นหาแบบโต้ตอบ:
-c เพื่อนับการจับคู่ กด Alt -C อีกครั้งปิดใช้งาน -c ตัวเลือกสามารถสลับกับปุ่ม ALT ในขณะที่ค้นหาหรือเมื่อดูหน้าจอวิธีใช้ หากไม่รองรับปุ่ม Alt/Meta (เช่น x11 x11) จากนั้นกด Ctrl-O ตามด้วยคีย์ที่สอดคล้องกับตัวเลือก-g ไฟล์และไดเรกทอรีที่ตรงกัน GLOBS รายการรูปแบบลูกโลกสไตล์ Gitignore ที่คั่นด้วยเครื่องหมายจุลภาค กด ESC ส่งคืนการควบคุมไปยังพรอมต์รูปแบบการสืบค้น (บันทึกลูกโลก) เมื่อลูกโลกถูกนำหน้าด้วย A ! หรือ A ^ , ข้ามไฟล์ที่มีชื่อตรงกับลูกโลกเมื่อ GLOB มีชื่อ A / , Full Pathname ถูกจับคู่ มิฉะนั้นจะมีการจับคู่ชื่อ basenames เมื่อลูกโลกจบลงด้วย A / , ไดเรกทอรีถูกจับคู่Q> (ปกติ), F> (สตริงคงที่), G> (regex พื้นฐาน), P> (การจับคู่ perl) และ Z> (การจับคู่ฟัซซี่) เมื่อมีการแสดงพรอมต์ --glob= แสดงรายการรูปแบบลูกโลกสไตล์ Gitignore ที่คั่นด้วยเครื่องหมายจุลภาค กด ESC ส่งคืนการควบคุมไปยังพรอมต์รูปแบบ--view--view=COMMAND มิฉะนั้นตัวแปรสภาพแวดล้อม PAGER หรือ EDITOR จะใช้ในการเรียกใช้คำสั่งด้วย ctrl-y ชื่อไฟล์จะต้องเปิดใช้งานและมองเห็นได้ในเอาต์พุตเพื่อใช้คุณสมบัตินี้--color สีDELAY ต่ำเช่น 1 อย่างไรก็ตามค่าที่ต่ำกว่าอาจเพิ่มการโหลดของระบบอันเป็นผลมาจากการเริ่มต้นและยกเลิกการค้นหาซ้ำ ๆ โดยแต่ละคีย์กด--heading การเปิดใช้งานการเปิดใช้งานโดยค่าเริ่มต้น กด Alt-+ เพื่อปิดส่วนหัวQuery Tui Mapping:
| คีย์ | การทำงาน |
|---|---|
Alt-key | สลับตัวเลือกบรรทัดคำสั่ง UGREP ที่สอดคล้องกับ key |
Alt-/ xxxx / | แทรก UNICODE HEX CODE POINT U+XXXX |
Esc Ctrl-C | ย้อนกลับหรือออก |
Ctrl-Q | ออกอย่างรวดเร็วและส่งออกผลลัพธ์ที่เลือกในโหมดการเลือก |
Tab | chdir ไปยังไดเรกทอรีของไฟล์ที่แสดงที่ด้านบนของหน้าจอหรือเลือกไฟล์ |
Shift-Tab | chdir หนึ่งระดับขึ้นหรือยกเลิกการเลือกไฟล์ |
Enter | เข้าสู่โหมดการเลือกและสลับบรรทัดที่เลือกเพื่อส่งออกเมื่อออกจากทางออก |
Up Ctrl-P | เลื่อนขึ้น |
Down Ctrl-N | เลื่อนลง |
Left Ctrl-B | ย้ายไปทางซ้าย |
Ctrl-F Right | ย้ายไปทางขวา |
PgUp Ctrl-G | ย้ายแสดงตามหน้าเว็บ |
PgDn Ctrl-D | ย้ายจอแสดงผลตามหน้าเว็บ |
Alt-Up | ย้ายแสดงขึ้นโดย 1/2 หน้า (macOS Shift-Up ) |
Alt-Down | ย้ายแสดงลงโดย 1/2 หน้า (macOS Shift-Down ) |
Alt-Left | ย้ายจอแสดงผลทางซ้ายโดยหน้า 1/2 (MacOS Shift-Left ) |
Alt-Right | ย้ายจอแสดงผลโดย 1/2 หน้า (macOS Shift-Right ) |
Home Ctrl-A | ย้ายเคอร์เซอร์ไปที่จุดเริ่มต้นของเส้น |
End Ctrl-E | ย้ายเคอร์เซอร์ไปที่จุดสิ้นสุดของเส้น |
Ctrl-K | ลบหลังเคอร์เซอร์ |
Ctrl-L | หน้าจอรีเฟรช |
key Ctrl-O + | สลับตัวเลือกบรรทัดคำสั่ง UGREP ที่สอดคล้องกับ key เช่นเดียวกับ Alt-key |
Ctrl-R F4 | ข้ามไปที่คั่นหน้า |
Ctrl-S | ข้ามไปยัง DIR/ไฟล์/บริบทถัดไป |
Ctrl-T F5 | สลับหน้าจอแยก ( --split เริ่มต้นหน้าจอ TUI) |
Ctrl-U | ลบก่อนเคอร์เซอร์ |
Ctrl-V | ตัวละครคำต่อคำ |
Ctrl-W | กระโดดกลับหนึ่ง dir/ไฟล์/บริบท |
Ctrl-X F3 | ตั้งบุ๊คมาร์ค |
Ctrl-Y F2 | ดูหรือแก้ไขไฟล์ที่แสดงที่ด้านบนของหน้าจอ |
Ctrl-Z F1 | ดูความช่วยเหลือและตัวเลือก |
Ctrl-^ | Chdir กลับไปที่ไดเรกทอรีการทำงานเริ่มต้น |
Ctrl-] | สลับสี/โมโน |
Ctrl- | ยุติกระบวนการ |
เพื่อค้นหาไฟล์ในไดเรกทอรีการทำงานและด้านล่าง:
ug -Q
เหมือนกัน แต่ จำกัด เฉพาะไฟล์ C ++ เท่านั้นและไม่สนใจไฟล์ .gitignore gitignore:
ug -Q -tc++ --ignore-files
เพื่อค้นหา makefiles ทั้งหมดในไดเรกทอรีการทำงานและด้านล่าง:
ug -Q -g 'Makefile*' -g 'makefile*'
เหมือนกัน แต่สำหรับไดเรกทอรีสูงสุด 2 ระดับ (การทำงานและระดับไดเรกทอรีย่อยหนึ่งระดับ):
ug -Q -2 -g 'Makefile*' -g 'makefile*'
เพื่อดูเนื้อหาของ main.cpp และค้นหาโดยที่ -y แสดงบรรทัดที่ไม่จับคู่เป็นบริบท:
ug -Q -y main.cpp
ในการค้นหา main.cpp แบบโต้ตอบเริ่มต้นด้วยรูปแบบการค้นหา TODO และบริบทการจับคู่ของ 5 บรรทัด (บริบทสามารถเปิดใช้งานและปิดใช้งานได้ซึ่งจะแทนที่ขนาดบริบทเริ่มต้นของ 2 บรรทัด):
ug -Q -C5 -e TODO main.cpp
ในการดูและค้นหาเนื้อหาของคลังเก็บ (เช่น Zip, Tarball):
ug -Q -z archive.tar.gz
หากต้องการเลือกไฟล์แบบโต้ตอบจาก project.zip ไปยังการคลายด้วย unzip โดยใช้โหมดการเลือก UGREP แบบสอบถาม (กด Enter เพื่อเลือกบรรทัด):
unzip project.zip `zipinfo -1 project.zip | ugrep -Q`
- กลับไปที่สารบัญ
-L, --files-without-match
Only the names of files not containing selected lines are written
to standard output. Pathnames are listed once per file searched.
If the standard input is searched, the string ``(standard input)''
is written.
-l, --files-with-matches
Only the names of files containing selected lines are written to
standard output. ugrep will only search a file until a match has
been found, making searches potentially less expensive. Pathnames
are listed once per file searched. If the standard input is
searched, the string ``(standard input)'' is written.
-R, --dereference-recursive
Recursively read all files under each directory. Follow all
symbolic links to files and directories, unlike -r.
-r, --recursive
Recursively read all files under each directory, following symbolic
links only if they are on the command line. Note that when no FILE
arguments are specified and input is read from a terminal,
recursive searches are performed as if -r is specified.
-S, --dereference-files
When -r is specified, symbolic links to files are followed, but not
to directories. The default is not to follow symbolic links.
--depth=[MIN,][MAX], -1, -2, -3, ... -9, -10, -11, -12, ...
Restrict recursive searches from MIN to MAX directory levels deep,
where -1 (--depth=1) searches the specified path without recursing
into subdirectories. Note that -3 -5, -3-5, and -35 search 3 to 5
levels deep. Enables -r if -R or -r is not specified.
-g GLOBS, --glob=GLOBS
Search only files whose name matches the specified comma-separated
list of GLOBS, same as --include='glob' for each `glob' in GLOBS.
When a `glob' is preceded by a `!' or a `^', skip files whose name
matches `glob', same as --exclude='glob'. When `glob' contains a
`/', full pathnames are matched. Otherwise basenames are matched.
When `glob' ends with a `/', directories are matched, same as
--include-dir='glob' and --exclude-dir='glob'. A leading `/'
matches the working directory. This option may be repeated and may
be combined with options -M, -O and -t to expand searches. See
`ugrep --help globs' and `man ugrep' section GLOBBING for details.
-O EXTENSIONS, --file-extension=EXTENSIONS
Search only files whose filename extensions match the specified
comma-separated list of EXTENSIONS, same as --include='*.ext' for
each `ext' in EXTENSIONS. When `ext' is preceded by a `!' or a
`^', skip files whose filename extensions matches `ext', same as
--exclude='*.ext'. This option may be repeated and may be combined
with options -g, -M and -t to expand the recursive search.
-t TYPES, --file-type=TYPES
Search only files associated with TYPES, a comma-separated list of
file types. Each file type corresponds to a set of filename
extensions passed to option -O and filenames passed to option -g.
For capitalized file types, the search is expanded to include files
with matching file signature magic bytes, as if passed to option
-M. When a type is preceded by a `!' or a `^', excludes files of
the specified type. This option may be repeated.
--stats
Output statistics on the number of files and directories searched,
and the inclusion and exclusion constraints applied.
หากไม่มีการระบุอาร์กิวเมนต์ไฟล์และป้อนข้อมูลจากเทอร์มินัลการค้นหาแบบเรียกซ้ำจะดำเนินการราวกับว่ามีการระบุ -r ในการบังคับให้อ่านจากอินพุตมาตรฐานให้ระบุ - เป็นอาร์กิวเมนต์ไฟล์
เพื่อแสดงรายการไฟล์ที่ไม่ว่างเปล่าทั้งหมดในไดเรกทอรีการทำงาน:
ug -r -l ''
เพื่อแสดงรายการไฟล์ที่ไม่ว่างเปล่าทั้งหมดในไดเรกทอรีการทำงาน แต่ไม่ลึกกว่า (เนื่องจากมีการโต้แย้งไฟล์ใน . นี้สำหรับไดเรกทอรีการทำงาน):
ug -l '' .
เพื่อแสดงรายการไฟล์ที่ไม่ว่างเปล่าทั้งหมดในไดเรกทอรี mydir แต่ไม่ลึกกว่า (เนื่องจากมีการโต้แย้งไฟล์):
ug -l '' mydir
เพื่อแสดงรายการไฟล์ที่ไม่ว่างเปล่าทั้งหมดในไดเรกทอรี mydir และลึกลงไปในขณะที่ติดตาม symlinks:
ug -R -l '' mydir
หากต้องการแสดงรายการไฟล์ที่ไม่ว่างเปล่าทั้งหมดบนเส้นทางที่ระบุในขณะที่เยี่ยมชมไดเรกทอรีย่อยเท่านั้นเช่นไดเรกทอรี mydir/ และไดเรกทอรีย่อยในระดับหนึ่งที่ลึกกว่า mydir/*/ ถูกเยี่ยมชม (โปรดทราบว่า -2 -l สามารถย่อได้ที่ -l2 ):
ug -2 -l '' mydir
หากต้องการแสดงรายการไฟล์ที่ไม่ว่างเปล่าทั้งหมดในไดเรกทอรี mydir ไม่ติดตามลิงก์สัญลักษณ์ใด ๆ (ยกเว้นเมื่ออยู่ในบรรทัดคำสั่งเช่น mydir ):
ug -rl '' mydir
หากต้องการแสดงรายการ makefiles ทั้งหมดที่ตรงกับข้อความ CPP :
ug -l -tmake 'CPP'
เพื่อแสดงรายการ Makefile.* การจับคู่ bin_PROGRAMS :
ug -l -g'Makefile.*' 'bin_PROGRAMS'
เพื่อแสดงรายการไฟล์ที่ไม่ว่างเปล่าทั้งหมดด้วยส่วนขยาย. sh ด้วย -Osh :
ug -l -Osh ''
เพื่อแสดงรายการสคริปต์เชลล์ทั้งหมดตามส่วนขยายและ shebangs ด้วย -tShell :
ug -l -tShell ''
หากต้องการแสดงรายการสคริปต์เชลล์ทั้งหมดตามส่วนขยายเท่านั้นด้วย -tshell :
ug -l -tshell ''
- กลับไปที่สารบัญ
--bool, -%, -%%
Specifies Boolean query patterns. A Boolean query pattern is
composed of `AND', `OR', `NOT' operators and grouping with `(' `)'.
Spacing between subpatterns is the same as `AND', `|' is the same
as `OR' and a `-' is the same as `NOT'. The `OR' operator binds
more tightly than `AND'. For example, --bool 'A|B C|D' matches
lines with (`A' or `B') and (`C' or `D'), --bool 'A -B' matches
lines with `A' and not `B'. Operators `AND', `OR', `NOT' require
proper spacing. For example, --bool 'A OR B AND C OR D' matches
lines with (`A' or `B') and (`C' or `D'), --bool 'A AND NOT B'
matches lines with `A' without `B'. Quoted subpatterns are matched
literally as strings. For example, --bool 'A "AND"|"OR"' matches
lines with `A' and also either `AND' or `OR'. Parentheses are used
for grouping. For example, --bool '(A B)|C' matches lines with `A'
and `B', or lines with `C'. Note that all subpatterns in a Boolean
query pattern are regular expressions, unless -F is specified.
Options -E, -F, -G, -P and -Z can be combined with --bool to match
subpatterns as strings or regular expressions (-E is the default.)
This option does not apply to -f FILE patterns. The double short
option -%% enables options --bool --files. Option --stats displays
the Boolean search patterns applied. See also options --and,
--andnot, --not, --files and --lines.
--files
Boolean file matching mode, the opposite of --lines. When combined
with option --bool, matches a file if all Boolean conditions are
satisfied. For example, --bool --files 'A B|C -D' matches a file
if some lines match `A', and some lines match either `B' or `C',
and no line matches `D'. See also options --and, --andnot, --not,
--bool and --lines. The double short option -%% enables options
--bool --files.
--lines
Boolean line matching mode for option --bool, the default mode.
--and [[-e] PATTERN] ... -e PATTERN
Specify additional patterns to match. Patterns must be specified
with -e. Each -e PATTERN following this option is considered an
alternative pattern to match, i.e. each -e is interpreted as an OR
pattern. For example, -e A -e B --and -e C -e D matches lines with
(`A' or `B') and (`C' or `D'). Note that multiple -e PATTERN are
alternations that bind more tightly together than --and. Option
--stats displays the search patterns applied. See also options
--not, --andnot, and --bool.
--andnot [[-e] PATTERN] ...
Combines --and --not. See also options --and, --not, and --bool.
--not [-e] PATTERN
Specifies that PATTERN should not match. Note that -e A --not -e B
matches lines with `A' or lines without a `B'. To match lines with
`A' that have no `B', specify -e A --andnot -e B. Option --stats
displays the search patterns applied. See also options --and,
--andnot, and --bool.
--stats
Output statistics on the number of files and directories searched,
and the inclusion and exclusion constraints applied.
โปรดทราบว่าตัวเลือก --and --not และ --andnot จำเป็นต้องใช้ -e PATTERN
ตัวเลือก -% ทำให้รูปแบบทั้งหมดเป็นไปตามบูลีนโดยรองรับการดำเนินงานเชิงตรรกะต่อไปนี้ที่ระบุไว้จากระดับสูงสุดของความสำคัญต่ำที่สุด: ต่ำสุด:
| ตัวดำเนินการ | ทางเลือก | ผลลัพธ์ |
|---|---|---|
"x" | จับคู่ x ตามตัวอักษรและตรงตามที่ระบุไว้ (โดยใช้มาตรฐาน regex Escapes Q และ E ) | |
( ) | การจัดกลุ่มการแสดงออกของบูลีน | |
-x | NOT x | การจับคู่แบบกลับด้านเช่นการจับคู่ถ้า x ไม่ตรงกัน |
x|y | x OR y | จับคู่บรรทัดกับ x หรือ y |
xy | x AND y | จับคู่บรรทัดกับทั้ง x และ y |
x และ y เป็นรูปแบบย่อยที่ไม่ได้เริ่มต้นด้วยสัญลักษณ์พิเศษ | , - และ ( (ใช้คำพูดหรือ A Escape เพื่อให้ตรงกับสิ่งเหล่านี้);
- และ NOT เหมือนกันและมีความสำคัญกว่า OR ซึ่งหมายความว่า -x|y == (-x)|y ตัวอย่างเช่น
| และ OR เหมือนกันและมีความสำคัญกว่า AND ซึ่งหมายความว่า xy|z == x (y|z) ตัวอย่างเช่น;
ตัวเลือก --stats จะแสดงการสืบค้นบูลีนในรูปแบบที่มนุษย์อ่านได้ซึ่งแปลงเป็น CNF (แบบฟอร์มปกติแบบ conjective) หลังจากการค้นหาเสร็จสิ้น หากต้องการแสดง CNF โดยไม่มีการค้นหาอ่านจากอินพุตมาตรฐานที่ถูกยกเลิกโดย EOF เช่น echo | ugrep -% '...' --stats
Subpatterns เป็นสีสูงในเอาต์พุตยกเว้นที่ NOT ได้รับการคัดค้านด้วย (A NOT อาจยังคงปรากฏในบรรทัดการจับคู่เมื่อใช้รูปแบบ OR-NOT เช่น x|-y ) โปรดทราบว่ารูปแบบย่อยอาจทับซ้อนกัน ในกรณีนั้นมีเพียง subpattern ที่จับคู่แรกคือสีสูง
หลายบรรทัดอาจถูกจับคู่เมื่อ Subpatterns ตรงกับ newLines อย่างไรก็ตามมีข้อยกเว้นหนึ่งข้อ: subpatterns ที่ลงท้ายด้วย (?=X) lookaheads อาจไม่ตรงกันเมื่อ X ครอบคลุมหลายบรรทัด
รูปแบบที่ว่างเปล่าตรงกับบรรทัดใด ๆ (มาตรฐาน GREP) ดังนั้น -% 'x|""|y' ตรงกับทุกอย่างและ x และ y ไม่ได้มีสีสูง ตัวเลือก -y ควรใช้เพื่อแสดงทุกบรรทัดเป็นบริบทตัวอย่างเช่น -y 'x|y'
การสืบค้นแบบอินเทอร์แอคทีฟที่มีลักษณะคล้าย FZF (ค้นหาบูลีนพร้อมสตริงคงที่ด้วยการจับคู่ฟัซซี่เพื่อให้ได้เช่นอักขระพิเศษสูงสุด 4 ตัวที่ตรงกับ -Z+4 ในคำที่มี -w ) กดแท็บและ alt -y เพื่อดูไฟล์ที่มีการจับคู่ กด Shift-Tab และ Alt-L เพื่อกลับไปที่รายการไฟล์ที่ตรงกัน:
ug -Q -%% -l -w -F -Z+4 --sort=best
เพื่อค้นหาไฟล์ทั้งหมดที่มีทั้ง hot และ dog ทุกที่ในไฟล์พร้อมตัวเลือก --files :
ug -%% 'hot dog'
ug --files -e hot --and dog
เพื่อค้นหาเส้นที่มีทั้ง hot และ dog ใน myfile.txt :
ug -% 'hot dog' myfile.txt
ug -e hot --and dog myfile.txt
เพื่อค้นหาบรรทัดที่มี place และจากนั้น hotdog หรือ taco (หรือทั้งสอง) ใน myfile.txt :
ug -% 'hotdog|taco place' myfile.txt
ug -e hotdog -e taco --and place myfile.txt
เหมือนกัน แต่ไม่รวมบรรทัดที่จับคู่ diner :
ug -% 'hotdog|taco place -diner' myfile.txt
ug -e hotdog -e taco --and place --andnot diner myfile.txt
เพื่อค้นหาสายที่มี diner หรือเส้นที่ตรงกับทั้ง fast และ food แต่ไม่ bad ใน myfile.txt :
ug -% 'diner|(fast food -bad)' myfile.txt
เพื่อค้นหาสายที่มี fast food (แน่นอน) หรือเส้นที่มี diner แต่ไม่ bad หรือ old ใน myfile.txt :
ug -% '"fast food"|diner -bad -old' myfile.txt
เหมือนกัน แต่ใช้นิพจน์บูลีนที่แตกต่างกันซึ่งมีความหมายเหมือนกัน:
ug -% '"fast food"|diner -(bad|old)' myfile.txt
เพื่อค้นหาสายที่มี diner ที่มีความหมาย good ใน myfile.txt (นั่นคือแสดงเส้น good โดยไม่ต้อง diner และแสดงเส้นกับ diner แต่มีเพียงผู้ที่มี good เท่านั้นซึ่งมีเหตุผล!)::
ug -% 'good|-diner' myfile.txt
ug -e good --not diner myfile.txt
เพื่อค้นหาเส้นที่มี foo และ -bar และ "baz" ใน myfile.txt (ไม่ใช่ - และ " ควรจับคู่โดยใช้ escapes และกับ --and -e -bar ):
ug -% 'foo -bar "baz"' myfile.txt
ug -e foo --and -e -bar --and '"baz"' myfile.txt
ในการค้นหา myfile.cpp สำหรับบรรทัดที่มี TODO หรือ FIXME แต่ไม่ใช่ทั้งสองในบรรทัดเดียวกันเช่น xor:
ug -% 'TODO|FIXME -(TODO FIXME)' myfile.cpp
ug -e TODO -e FIXME --and --not TODO --not FIXME myfile.cpp
- กลับไปที่สารบัญ
-e PATTERN, --regexp=PATTERN
Specify a PATTERN to search the input. An input line is selected
if it matches any of the specified patterns. This option is useful
when multiple -e options are used to specify multiple patterns, or
when a pattern begins with a dash (`-'), or to specify a pattern
after option -f or after the FILE arguments.
-f FILE, --file=FILE
Read newline-separated patterns from FILE. White space in patterns
is significant. Empty lines in FILE are ignored. If FILE does not
exist, the GREP_PATH environment variable is used as path to FILE.
If that fails, looks for FILE in /usr/local/share/ugrep/pattern.
When FILE is a `-', standard input is read. This option may be
repeated.
-L, --files-without-match
Only the names of files not containing selected lines are written
to standard output. Pathnames are listed once per file searched.
If the standard input is searched, the string ``(standard input)''
is written.
-N PATTERN, --neg-regexp=PATTERN
Specify a negative PATTERN to reject specific -e PATTERN matches
with a counter pattern. Note that longer patterns take precedence
over shorter patterns, i.e. a negative pattern must be of the same
length or longer to reject matching patterns. Option -N cannot be
specified with -P. This option may be repeated.
-v, --invert-match
Selected lines are those not matching any of the specified
patterns.
-w, --word-regexp
The PATTERN is searched for as a word, such that the matching text
is preceded by a non-word character and is followed by a non-word
character. Word-like characters are Unicode letters, digits and
connector punctuations such as underscore.
-x, --line-regexp
Select only those matches that exactly match the whole line, as if
the patterns are surrounded by ^ and $.
ดูรูปแบบการสืบค้นแบบบูลีนด้วย -%, -%%, -และ - -ไม่ใช่ตัวเลือกการสืบค้นบูลีนที่ทรงพลังกว่าตัวเลือก GNU/BSD GREP แบบดั้งเดิม
ในการแสดงบรรทัดในไฟล์ myfile.sh แต่ไม่ตรงกับบรรทัด ^[ t]*# :
ug -v '^[ t]*#' myfile.sh
เพื่อค้นหา myfile.cpp สำหรับบรรทัดที่มี FIXME และ urgent แต่ไม่ใช่ Scotty :
ugrep FIXME myfile.cpp | ugrep urgent | ugrep -v Scotty
เหมือนกัน แต่ใช้ -% สำหรับแบบสอบถามบูลีน:
ug -% 'FIXME urgent -Scotty' myfile.cpp
ในการค้นหาทศนิยมโดยใช้รูปแบบ d+ ที่ไม่ได้เริ่มต้นด้วย 0 โดยใช้รูปแบบลบ 0d+ และไม่รวม 555 :
ug -e 'd+' -N '0d+' -N 555 myfile.cpp
ในการค้นหาคำที่เริ่มต้นด้วย disp โดยไม่ต้องจับคู่ display ผลในไฟล์ myfile.py โดยใช้ "รูปแบบเชิงลบ" -N '/<display>' โดยที่ -N ระบุรูปแบบเชิงลบเพิ่มเติมเพื่อข้ามการจับคู่:
ug -e '<disp' -N '<display>' myfile.py
ในการค้นหาบรรทัดที่มี display คำในไฟล์ myfile.py ข้ามคำนี้ในสตริงและความคิดเห็นโดยที่ -f ระบุรูปแบบในไฟล์ที่กำหนดรูปแบบที่กำหนดไว้ล่วงหน้าในกรณีนี้:
ug -n -w 'display' -f python/zap_strings -f python/zap_comments myfile.py
เพื่อแสดงบรรทัดที่ไม่ใช่เส้นเปล่า:
ug -x -e '.*' -N 'h*' myfile.py
เหมือนกัน แต่ใช้ -v และ -x กับ h* , เช่นรูปแบบ ^h*$ :
ug -v -x 'h*' myfile.py
หากต้องการแสดงรายการไฟล์ Python ทั้งหมดที่ไม่มี display คำทำให้คำที่เกิดขึ้นในสตริงและความคิดเห็น:
ug -RL -tPython -w 'display' -f python/zap_strings -f python/zap_comments
- กลับไปที่สารบัญ
--encoding=ENCODING
The encoding format of the input. The default ENCODING is binary
and UTF-8 which are the same. Note that option -U specifies binary
PATTERN matching (text matching is the default.)
ไฟล์ไบนารี, ASCII และ UTF-8 ไม่จำเป็นต้องมีตัวเลือกนี้ในการค้นหา นอกจากนี้ไฟล์ UTF-16 และ UTF-32 ไม่ต้องการตัวเลือกนี้ในการค้นหาโดยสมมติว่าไฟล์ UTF-16 และ UTF-32 เริ่มต้นด้วย UTF BOM (เครื่องหมายคำสั่งซื้อไบต์) ตามปกติ การเข้ารหัสไฟล์อื่น ๆ ต้องใช้ตัวเลือก --encoding=ENCODING :
| การเข้ารหัส | พารามิเตอร์ |
|---|---|
| ASCII | ไม่มี |
| UTF-8 | ไม่มี |
| UTF-16 กับ BOM | ไม่มี |
| UTF-32 พร้อม BOM | ไม่มี |
| utf-16 be w/o bom | UTF-16 หรือ UTF-16BE |
| utf-16 le w/o bom | UTF-16LE |
| UTF-32 w/o bom | UTF-32 หรือ UTF-32BE |
| UTF-32 w/o bom | UTF-32LE |
| ละติน -1 | LATIN1 หรือ ISO-8859-1 |
| ISO-8859-1 | ISO-8859-1 |
| ISO-8859-2 | ISO-8859-2 |
| ISO-8859-3 | ISO-8859-3 |
| ISO-8859-4 | ISO-8859-4 |
| ISO-8859-5 | ISO-8859-5 |
| ISO-8859-6 | ISO-8859-6 |
| ISO-8859-7 | ISO-8859-7 |
| ISO-8859-8 | ISO-8859-8 |
| ISO-8859-9 | ISO-8859-9 |
| ISO-8859-10 | ISO-8859-10 |
| ISO-8859-11 | ISO-8859-11 |
| ISO-8859-13 | ISO-8859-13 |
| ISO-8859-14 | ISO-8859-14 |
| ISO-8859-15 | ISO-8859-15 |
| ISO-8859-16 | ISO-8859-16 |
| MAC (CR = NEWLINE) | MAC |
| Macroman (cr = newline) | MACROMAN |
| เอ็บซีดิก | EBCDIC |
| รหัส DOS หน้า 437 | CP437 |
| รหัส dos หน้า 850 | CP850 |
| รหัส DOS หน้า 858 | CP858 |
| รหัส Windows หน้า 1250 | CP1250 |
| รหัส Windows หน้า 1251 | CP1251 |
| รหัส Windows หน้า 1252 | CP1252 |
| รหัส Windows หน้า 1253 | CP1253 |
| รหัส Windows หน้า 1254 | CP1254 |
| รหัส Windows หน้า 1255 | CP1255 |
| รหัส Windows หน้า 1256 | CP1256 |
| รหัส Windows หน้า 1257 | CP1257 |
| รหัส Windows หน้า 1258 | CP1258 |
| koi8-r | KOI8-R |
| koi8-u | KOI8-U |
| Koi8-ru | KOI8-RU |
โปรดทราบว่ารูปแบบ regex จะถูกระบุไว้เสมอใน UTF-8 (รวมถึง ASCII) ในการค้นหาไฟล์ไบนารีที่มีรูปแบบไบนารีดูการค้นหาและแสดงไฟล์ไบนารีด้วย -u, -w และ -x
หากต้องการแสดงรายการไฟล์ทั้งหมดที่เป็น ASCII (เช่น 7 บิต):
ug -L '[^[:ascii:]]'
หากต้องการแสดงรายการไฟล์ทั้งหมดที่ไม่ใช่ ASCII เช่น UTF-8, UTF-16 และ UTF-32 ไฟล์ที่มีอักขระ Unicode ที่ไม่ใช่ ASCII (U+0080 ขึ้นไป):
ug -l '[^[:ascii:]]'
เพื่อตรวจสอบว่าไฟล์มี Unicode ที่ไม่ใช่ ASCII (U+0080 ขึ้นไป):
ug -q '[^[:ascii:]]' myfile && echo "contains Unicode"
ในการลบอักขระ Unicode ที่ไม่ถูกต้องจากไฟล์ (โปรดทราบว่า -o อาจไม่ทำงานเนื่องจากตรวจพบข้อมูลไบนารีและปฏิเสธและเพิ่มใหม่ แต่ --format="%o% ไม่ตรวจสอบไบนารีและคัดลอกการจับคู่" ตามที่เป็น " ):
ug "[p{Unicode}n]" --format="%o" badfile.txt
หากต้องการแสดงรายการไฟล์ที่มีเนื้อหา UTF ที่ไม่ถูกต้อง (เช่นลำดับหรือไฟล์ไบต์ที่ไม่ถูกต้อง UTF-8 ไบต์หรือไฟล์ที่มีคะแนนรหัส UTF-8/16/32 ใด ๆ ที่อยู่นอกช่วง Unicode ที่ถูกต้อง . โดยการจับคู่จุดรหัสใด ๆ กับ และโดยใช้รูปแบบเชิงลบ -N 'p{Unicode}' เพื่อละเว้นอักขระ Unicode ที่ถูกต้องแต่ละตัว:
ug -l -e '.' -N 'p{Unicode}'
เพื่อแสดงเส้นที่มีอีโมจิใบหน้าหัวเราะ:
ug '[?-?]' emojis.txt
ผลลัพธ์เดียวกันนี้ได้รับโดยใช้ x{hhhh} เพื่อเลือกช่วงอักขระ Unicode:
ug '[x{1F600}-x{1F60F}]' emojis.txt
ในการแสดงบรรทัดที่มีชื่อGödel (หรือ Goedel), Escher หรือ Bach:
ug 'G(ö|oe)del|Escher|Bach' GEB.txt wiki.txt
ในการค้นหา lorem ในตัวพิมพ์เล็กหรือบนในไฟล์ UTF-16 ที่ทำเครื่องหมายด้วย UTF-16 BOM:
ug -iw 'lorem' utf16lorem.txt
ในการค้นหา utf16lorem.txt เมื่อไฟล์นี้ไม่มี UTF-16 BOM โดยใช้ --encoding :
ug --encoding=UTF-16 -iw 'lorem' utf16lorem.txt
ในการค้นหาไฟล์ spanish-iso.txt ที่เข้ารหัสใน ISO-8859-1:
ug --encoding=ISO-8859-1 -w 'año' spanish-iso.txt
- กลับไปที่สารบัญ
-o, --only-matching
Output only the matching part of lines. If -A, -B or -C is
specified, fits the match and its context on a line within the
specified number of columns.
หลายบรรทัดอาจถูกจับคู่ด้วยรูปแบบที่ตรงกับอักขระใหม่ ใช้ตัวเลือก -o เพื่อส่งออกการแข่งขันเท่านั้นไม่ใช่บรรทัดเต็มที่ตรงกัน
เพื่อให้ตรงกับการแบ่งบรรทัด n ให้รวม n ในรูปแบบเพื่อให้ตรงกับอักขระ LF หากคุณต้องการจับคู่ rn และ n breaks ให้ใช้ r?n หรือเพียงแค่ใช้ R เพื่อให้ตรงกับการแบ่งสาย Unicode rn , r , v , f , n , u +0085, U+2028 และ U+2029
เพื่อจับคู่ C/C ++ /*...*/ ความคิดเห็นหลายบรรทัด:
ug '/*(.*n)*?.**+/' myfile.cpp
เพื่อให้ตรงกับความคิดเห็น C/C ++ โดยใช้รูปแบบ c/comments ที่กำหนดไว้ล่วงหน้าด้วย -fc/comments ที่ จำกัด ไว้ที่ส่วนที่ตรงกันเท่านั้นด้วยตัวเลือก -o :
ug -of c/comments myfile.cpp
เหมือนกับ sed -n '/begin/,/end/p' : เพื่อให้ตรงกับเส้นทั้งหมดระหว่างบรรทัดที่มี begin และบรรทัดแรกหลังจากนั้นมี end โดยใช้การทำซ้ำขี้เกียจ:
ug -o '.*begin(.|n)*?end.*' myfile.txt
- กลับไปที่สารบัญ
-A NUM, --after-context=NUM
Output NUM lines of trailing context after matching lines. Places
a --group-separator between contiguous groups of matches. If -o is
specified, output the match with context to fit NUM columns after
the match or shortens the match. See also options -B, -C and -y.
-B NUM, --before-context=NUM
Output NUM lines of leading context before matching lines. Places
a --group-separator between contiguous groups of matches. If -o is
specified, output the match with context to fit NUM columns before
the match or shortens the match. See also options -A, -C and -y.
-C NUM, --context=NUM
Output NUM lines of leading and trailing context surrounding each
matching line. Places a --group-separator between contiguous
groups of matches. If -o is specified, output the match with
context to fit NUM columns before and after the match or shortens
the match. See also options -A, -B and -y.
-y, --any-line
Any line is output (passthru). Non-matching lines are output as
context with a `-' separator. See also options -A, -B, and -C.
--width[=NUM]
Truncate the output to NUM visible characters per line. The width
of the terminal window is used if NUM is not specified. Note that
double wide characters in the output may result in wider lines.
-o, --only-matching
Output only the matching part of lines. If -A, -B or -C is
specified, fits the match and its context on a line within the
specified number of columns.
เพื่อแสดงบริบทสองบรรทัดก่อนและหลังบรรทัดการจับคู่:
ug -C2 'FIXME' myfile.cpp
เพื่อแสดงบริบทสามบรรทัดหลังจากเส้นที่ตรงกัน:
ug -A3 'FIXME.*' myfile.cpp:
ในการแสดงหนึ่งบรรทัดของบริบทก่อนแต่ละบรรทัดการจับคู่ด้วยคำจำกัดความฟังก์ชัน C (ชื่อ C ไม่ใช่ Unicode):
ug -B1 -f c/functions myfile.c
ในการแสดงบริบทหนึ่งบรรทัดก่อนแต่ละบรรทัดการจับคู่ด้วยนิยามฟังก์ชัน C ++ (ชื่อ C ++ อาจเป็น Unicode):
ug -B1 -f c++/functions myfile.cpp
เพื่อแสดงบรรทัดที่ไม่จับคู่เป็นบริบทสำหรับการจับคู่บรรทัดด้วย -y :
ug -y -f c++/functions myfile.cpp
เพื่อแสดง hexdump ของเส้นที่ตรงกันด้วยหนึ่งบรรทัดของบริบท hexdump:
ug -C1 -UX 'xaaxbbxcc' a.out
บริบทภายในบรรทัดจะแสดงพร้อมตัวเลือก -o พร้อมตัวเลือกบริบท:
ug -o -C20 'pattern' myfile.cpp
เหมือนกัน แต่มีเอาต์พุตสวย ๆ ด้วยหัวเรื่องหมายเลขบรรทัดและหมายเลขคอลัมน์ ( -k ) และแสดงบริบท:
ug --pretty -oC20 'pattern' myfile.cpp
- กลับไปที่สารบัญ
-f FILE, --file=FILE
Read newline-separated patterns from FILE. White space in patterns
is significant. Empty lines in FILE are ignored. If FILE does not
exist, the GREP_PATH environment variable is used as path to FILE.
If that fails, looks for FILE in /usr/local/share/ugrep/pattern.
When FILE is a `-', standard input is read. This option may be
repeated.
--ignore-files[=FILE]
Ignore files and directories matching the globs in each FILE that
is encountered in recursive searches. The default FILE is
`.gitignore'. Matching files and directories located in the
directory of the FILE and in subdirectories below are ignored.
Globbing syntax is the same as the --exclude-from=FILE gitignore
syntax, but files and directories are excluded instead of only
files. Directories are specifically excluded when the glob ends in
a `/'. Files and directories explicitly specified as command line
arguments are never ignored. This option may be repeated to
specify additional files.
-g GLOBS, --glob=GLOBS
Search only files whose name matches the specified comma-separated
list of GLOBS, same as --include='glob' for each `glob' in GLOBS.
When a `glob' is preceded by a `!' or a `^', skip files whose name
matches `glob', same as --exclude='glob'. When `glob' contains a
`/', full pathnames are matched. Otherwise basenames are matched.
When `glob' ends with a `/', directories are matched, same as
--include-dir='glob' and --exclude-dir='glob'. A leading `/'
matches the working directory. This option may be repeated and may
be combined with options -M, -O and -t to expand searches. See
`ugrep --help globs' and `man ugrep' section GLOBBING for details.
-O EXTENSIONS, --file-extension=EXTENSIONS
Search only files whose filename extensions match the specified
comma-separated list of EXTENSIONS, same as --include='*.ext' for
each `ext' in EXTENSIONS. When `ext' is preceded by a `!' or a
`^', skip files whose filename extensions matches `ext', same as
--exclude='*.ext'. This option may be repeated and may be combined
with options -g, -M and -t to expand the recursive search.
-t TYPES, --file-type=TYPES
Search only files associated with TYPES, a comma-separated list of
file types. Each file type corresponds to a set of filename
extensions passed to option -O and filenames passed to option -g.
For capitalized file types, the search is expanded to include files
with matching file signature magic bytes, as if passed to option
-M. When a type is preceded by a `!' or a `^', excludes files of
the specified type. This option may be repeated.
--stats
Output statistics on the number of files and directories searched,
and the inclusion and exclusion constraints applied.
ประเภทไฟล์จะอยู่ในรายการด้วย ugrep -tlist รายการจะขึ้นอยู่กับส่วนขยายชื่อไฟล์ที่กำหนดไว้และ "Magic Bytes" หากคุณมีประเภทไฟล์ที่ไม่อยู่ในรายการให้ใช้ตัวเลือก -O และ/หรือ -M คุณอาจต้องการกำหนดนามแฝงเช่น alias ugft='ugrep -Oft' เป็นชวเลขเพื่อค้นหาไฟล์ด้วยชื่อไฟล์ filename .ft
ในการแสดงคำจำกัดความของฟังก์ชั่นซ้ำในไฟล์ C/C ++ ( .h , .hpp , .c , .cpp ฯลฯ ) ด้วยหมายเลขบรรทัดที่มี -tc++ , -o , -n และ -f c++/functions :
ug -on -tc++ -f c++/functions
ในการแสดงคำจำกัดความของฟังก์ชั่นซ้ำในไฟล์ .c และ .cpp พร้อมหมายเลขบรรทัดด้วย -Oc,cpp , -o , -n และ -f c++/functions :
ug -on -Oc,cpp -f c++/functions
หากต้องการแสดงรายการไฟล์เชลล์ทั้งหมดด้วย -tShell เพื่อจับคู่ส่วนขยายชื่อไฟล์และไฟล์กับเชลล์ shebangs ยกเว้นไฟล์ที่มีคำต่อท้าย .sh :
ug -l -tShell -O^sh ''
เพื่อแสดงรายการไฟล์ที่ไม่ใช่เปลือกทั้งหมดด้วย -t^Shell :
ug -l -t^Shell ''
หากต้องการแสดงรายการไฟล์เชลล์ทั้งหมดที่มีเชลล์ shebangs ที่ไม่มีส่วนขยายชื่อของเชลล์:
ug -l -tShell -t^shell ''
ในการค้นหาบรรทัดที่มี FIXME ในความคิดเห็น C/C ++ ไม่รวม FIXME ในสตริงหลายบรรทัด:
ug -n 'FIXME' -f c++/zap_strings myfile.cpp
ในการอ่านรูปแบบ TODO และ FIXME จากอินพุตมาตรฐานเพื่อจับคู่บรรทัดในอินพุตในขณะที่ไม่รวมการจับคู่ในสตริง C ++:
ug -on -f - -f c++/zap_strings myfile.cpp <<END
TODO
FIXME
END
ในการแสดงองค์ประกอบ XML และแท็กแอตทริบิวต์ในไฟล์ XML จำกัด อยู่ที่ส่วนที่ตรงกันด้วย -o ไม่รวมแท็กที่อยู่ในความคิดเห็น (หลายบรรทัด):
ug -o -f xml/tags -f xml/zap_comments myfile.xml
- กลับไปที่สารบัญ
-z, --decompress
Search compressed files and archives. Archives (.cpio, .pax, .tar)
and compressed archives (e.g. .zip, .7z, .taz, .tgz, .tpz, .tbz,
.tbz2, .tb2, .tz2, .tlz, .txz, .tzst) are searched and matching
pathnames of files in archives are output in braces. When used
with option --zmax=NUM, searches the contents of compressed files
and archives stored within archives up to NUM levels. If -g, -O,
-M, or -t is specified, searches files stored in archives whose
filenames match globs, match filename extensions, match file
signature magic bytes, or match file types, respectively.
Supported compression formats: gzip (.gz), compress (.Z), zip, 7z,
bzip2 (requires suffix .bz, .bz2, .bzip2, .tbz, .tbz2, .tb2, .tz2),
lzma and xz (requires suffix .lzma, .tlz, .xz, .txz),
lz4 (requires suffix .lz4),
zstd (requires suffix .zst, .zstd, .tzst),
brotli (requires suffix .br),
bzip3 (requires suffix .bz3).
--zmax=NUM
When used with option -z (--decompress), searches the contents of
compressed files and archives stored within archives by up to NUM
expansion stages. The default --zmax=1 only permits searching
uncompressed files stored in cpio, pax, tar, zip and 7z archives;
compressed files and archives are detected as binary files and are
effectively ignored. Specify --zmax=2 to search compressed files
and archives stored in cpio, pax, tar, zip and 7z archives. NUM
may range from 1 to 99 for up to 99 decompression and de-archiving
steps. Increasing NUM values gradually degrades performance.
ไฟล์ที่ถูกบีบอัดด้วย gzip ( .gz ), บีบอัด ( .Z ), bzip2 ( .bz , .bz2 , .bzip2 ), lzma ( .lzma ), xz ( .xz ), lz4 ( .lz4 ), zstd ( .zst ,. .zstd ), brotli ( .br ) และ bzip3 ( .bz3 ) จะถูกค้นหาด้วยตัวเลือก -z เมื่อมีการติดตั้งและรวบรวมไลบรารีที่เกี่ยวข้องด้วย UGREP ตัวเลือกนี้ไม่ต้องการให้ไฟล์ถูกบีบอัด ไฟล์ที่ไม่ได้บีบอัดจะถูกค้นหาแม้ว่าจะช้าลง
รูปแบบการบีบอัดอื่น ๆ สามารถค้นหาได้ด้วยตัวกรอง UGREP
คลังเก็บ (CPIO, jar, pax, tar, zip และ 7z) ถูกค้นหาด้วยตัวเลือก -z ไฟล์ปกติในการเก็บถาวรที่ตรงกันคือเอาต์พุตด้วยชื่อพา ธ เก็บถาวรที่อยู่ในวงเล็บปีกกา { และ } รูปแบบ TAR ที่รองรับ ได้แก่ V7, USTAR, GNU, OLDGNU และ PAX รูปแบบ CPIO ที่รองรับคือ ODC, NEWC และ CRC ไม่ได้รับการสนับสนุนเป็นรูปแบบ CPIO แบบไบนารีเก่าที่ไม่สามารถพกพาได้ รูปแบบการเก็บถาวร CPIO, TAR และ PAX ได้รับการยอมรับโดยอัตโนมัติด้วยตัวเลือก -z ตามเนื้อหาของพวกเขาโดยไม่ขึ้นกับคำต่อท้ายชื่อไฟล์
โดยค่าเริ่มต้นจดหมายเหตุที่ไม่ได้บีบอัดที่เก็บไว้ในคลังเก็บซิปจะถูกค้นหาเช่นกัน: ไฟล์ CPIO, PAX และ TAR ทั้งหมดที่เก็บไว้ในคลังเก็บ zip และ 7Z จะได้รับการยอมรับและค้นหาโดยอัตโนมัติ อย่างไรก็ตามโดยค่าเริ่มต้นไฟล์ที่ถูกบีบอัดที่เก็บไว้ในคลังเก็บจะไม่ได้รับการยอมรับเช่นไฟล์ zip ที่เก็บไว้ในไฟล์ TAR จะไม่ถูกค้นหา แต่เป็นไฟล์ที่บีบอัดและจดหมายเหตุทั้งหมดจะถูกค้นหาราวกับว่าเป็นไฟล์ไบนารีโดยไม่ต้องบีบอัดไฟล์เหล่านั้น
ระบุ --zmax=NUM เพื่อค้นหาคลังเก็บที่มีไฟล์ที่บีบอัดและจดหมายเหตุสำหรับระดับสูงสุดถึง NUM ลึก ค่าของ NUM อาจอยู่ในช่วง 1 ถึง 99 สำหรับการบีบอัดสูงสุด 99 ขั้นตอนและขั้นตอนการยกเลิกการ จำกัด เพื่อขยายคลังเก็บซ้อนกันถึง 99 ค่าที่ใหญ่กว่า --zmax=NUM ลดประสิทธิภาพ ไม่น่าเป็นไปได้ที่คุณจะต้องใช้ 99 เป็น --zmax=2 พอเพียงสำหรับกรณีการใช้งานที่ใช้งานได้จริงที่สุดเช่นการค้นหาไฟล์ซิปที่เก็บไว้ในไฟล์ TAR
เมื่อตัวเลือก -z ถูกใช้กับตัวเลือก -g , -O , -M หรือ -t , คลังเก็บและไฟล์บีบอัดและไม่บีบอัดที่ตรงกับเกณฑ์การเลือกชื่อไฟล์ (GLOB, ส่วนขยาย, ไบต์เวทมนตร์หรือประเภทไฟล์) จะถูกค้นหาเท่านั้น ตัวอย่างเช่น ugrep -r -z -tc++ ค้นหาไฟล์ C ++ เช่น main.cpp และ ZIP และ TAR ที่เก็บถาวรที่มีไฟล์ C ++ เช่น main.cpp รวมอยู่ในการค้นหาคือไฟล์ C ++ ที่บีบอัดเช่น main.cpp.gz และ main.cpp.xz เมื่อมีอยู่ นอกจากนี้ยังมีการค้นหาไฟล์ CPIO, PAX, TAR, ZIP และ 7Z เมื่อมีการค้นหาไฟล์ C ++ ที่มีอยู่เช่น main.cpp ใช้ตัวเลือก --stats เพื่อดูรายการรูปแบบลูกโลกที่ใช้กับตัวกรองชื่อพา ธ ไฟล์ในการค้นหาแบบเรียกซ้ำและเมื่อค้นหาเนื้อหาที่เก็บถาวร
เมื่อตัวเลือก -z ถูกใช้กับตัวเลือก -g , -O , -M หรือ -t เพื่อค้นหา cpio, jar, pax, tar, zip และ 7z, ไฟล์เก็บถาวรที่ตรงกับเกณฑ์การเลือกชื่อไฟล์จะถูกค้นหาเท่านั้น
รูปแบบ GZIP, การบีบอัดและซิปถูกตรวจพบโดยอัตโนมัติซึ่งมีประโยชน์เมื่ออ่านข้อมูลที่บีบอัด GZIP จากอินพุตมาตรฐานเช่นอินพุตที่เปลี่ยนเส้นทางจากท่อ รูปแบบการบีบอัดอื่น ๆ ต้องใช้คำต่อท้ายชื่อไฟล์: .bz , .bz2 หรือ .bzip2 สำหรับ BZIP2, .lzma สำหรับ LZMA, .xz สำหรับ XZ, .lz4 สำหรับ LZ4, .zst หรือ .zstd สำหรับ ZSTD, .br สำหรับ Brotli และ .bz3 สำหรับ BZIP3 นอกจากนี้การบีบอัด TAR Archive Shorthands .taz , .tgz และ .tpz สำหรับ gzip, .tbz , .tbz2 , .tb2 และ .tz2 สำหรับ bzip2, .tlz สำหรับ lzma, .txz สำหรับ XZ และ .tzst สำหรับ ZSTD ได้รับการยอมรับ ในการค้นหารูปแบบเหล่านี้ด้วย UGREP จากอินพุตมาตรฐานให้ใช้ตัวเลือก --label='stdin.bz2' สำหรับ bzip2, --label='stdin.lzma' สำหรับ lzma, --label='stdin.xz' สำหรับ xz, --label='stdin.lz4 สำหรับ lz4 และ --label='stdin.zst สำหรับ zstd และอื่น ๆ ชื่อ stdin นั้นเป็นไปโดยพลการและอาจถูกละเว้น:
| รูปแบบ | ชื่อไฟล์ | TAR/PAX คลังเก็บสั้น ๆ | คำต่อท้ายที่ต้องการ? | Ugrep จาก stdin | ห้องสมุด |
|---|---|---|---|---|---|
| GZIP | .gz | .taz , .tgz , .tpz | เลขที่ | อัตโนมัติ | libz |
| บีบอัด | .Z | .taZ , .tZ | เลขที่ | อัตโนมัติ | ในตัว |
| ซิป | .zip , .zipx , .ZIP | เลขที่ | อัตโนมัติ | libz | |
| 7zip | .7z | ใช่ | --label=.7z | ในตัว | |
| BZIP2 | .bz , .bz2 , .bzip2 | .tb2 , .tbz , .tbz2 , .tz2 | ใช่ | --label=.bz2 | libbz2 |
| lzma | .lzma | .tlz | ใช่ | --label=.lzma | liblzma |
| XZ | .xz | .txz | ใช่ | --label=.xz | liblzma |
| LZ4 | .lz4 | ใช่ | --label=.lz4 | liblz4 | |
| zstd | .zst , .zstd | .tzst | ใช่ | --label=.zst | libzstd |
| Brotli | .br | ใช่ | --label=.br | libbrotlidec | |
| BZIP3 | .bz3 | ใช่ | --label=.bz3 | libbzip3 |
รูปแบบ GZIP, BZIP2, XZ, LZ4 และ ZSTD รองรับไฟล์บีบอัดที่ต่อกัน ไฟล์ที่ถูกบีบอัดแบบต่อเนื่องจะถูกค้นหาเป็นไฟล์เดียว
วิธีการบีบอัด ZIP ที่รองรับจะถูกเก็บไว้ (0), deflate (8), BZIP2 (12), LZMA (14), XZ (95) และ ZSTD (93) วิธี BZIP2, LZMA, XZ และ ZSTD ต้องการ UGREP ที่จะรวบรวมด้วยไลบรารีการบีบอัดที่สอดคล้องกัน
การค้นหาคลังเก็บซิปที่เข้ารหัสไม่ได้รับการสนับสนุน (อาจจะอยู่ในรุ่นอนาคตขึ้นอยู่กับคำขอสำหรับการปรับปรุง)
การค้นหาเอกสารสำคัญ 7ZIP ใช้เวลามากขึ้นและมีเวลามากขึ้นเมื่อเทียบกับวิธีอื่น ๆ การใช้งาน 7ZIP LZMA SDK ไม่สนับสนุนการสตรีมซึ่งต้องใช้ไฟล์ 7Z ที่สามารถค้นหาได้ทางกายภาพ ซึ่งหมายความว่าไม่สามารถค้นหาไฟล์ 7Z เมื่อซ้อนกันภายในคลังเก็บ ดีที่สุดคือหลีกเลี่ยง 7ZIP การสนับสนุนสำหรับ 7ZIP สามารถปิดใช้งานได้ด้วย ./build.sh --disable-7zip เพื่อสร้าง Ugrep
ตัวเลือก -z ใช้เธรดสำหรับการขนานของงานเพื่อเพิ่มความเร็วในการค้นหาไฟล์ขนาดใหญ่โดยเรียกใช้ decompressor พร้อมกันด้วยการค้นหาสตรีมที่บีบอัด
หากต้องการแสดงรายการไฟล์ที่ไม่ว่างเปล่าทั้งหมดที่เก็บไว้ใน package.zip Archive รวมถึงเนื้อหาของไฟล์ CPIO, PAX, TAR, ZIP และ 7Z ทั้งหมดที่เก็บไว้ในนั้น:
ug --zmax=2 -z -l '' package.zip
เหมือนกัน แต่แสดงรายการไฟล์ซอร์ส Python เท่านั้นรวมถึงสคริปต์ที่เรียกใช้ Python พร้อมตัวเลือก -tPython ( ugrep -tlist สำหรับรายละเอียด):
ug --zmax=2 -z -l -tPython '' package.zip
ในการค้นหาแอปพลิเคชัน Python ที่แจกจ่ายเป็นไฟล์ TAR ที่มีการพึ่งพาของพวกเขารวมเป็นล้อ (ไฟล์ ZIP ที่มีรหัส Python) ค้นหาคำ my_class ใน app.tgz :
ug --zmax=2 -z -tPython -w my_class app.tgz
ในการค้นหาไฟล์ C ++ ซ้ำรวมถึงไฟล์ที่บีบอัดสำหรับคำ my_function ในขณะที่ข้ามความคิดเห็น C และ C ++:
ug -z -r -tc++ -Fw my_function -f cpp/zap_comments
ในการค้นหา BZIP2, LZMA, XZ, LZ4 และ ZSTD ข้อมูลบีบอัดบนอินพุตมาตรฐานตัวเลือก --label อาจถูกใช้เพื่อระบุส่วนขยายที่สอดคล้องกับรูปแบบการบีบอัดเพื่อบังคับการบีบอัดเมื่อส่วนขยาย BZIP2 ไม่สามารถใช้ได้กับ UGREP ตัวอย่างเช่น:
cat myfile.bz2 | ugrep -z --label='stdin.bz2' 'xyz'
ในการค้นหาไฟล์ main.cpp ใน project.zip สำหรับบรรทัด TODO และ FIXME :
ug -z -g main.cpp -w -e 'TODO' -e 'FIXME' project.zip
ในการค้นหา tarball project.tar.gz สำหรับไฟล์ C ++ พร้อมบรรทัด TODO และ FIXME :
ug -z -tc++ -w -e 'TODO' -e 'FIXME' project.tar.gz
ในการค้นหาไฟล์ที่ตรงกับ glob *.txt ใน project.zip สำหรับ license Word ในกรณีใด ๆ (โปรดทราบว่าต้องมีการอาร์กิวเมนต์ -g Glob
ug -z -g '*.txt' -w -i 'license' project.zip
ในการแสดงและหน้าผ่านไฟล์ C ++ ทั้งหมดใน tarball project.tgz :
ug --pager -z -tc++ '' project.tgz
ในการแสดงรายการไฟล์ที่ตรงกับ Gitignore-style glob /**/projects/project1.* ใน projects.tgz โดยเลือกไฟล์ที่มีอยู่ในคลังข้อความ December 12 :
ug -z -l -g '/**/projects/project1.*' -F 'December 12' projects.tgz
ในการดูข้อมูล meta -inf/manifest.mf ในไฟล์ jar ที่มี -Ojar และ -OMF เพื่อเลือกไฟล์ jar และไฟล์ MF ในนั้น ( -Ojar จำเป็น อินพุตมาตรฐานแทน):
ug -z -h -OMF,jar '' my.jar
ในการแยกไฟล์ C ++ ที่มี FIXME จาก project.tgz เราใช้ -m1 กับ --format="'%z '" เพื่อสร้างรายการชื่อพา ธ ของไฟล์ที่คั่นด้วยอวกาศที่อยู่ในคลังเก็บที่ตรงกับคำว่า FIXME :
tar xzf project.tgz `ugrep -z -l -tc++ --format='%z ' -w FIXME project.tgz`
ในการค้นหาอย่างลึกซึ้งด้วย find จากนั้นใช้ cpio และ ugrep เพื่อค้นหาไฟล์:
find . -depth -print | cpio -o | ugrep -z 'xyz'
- กลับไปที่สารบัญ
--ignore-files[=FILE]
Ignore files and directories matching the globs in each FILE that
is encountered in recursive searches. The default FILE is
`.gitignore'. Matching files and directories located in the
directory of the FILE and in subdirectories below are ignored.
Globbing syntax is the same as the --exclude-from=FILE gitignore
syntax, but files and directories are excluded instead of only
files. Directories are specifically excluded when the glob ends in
a `/'. Files and directories explicitly specified as command line
arguments are never ignored. This option may be repeated to
specify additional files.
-M MAGIC, --file-magic=MAGIC
Only files matching the signature pattern MAGIC are searched. The
signature "magic bytes" at the start of a file are compared to
the MAGIC regex pattern. When matching, the file will be searched.
When MAGIC is preceded by a `!' or a `^', skip files with matching
MAGIC signatures. This option may be repeated and may be combined
with options -O and -t to expand the search. Every file on the
search path is read, making searches potentially more expensive.
-O EXTENSIONS, --file-extension=EXTENSIONS
Search only files whose filename extensions match the specified
comma-separated list of EXTENSIONS, same as --include='*.ext' for
each `ext' in EXTENSIONS. When `ext' is preceded by a `!' or a
`^', skip files whose filename extensions matches `ext', same as
--exclude='*.ext'. This option may be repeated and may be combined
with options -g, -M and -t to expand the recursive search.
-t TYPES, --file-type=TYPES
Search only files associated with TYPES, a comma-separated list of
file types. Each file type corresponds to a set of filename
extensions passed to option -O and filenames passed to option -g.
For capitalized file types, the search is expanded to include files
with matching file signature magic bytes, as if passed to option
-M. When a type is preceded by a `!' or a `^', excludes files of
the specified type. This option may be repeated.
-g GLOBS, --glob=GLOBS
Search only files whose name matches the specified comma-separated
list of GLOBS, same as --include='glob' for each `glob' in GLOBS.
When a `glob' is preceded by a `!' or a `^', skip files whose name
matches `glob', same as --exclude='glob'. When `glob' contains a
`/', full pathnames are matched. Otherwise basenames are matched.
When `glob' ends with a `/', directories are matched, same as
--include-dir='glob' and --exclude-dir='glob'. A leading `/'
matches the working directory. This option may be repeated and may
be combined with options -M, -O and -t to expand searches. See
`ugrep --help globs' and `man ugrep' section GLOBBING for details.
--stats
Output statistics on the number of files and directories searched,
and the inclusion and exclusion constraints applied.
เพื่อแสดงรายการไฟล์ทั้งหมดที่เริ่มต้นด้วย #! Shebangs:
ug -l -M'#!' ''
หากต้องการแสดงรายการไฟล์ทั้งหมดที่เริ่มต้นด้วย # แต่ไม่ใช่ด้วย #! Shebangs:
ug -l -M'#' -M'^#!' ''
หากต้องการแสดงรายการไฟล์ Python ทั้งหมด (ส่วนขยาย .py หรือ shebang) ด้วย -tPython :
ug -l -tPython ''
เพื่อแสดงรายการไฟล์ที่ไม่ใช่เปลือกทั้งหมดด้วย -t^Shell :
ug -l -t^Shell ''
To recursively list Python files (extension .py or a shebang) that have import statements, including hidden files with -. -
ug -l. -tPython -f python/imports
- Back to table of contents
-Z[best][+-~][MAX], --fuzzy=[best][+-~][MAX]
Fuzzy mode: report approximate pattern matches within MAX errors.
The default is -Z1: one deletion, insertion or substitution is
allowed. If `+`, `-' and/or `~' is specified, then `+' allows
insertions, `-' allows deletions and `~' allows substitutions. For
example, -Z+~3 allows up to three insertions or substitutions, but
no deletions. If `best' is specified, then only the best matching
lines are output with the lowest cost per file. Option -Zbest
requires two passes over a file and cannot be used with standard
input or Boolean queries. Option --sort=best orders matching files
by best match. The first character of an approximate match always
matches a character at the beginning of the pattern. To fuzzy
match the first character, replace it with a `.' or `.?'. Option
-U applies fuzzy matching to ASCII and bytes instead of Unicode
text. No whitespace may be given between -Z and its argument.
The beginning of a pattern always matches the first character of an approximate match as a practical strategy to prevent many false "randomized" matches for short patterns. This also greatly improves search speed. Make the first character optional to optionally match it, eg p?attern or use a dot as the start of the pattern to match any wide character (but this is slow).
Line feed ( n ) and NUL ( ) characters are never deleted or substituted to ensure that fuzzy matches do not extend the pattern match beyond the number of lines specified by the regex pattern.
Option -U ( --ascii or --binary ) restricts fuzzy matches to ASCII and binary only with edit distances measured in bytes. Otherwise, fuzzy pattern matching is performed with Unicode patterns and edit distances are measured in Unicode characters.
Option --sort=best orders files by best match. Files with at least one exact match anywhere in the file are shown first, followed by files with approximate matches in increasing minimal edit distance order. That is, ordered by the minimum error (edit distance) found among all approximate matches per file.
To recursively search for approximate matches of the word foobar with -Z , ie approximate matching with one error, eg Foobar , foo_bar , foo bar , fobar and other forms with one missing, one extra or one deleted character:
ug -Z 'foobar'
Same, but matching words only with -w and ignoring case with -i :
ug -Z -wi 'foobar'
Same, but permit up to 2 insertions with -Z+2 , no deletions/substitutions (matches up to 2 extra characters, such as foos bar ), insertions-only offers the fastest fuzzy matching method:
ug -Z+3 -wi 'foobar'
Same, but sort matches from best (at least one exact match or fewest fuzzy match errors) to worst:
ug -Z+3 -wi --sort=best 'foobar'
Note: because sorting by best match requires two passes over the input files, the efficiency of concurrent searching is significantly reduced.
Same, but with customized formatting to show the edit distance "cost" of the approximate matches with format field %Z and %F to show the pathname:
ug -Z+3 -wi --format='%F%Z:%O%~' --sort=best 'foobar'
Same, but this time count the matches with option -c and display them with a custom format using %m , where %Z is the average cost per match:
ug -c -Z+3 -wi --format='%F%Z:%m%~' --sort=best 'foobar'
Note: options -c and -l do not report a meaningful %Z value in the --format output, because %Z is the edit distance cost of a single match.
- Back to table of contents
--hidden, -.
Search hidden files and directories.
To recursively search the working directory, including hidden files and directories, for the word login in shell scripts:
ug -. -tShell 'login'
- Back to table of contents
--filter=COMMANDS
Filter files through the specified COMMANDS first before searching.
COMMANDS is a comma-separated list of `exts:command [option ...]',
where `exts' is a comma-separated list of filename extensions and
`command' is a filter utility. Files matching one of `exts' are
filtered. When `exts' is a `*', all files are filtered. One or
more `option' separated by spacing may be specified, which are
passed verbatim to the command. A `%' as `option' expands into the
pathname to search. For example, --filter='pdf:pdftotext % -'
searches PDF files. The `%' expands into a `-' when searching
standard input. When a `%' is not specified, a filter utility
should read from standard input and write to standard output.
Option --label=.ext may be used to specify extension `ext' when
searching standard input. This option may be repeated.
--filter-magic-label=LABEL:MAGIC
Associate LABEL with files whose signature "magic bytes" match the
MAGIC regex pattern. Only files that have no filename extension
are labeled, unless +LABEL is specified. When LABEL matches an
extension specified in --filter=COMMANDS, the corresponding command
is invoked. This option may be repeated.
The --filter option associates one or more filter utilities with specific filename extensions. A filter utility is selected based on the filename extension and executed by forking a process: the utility's standard input reads the open input file and the utility's standard output is searched. When a % is specified as an option to the utility, the % is expanded to the pathname of the file to open and read by the utility.
When a specified utility is not found on the system, an error message is displayed. When a utility fails to produce output, eg when the specified options for the utility are invalid, the search is silently skipped.
Filtering does not apply to files stored in archives and compressed files. A filter is usually applied to a file that is physically stored in the file system. Archived files are not physically stored.
Common filter utilities are cat (concat, pass through), head (select first lines or bytes) tr (translate), iconv and uconv (convert), and more advanced utilities, such as:
pdftotext to convert pdf to textantiword to convert doc to textpandoc to convert .docx, .epub, and other document formatsexiftool to read meta information embedded in image and video media formats.soffice to convert office documentscsvkit to convert spreadsheetsopenssl to convert certificates and key files to text and other formats The ugrep+ and ug+ commands use the pdftotext , antiword , pandoc and exiftool filters, when installed, to search pdfs, documents, e-books, and image metadata.
Also decompressors may be used as filter utilities, such as unzip , gunzip , bunzip2 , unlzma , unxz , lzop and 7z that decompress files to standard output when option --stdout is specified. ตัวอย่างเช่น:
ug --filter='lzo:lzop -d --stdout -' ...
ug --filter='gz:gunzip -d --stdout -' ...
ug --filter='7z:7z x -so %' ...
The --filter='lzo:lzop -d --stdout -' option decompresses files with extension lzo to standard output with --stdout with the compressed stream being read from standard input with - . The --filter='7z:7z x -so -si option decompresses files with extension 7z to standard output -so while reading standard input -si with the compressed file contents.
Note that ugrep option -z is typically faster to search compressed files compared to --filter .
The --filter option may also be used to run a user-defined shell script to filter files. For example, to invoke an action depending on the filename extension of the % argument. Another use case is to pass a file to more than one filter, which can be accomplished with a shell script containing the line tool1 $1; tool2 $1 . This filters the file argument $1 with tool1 followed by tool2 to produce combined output to search for pattern matches. Likewise, we can use a script with the line tool1 $1 | tool2 to stack two filters tool1 and tool2 .
The --filter option may also be used as a predicate to skip certain files from the search. As the most basic example, consider the false utility that exits with a nonzero exit code without reading input or producing output. Therefore, --filter='swp: false' skips all .swp files from recursive searches. The same can be done more efficiently with -O^swp . However, the --filter option could invoke a script that determines if the filename passed as a % argument meets certain constraints. If the constraint is met the script copies standard input to standard output with cat . If not, the script exits.
Warning: option --filter should not be used with utilities that modify files. Otherwise searches may be unpredicatable. In the worst case files may be lost, for example when the specified utility replaces or deletes the file passed to the command with --filter option % .
To recursively search files including PDF files in the working directory without recursing into subdirectories (with -1 ), for matches of drink me using the pdftotext filter to convert PDF to text without preserving page breaks:
ug -r -1 --filter='pdf:pdftotext -nopgbrk % -' 'drink me'
To recursively search text files for eat me while converting non-printable characters in .txt and .md files using the cat -v filter:
ug -r -ttext --filter='txt,md:cat -v' 'eat me'
The same, but specifying the .txt and .md filters separately:
ug -r -ttext --filter='txt:cat -v, md:cat -v' 'eat me'
To search the first 8K of a text file:
ug --filter='txt:head -c 8192' 'eat me' wonderland.txt
To recursively search and list the files that contain the word Alice , including .docx and .epub documents using the pandoc filter:
ug -rl -w --filter='docx,epub:pandoc --wrap=preserve -t plain % -o -' 'Alice'
Important: the pandoc utility requires an input file and will not read standard input. Option % expands into the full pathname of the file to search. The output format specified is markdown , which is close enough to text to be searched.
To recursively search and list the files that contain the word Alice , including .odt, .doc, .docx, .rtf, .xls, .xlsx, .ppt, .pptx documents using the soffice filter:
ug -rl -w --filter='odt,doc,docx,rtf,xls,xlsx,ppt,pptx:soffice --headless --cat %' 'Alice'
Important: the soffice utility will not output any text when one or more LibreOffice GUIs are open. Make sure to quit all LibreOffice apps first. This looks like a bug, but the LibreOffice developers do not appear to fix this any time soon (unless perhaps more people complain?). You can work around this problem by specifying a specific user profile for soffice with the following semi-documented argument passed to soffice : -env:UserInstallation=file:///home/user/.libreoffice-alt .
To recursively search and display rows of .csv, .xls, and .xlsx spreadsheets that contain 10/6 using the in2csv filter of csvkit:
ug -r -Ocsv,xls,xlsx --filter='xls,xlsx:in2csv %' '10/6'
To search .docx, .xlsx, and .pptx files converted to XML for a match with 10/6 using unzip as a filter:
ug -lr -Odocx,xlsx,pptx --filter='docx,xlsx,pptx:unzip -p %' '10/6'
Important: unzipping docx, xlxs, pptx files produces extensive XML output containing meta information and binary data such as images. By contrast, ugrep option -z with -Oxml selects the XML components only:
ug -z -lr -Odocx,xlsx,pptx,xml '10/6'
Note: docx, xlsx, and pptx are zip files containing multiple components. When selecting the XML components with option -Oxml in docx, xlsx, and pptx documents, we should also specify -Odocx,xlsx,pptx to search these type of files, otherwise these files will be ignored.
To recurssively search X509 certificate files for lines with Not After (eg to find expired certificates), using openssl as a filter:
ug -r 'Not After' -Ocer,der,pem --filter='pem:openssl x509 -text,cer,crt,der:openssl x509 -text -inform der'
Note that openssl warning messages are displayed on standard error. If a file cannot be converted it is probably in a different format. This can be resolved by writing a shell script that executes openssl with options based on the file content. Then write a script with ugrep --filter .
To search PNG files by filename extension with -tpng using exiftool :
ug -r -i 'copyright' -tpng --filter='*:exiftool %'
Same, but also include files matching PNG "magic bytes" with -tPng and --filter-magic-label='+png:x89pngx0dx0ax1ax0a' to select the png filter:
ug -r -i 'copyright' -tPng --filter='png:exiftool %' --filter-magic-label='+png:x89pngx0dx0ax1ax0a'
Note that +png overrides any filename extension match for --filter . Otherwise, without a + , the filename extension, when present, takes priority over labelled magic patterns to invoke the corresponding filter command. The LABEL used with --filter-magic-label and --filter has no specific meaning; any name or string that does not contain a : or , may be used.
- Back to table of contents
--hexdump[=[1-8][a][bch][A[NUM]][B[NUM]][C[NUM]]]
Output matches in 1 to 8 columns of 8 hexadecimal octets. The
default is 2 columns or 16 octets per line. Argument `a' outputs a
`*' for all hex lines that are identical to the previous hex line,
`b' removes all space breaks, `c' removes the character column, `h'
removes hex spacing, `A' includes up to NUM hex lines after a
match, `B' includes up to NUM hex lines before a match and `C'
includes up to NUM hex lines before and after a match. Arguments
`A', `B' and `C' are the same as options -A, -B and -C when used
with --hexdump. See also options -U, -W and -X.
-U, --ascii, --binary
Disables Unicode matching for binary file matching, forcing PATTERN
to match bytes, not Unicode characters. For example, -U 'xa3'
matches byte A3 (hex) instead of the Unicode code point U+00A3
represented by the UTF-8 sequence C2 A3. See also --dotall.
-W, --with-hex
Output binary matches in hexadecimal, leaving text matches alone.
This option is equivalent to the --binary-files=with-hex option.
To omit the matching line from the hex output, use both options -W
and --hexdump. See also options -U.
-X, --hex
Output matches and matching lines in hexadecimal. This option is
equivalent to the --binary-files=hex option. To omit the matching
line from the hex output use option --hexdump. See also option -U.
--dotall
Dot `.' in regular expressions matches anything, including newline.
Note that `.*' matches all input and should not be used.
Note that --hexdump differs from -X by omitting the matching line from the hex output, showing only the matching pattern using a minimal number of hex lines. Additional match context hex lines are output with the -ABC context options or with --hexdump=C3 to output 3 hex lines as context, for example.
To search a file for ASCII words, displaying text lines as usual while binary content is shown in hex with -U and -W :
ug -UW 'w+' myfile
To hexdump an entire file as a match with -X :
ug -X '' myfile
To hexdump an entire file with -X , displaying line numbers and byte offsets with -nb (here with -y to display all line numbers):
ug -Xynb '' myfile
To hexdump lines containing one or more in a (binary) file using a non-Unicode pattern with -U and -X :
ug -UX 'x00+' myfile
Same, but hexdump the entire file as context with -y (note that this line-based option does not permit matching patterns with newlines):
ug -UX -y 'x00+' myfile
Same, compacted to 32 bytes per line without the character column:
ug -UX -y 'x00+' myfile
To match the binary pattern A3..A3. (hex) in a binary file without Unicode pattern matching (which would otherwise match xaf as a Unicode character U+00A3 with UTF-8 byte sequence C2 A3) and display the results in compact hex with --hexdump with pager:
ug --pager --hexdump -U 'xa3[x00-xff]{2}xa3[x00-xff]' a.out
Same, but using option --dotall to let . match any byte, including newline that is not matched by dot (the default as required by grep):
ug --dotall --pager --hexdump -U 'xa3.{2}xa3.' a.out
To list all files containing a RPM signature, located in the rpm directory and recursively below (see for example list of file signatures):
ug -RlU 'Axedxabxeexdb' rpm
- Back to table of contents
-I Ignore matches in binary files. This option is equivalent to the
--binary-files=without-match option.
To recursively search without following symlinks and ignoring binary files:
ug -rl -I 'xyz'
To ignore specific binary files with extensions such as .exe, .bin, .out, .a, use --exclude or --exclude-from :
ug -rl --exclude-from=ignore_binaries 'xyz'
where ignore_binaries is a file containing a glob on each line to ignore matching files, eg *.exe , *.bin , *.out , *.a . Because the command is quite long to type, an alias for this is recommended, for example ugs (ugrep source):
alias ugs="ugrep --exclude-from=~/ignore_binaries"
ugs -rl 'xyz'
- Back to table of contents
--ignore-files[=FILE]
Ignore files and directories matching the globs in each FILE that
is encountered in recursive searches. The default FILE is
`.gitignore'. Matching files and directories located in the
directory of the FILE and in subdirectories below are ignored.
Globbing syntax is the same as the --exclude-from=FILE gitignore
syntax, but files and directories are excluded instead of only
files. Directories are specifically excluded when the glob ends in
a `/'. Files and directories explicitly specified as command line
arguments are never ignored. This option may be repeated to
specify additional files.
Option --ignore-files looks for .gitignore , or the specified FILE , in recursive searches. When .gitignore , or the specified FILE , is found while traversing directory tree branches down, the .gitignore file is used to temporarily extend the previous exclusions with the additional globs in .gitignore to apply the combined exclusions to the directory tree rooted at the .gitignore location. Use --stats to show the selection criteria applied to the search results and the locations of each FILE found. To avoid confusion, files and directories specified as command-line arguments to ugrep are never ignored.
Note that exclude glob patterns take priority over include glob patterns when specified with command line options. By contrast, negated glob patterns specified with ! in --ignore-files files take priority. This effectively overrides the exclusions and resolves conflicts in favor of listing matching files that are explicitly specified as exceptions and should be included in the search.
See also Using gitignore-style globs to select directories and files to search.
To recursively search without following symlinks, while ignoring files and directories ignored by .gitignore (when present), use option --ignore-files . Note that -r is the default when no FILE arguments are specified, we use it here to make the examples easier to follow.
ug -rl --ignore-files 'xyz'
Same, but includes hidden files with -. rather than ignoring them:
ug -rl. --ignore-files 'xyz'
To recursively list all files that are not ignored by .gitignore (when present) with --ignore-files :
ug -rl --ignore-files ''
Same, but list shell scripts that are not ignored by .gitignore, when present:
ug -rl -tShell '' --ignore-files
To recursively list all files that are not ignored by .gitignore and are also not excluded by .git/info/exclude :
ug -rl '' --ignore-files --exclude-from=.git/info/exclude
Same, but by creating a symlink to .git/info/exclude to make the exclusions implicit:
ln -s .git/info/exclude .ignore
ug -rl '' --ignore-files --ignore-files=.ignore
- Back to table of contents
-g GLOBS, --glob=GLOBS
Search only files whose name matches the specified comma-separated
list of GLOBS, same as --include='glob' for each `glob' in GLOBS.
When a `glob' is preceded by a `!' or a `^', skip files whose name
matches `glob', same as --exclude='glob'. When `glob' contains a
`/', full pathnames are matched. Otherwise basenames are matched.
When `glob' ends with a `/', directories are matched, same as
--include-dir='glob' and --exclude-dir='glob'. A leading `/'
matches the working directory. This option may be repeated and may
be combined with options -M, -O and -t to expand searches. See
`ugrep --help globs' and `man ugrep' section GLOBBING for details.
--exclude=GLOB
Skip files whose name matches GLOB using wildcard matching, same as
-g ^GLOB. GLOB can use **, *, ?, and [...] as wildcards, and \ to
quote a wildcard or backslash character literally. When GLOB
contains a `/', full pathnames are matched. Otherwise basenames
are matched. When GLOB ends with a `/', directories are excluded
as if --exclude-dir is specified. Otherwise files are excluded.
Note that --exclude patterns take priority over --include patterns.
GLOB should be quoted to prevent shell globbing. This option may
be repeated.
--exclude-dir=GLOB
Exclude directories whose name matches GLOB from recursive
searches, same as -g ^GLOB/. GLOB can use **, *, ?, and [...] as
wildcards, and \ to quote a wildcard or backslash character
literally. When GLOB contains a `/', full pathnames are matched.
Otherwise basenames are matched. Note that --exclude-dir patterns
take priority over --include-dir patterns. GLOB should be quoted
to prevent shell globbing. This option may be repeated.
--exclude-from=FILE
Read the globs from FILE and skip files and directories whose name
matches one or more globs. A glob can use **, *, ?, and [...] as
wildcards, and to quote a wildcard or backslash character
literally. When a glob contains a `/', full pathnames are matched.
Otherwise basenames are matched. When a glob ends with a `/',
directories are excluded as if --exclude-dir is specified.
Otherwise files are excluded. A glob starting with a `!' overrides
previously-specified exclusions by including matching files. Lines
starting with a `#' and empty lines in FILE are ignored. When FILE
is a `-', standard input is read. This option may be repeated.
--ignore-files[=FILE]
Ignore files and directories matching the globs in each FILE that
is encountered in recursive searches. The default FILE is
`.gitignore'. Matching files and directories located in the
directory of the FILE and in subdirectories below are ignored.
Globbing syntax is the same as the --exclude-from=FILE gitignore
syntax, but files and directories are excluded instead of only
files. Directories are specifically excluded when the glob ends in
a `/'. Files and directories explicitly specified as command line
arguments are never ignored. This option may be repeated to
specify additional files.
--include=GLOB
Search only files whose name matches GLOB using wildcard matching,
same as -g GLOB. GLOB can use **, *, ?, and [...] as wildcards,
and \ to quote a wildcard or backslash character literally. When
GLOB contains a `/', full pathnames are matched. Otherwise
basenames are matched. When GLOB ends with a `/', directories are
included as if --include-dir is specified. Otherwise files are
included. Note that --exclude patterns take priority over
--include patterns. GLOB should be quoted to prevent shell
globbing. This option may be repeated.
--include-dir=GLOB
Only directories whose name matches GLOB are included in recursive
searches, same as -g GLOB/. GLOB can use **, *, ?, and [...] as
wildcards, and \ to quote a wildcard or backslash character
literally. When GLOB contains a `/', full pathnames are matched.
Otherwise basenames are matched. Note that --exclude-dir patterns
take priority over --include-dir patterns. GLOB should be quoted
to prevent shell globbing. This option may be repeated.
--include-from=FILE
Read the globs from FILE and search only files and directories
whose name matches one or more globs. A glob can use **, *, ?, and
[...] as wildcards, and to quote a wildcard or backslash
character literally. When a glob contains a `/', full pathnames
are matched. Otherwise basenames are matched. When a glob ends
with a `/', directories are included as if --include-dir is
specified. Otherwise files are included. A glob starting with a
`!' overrides previously-specified inclusions by excluding matching
files. Lines starting with a `#' and empty lines in FILE are
ignored. When FILE is a `-', standard input is read. This option
may be repeated.
-O EXTENSIONS, --file-extension=EXTENSIONS
Search only files whose filename extensions match the specified
comma-separated list of EXTENSIONS, same as --include='*.ext' for
each `ext' in EXTENSIONS. When `ext' is preceded by a `!' or a
`^', skip files whose filename extensions matches `ext', same as
--exclude='*.ext'. This option may be repeated and may be combined
with options -g, -M and -t to expand the recursive search.
--stats
Output statistics on the number of files and directories searched,
and the inclusion and exclusion constraints applied.
See also Including or excluding mounted file systems from searches.
Gitignore-style glob syntax and conventions:
| ลวดลาย | ไม้ขีด |
|---|---|
* | anything except / |
? | any one character except / |
[abc-e] | one character a , b , c , d , e |
[^abc-e] | one character not a , b , c , d , e , / |
[!abc-e] | one character not a , b , c , d , e , / |
/ | when used at the start of a glob, matches working directory |
**/ | zero or more directories |
/** | when at the end of a glob, matches everything after the / |
? | a ? or any other character specified after the backslash |
When a glob pattern contains a path separator / , the full pathname is matched. Otherwise the basename of a file or directory is matched in recursive searches. For example, *.h matches foo.h and bar/foo.h . bar/*.h matches bar/foo.h but not foo.h and not bar/bar/foo.h .
When a glob pattern begins with a / , files and directories are matched at the working directory, not recursively. For example, use a leading / to force /*.h to match foo.h but not bar/foo.h .
When a glob pattern ends with a / , directories are matched instead of files, same as --include-dir .
When a glob starts with a ! as specified with -g!GLOB , or specified in a FILE with --include-from=FILE or --exclude-from=FILE , it is negated.
To view a list of inclusions and exclusions that were applied to a search, use option --stats .
To list only readable files with names starting with foo in the working directory, that contain xyz , without producing warning messages with -s and -l :
ug -sl 'xyz' foo*
The same, but using deep recursion with inclusion constraints (note that -g'/foo* is the same as --include='/foo*' and -g'/foo*/' is the same as --include-dir='/foo*' , ie immediate subdirectories matching /foo* only):
ug -rl 'xyz' -g'/foo*' -g'/foo*/'
Note that -r is the default, we use it here to make the examples easier to follow.
To exclude directory bak located in the working directory:
ug -rl 'xyz' -g'^/bak/'
To exclude all directoies bak at any directory level deep:
ug -rl 'xyz' -g'^bak/'
To only list files in the working directory and its subdirectory doc , that contain xyz (note that -g'/doc/' is the same as --include-dir='/doc' , ie immediate subdirectory doc only):
ug -rl 'xyz' -g'/doc/'
To only list files that are on a subdirectory path doc that includes subdirectory html anywhere, that contain xyz :
ug -rl 'xyz' -g'doc/**/html/'
To only list files in the working directory and in the subdirectories doc and doc/latest but not below, that contain xyz :
ug -rl 'xyz' -g'/doc/' -g'/doc/latest/'
To recursively list .cpp files in the working directory and any subdirectory at any depth, that contain xyz :
ug -rl 'xyz' -g'*.cpp'
The same, but using a .gitignore-style glob that matches pathnames (globs with / ) instead of matching basenames (globs without / ) in the recursive search:
ug -rl 'xyz' -g'**/*.cpp'
Same, but using option -Ocpp to match file name extensions:
ug -rl -Ocpp 'xyz'
To recursively list all files in the working directory and below that are not ignored by a specific .gitignore file:
ug -rl '' --exclude-from=.gitignore
To recursively list all files in the working directory and below that are not ignored by one or more .gitignore files, when any are present:
ug -rl '' --ignore-files
- Back to table of contents
--exclude-fs=MOUNTS
Exclude file systems specified by MOUNTS from recursive searches.
MOUNTS is a comma-separated list of mount points or pathnames to
directories. When MOUNTS is not specified, only descends into the
file systems associated with the specified file and directory
search targets, i.e. excludes all other file systems. Note that
--exclude-fs=MOUNTS take priority over --include-fs=MOUNTS. This
option may be repeated.
--include-fs=MOUNTS
Only file systems specified by MOUNTS are included in recursive
searches. MOUNTS is a comma-separated list of mount points or
pathnames to directories. When MOUNTS is not specified, restricts
recursive searches to the file system of the working directory,
same as --include-fs=. (dot). Note that --exclude-fs=MOUNTS take
priority over --include-fs=MOUNTS. This option may be repeated.
These options control recursive searches across file systems by comparing device numbers. Mounted devices and symbolic links to files and directories located on mounted file systems may be included or excluded from recursive searches by specifying a mount point or a pathname of any directory on the file system to specify the applicable file system.
Note that a list of mounted file systems is typically stored in /etc/mtab .
To restrict recursive searches to the file system(s) of the search targets only, without crossing into other file systems (similar to find option -x ):
ug -rl --exclude-fs 'xyz' /sys /var
To restrict recursive searches to the file system of the working directory only, without crossing into other file systems:
ug -l --include-fs 'xyz'
In fact, for this case we can use --exclude-fs because we search the working directory as the target and we want to exclude all other file systems:
ug -l --exclude-fs 'xyz'
To exclude the file systems mounted at /dev and /proc from recursive searches:
ug -l --exclude-fs=/dev,/proc 'xyz'
To only include the file system associated with drive d: in recursive searches:
ug -l --include-fs=d:/ 'xyz'
To exclude fuse and tmpfs type file systems from recursive searches:
exfs=`ugrep -w -e fuse -e tmpfs /etc/mtab | ugrep -P '^S+ (S+)' --format='%,%1'`
ug -l --exclude-fs="$exfs" 'xyz'
- Back to table of contents
-c, --count
Only a count of selected lines is written to standard output.
If -o or -u is specified, counts the number of patterns matched.
If -v is specified, counts the number of non-matching lines. If
-m1, (with a comma or --min-count=1) is specified, counts only
matching files without outputting zero matches.
To count the number of lines in a file:
ug -c '' myfile.txt
To count the number of lines with TODO :
ug -c -w 'TODO' myfile.cpp
To count the total number of TODO in a file, use -c and -o :
ug -co -w 'TODO' myfile.cpp
To count the number of ASCII words in a file:
ug -co '[[:word:]]+' myfile.txt
To count the number of ASCII and Unicode words in a file:
ug -co 'w+' myfile.txt
To count the number of Unicode characters in a file:
ug -co 'p{Unicode}' myfile.txt
To count the number of zero bytes in a file:
ug -UX -co 'x00' image.jpg
- Back to table of contents
-b, --byte-offset
The offset in bytes of a matched line is displayed in front of the
respective matched line. When used with option -u, displays the
offset in bytes of each pattern matched. Byte offsets are exact
for ASCII, UTF-8, and raw binary input. Otherwise, the byte offset
in the UTF-8 converted input is displayed.
-H, --with-filename
Always print the filename with output lines. This is the default
when there is more than one file to search.
-k, --column-number
The column number of a matched pattern is displayed in front of the
respective matched line, starting at column 1. Tabs are expanded
when columns are counted, see option --tabs.
-n, --line-number
Each output line is preceded by its relative line number in the
file, starting at line 1. The line number counter is reset for
each file processed.
-T, --initial-tab
Add a tab space to separate the file name, line number, column
number, and byte offset with the matched line.
To display the file name -H , line -n , and column -k numbers of matches in myfile.cpp , with spaces and tabs to space the columns apart with -T :
ug -THnk 'main' myfile.cpp
To display the line with -n of word main in myfile.cpp :
ug -nw 'main' myfile.cpp
To display the entire file myfile.cpp with line -n numbers:
ug -n '' myfile.cpp
To recursively search for C++ files with main , showing the line and column numbers of matches with -n and -k :
ug -r -nk -tc++ 'main'
To display the byte offset of matches with -b :
ug -r -b -tc++ 'main'
To display the line and column numbers of matches in XML with --xml :
ug -r -nk --xml -tc++ 'main'
- Back to table of contents
--color[=WHEN], --colour[=WHEN]
Mark up the matching text with the expression stored in the
GREP_COLOR or GREP_COLORS environment variable. The possible
values of WHEN can be `never', `always', or `auto', where `auto'
marks up matches only when output on a terminal. The default is
`auto'.
--colors=COLORS, --colours=COLORS
Use COLORS to mark up text. COLORS is a colon-separated list of
one or more parameters `sl=' (selected line), `cx=' (context line),
`mt=' (matched text), `ms=' (match selected), `mc=' (match
context), `fn=' (file name), `ln=' (line number), `cn=' (column
number), `bn=' (byte offset), `se=' (separator), `qp=' (TUI
prompt), `qe=' (TUI errors), `qr=' (TUI regex), `qm=' (TUI regex
meta characters), `ql=' (TUI regex lists and literals), `qb=' (TUI
regex braces). Parameter values are ANSI SGR color codes or `k'
(black), `r' (red), `g' (green), `y' (yellow), `b' (blue), `m'
(magenta), `c' (cyan), `w' (white), or leave empty for no color.
Upper case specifies background colors. A `+' qualifies a color as
bright. A foreground and a background color may be combined with
font properties `n' (normal), `f' (faint), `h' (highlight), `i'
(invert), `u' (underline). Parameter `hl' enables file name
hyperlinks. Parameter `rv' reverses the `sl=' and `cx=' parameters
when option -v is specified. Selectively overrides GREP_COLORS.
Legacy grep single parameter codes may be specified, for example
--colors='7;32' or --colors=ig to set ms (match selected).
--tag[=TAG[,END]]
Disables colors to mark up matches with TAG. END marks the end of
a match if specified, otherwise TAG. The default is `___'.
--pager[=COMMAND]
When output is sent to the terminal, uses COMMAND to page through
the output. COMMAND defaults to environment variable PAGER when
defined or `less'. Enables --heading and --line-buffered.
--pretty[=WHEN]
When output is sent to a terminal, enables --color, --heading, -n,
--sort, --tree and -T when not explicitly disabled. WHEN can be
`never', `always', or `auto'. The default is `auto'.
--tree, -^
Output directories with matching files in a tree-like format for
option -c or --count, -l or --files-with-matches, -L or
--files-without-match. This option is enabled by --pretty when the
output is sent to a terminal.
To change the color palette, set the GREP_COLORS environment variable or use --colors=COLORS . The value is a colon-separated list of ANSI SGR parameters that defaults to cx=33:mt=1;31:fn=1;35:ln=1;32:cn=1;32:bn=1;32:se=36 :
| พารามิเตอร์ | ผลลัพธ์ |
|---|---|
sl= | selected lines |
cx= | context lines |
rv | Swaps the sl= and cx= capabilities when -v is specified |
mt= | matching text in any matching line |
ms= | matching text in a selected line. The substring mt= by default |
mc= | matching text in a context line. The substring mt= by default |
fn= | file names |
ln= | line numbers |
cn= | column numbers |
bn= | byte offsets |
se= | 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:
| รหัส | ค | ผล | รหัส | ค | ผล |
|---|---|---|---|---|---|
| 0 | n | normal font and color | 2 | ฉ | faint (not widely supported) |
| 1 | ชม. | highlighted bold font | 21 | ชม | highlighted bold off |
| 4 | คุณ | underline | 24 | คุณ | underline off |
| 7 | ฉัน | invert video | 27 | ฉัน | invert off |
| 30 | เค | black text | 90 | +k | bright gray text |
| 31 | ร | red text | 91 | +r | bright red text |
| 32 | ก | green text | 92 | +g | bright green text |
| 33 | ย | yellow text | 93 | +y | bright yellow text |
| 34 | ข | blue text | 94 | +b | bright blue text |
| 35 | ม | magenta text | 95 | +m | bright magenta text |
| 36 | ค | cyan text | 96 | +c | bright cyan text |
| 37 | ว | white text | 97 | +w | bright white text |
| 40 | เค | พื้นหลังสีดำ | 100 | +K | bright gray background |
| 41 | ร | dark red background | 101 | +R | bright red background |
| 42 | ช | dark green background | 102 | +G | bright green background |
| 43 | ย | dark yellow backgrounda | 103 | +Y | bright yellow background |
| 44 | บี | dark blue background | 104 | +บี | bright blue background |
| 45 | ม | dark magenta background | 105 | +M | bright magenta background |
| 46 | ค | dark cyan background | 106 | +C | bright cyan background |
| 47 | ว | dark white background | 107 | +W | bright white background |
See Wikipedia ANSI escape code - SGR parameters
For quick and easy color specification, the corresponding single-letter color names may be used in place of numeric SGR codes and semicolons are not required to separate color names. Color names and numeric codes may be mixed.
For example, to display matches in underlined bright green on bright selected lines, aiding in visualizing white space in matches and file names:
export GREP_COLORS='sl=1:cx=33:ms=1;4;32;100:mc=1;4;32:fn=1;32;100:ln=1;32:cn=1;32:bn=1;32:se=36'
The same, but with single-letter color names:
export GREP_COLORS='sl=h:cx=y:ms=hug+K:mc=hug:fn=hg+K:ln=hg:cn=hg:bn=hg:se=c'
Another color scheme that works well:
export GREP_COLORS='cx=hb:ms=hiy:mc=hic:fn=hi+y+K:ln=hg:cn=hg:bn=hg:se='
Modern Windows command interpreters support ANSI escape codes. Named or numeric colors can be set with SET GREP_COLORS , for example:
SET GREP_COLORS=sl=1;37:cx=33:mt=1;31:fn=1;35:ln=1;32:cn=1;32:bn=1;32:se=36
To disable colors on Windows:
SET GREP_COLORS=""
Color intensities may differ per platform and per terminal program used, which affects readability.
Option -y outputs every line of input, including non-matching lines as context. The use of color helps distinguish matches from non-matching context.
To copy silver searcher's color palette:
export GREP_COLORS='mt=30;43:fn=1;32:ln=1;33:cn=1;33:bn=1;33'
To produce color-highlighted results ( --color is redundance since it is the default):
ug --color -r -n -k -tc++ 'FIXME.*'
To page through the results with pager ( less -R by default):
ug --pager -r -n -k -tc++ 'FIXME'
To display a hexdump of a zip file itself (ie without decompressing), with color-highlighted matches of the zip magic bytes PKx03x04 ( --color is redundant since it is the default):
ug --color -y -UX 'PKx03x04' some.zip
To use predefined patterns to list all #include and #define in C++ files:
ug --pretty -r -n -tc++ -f c++/includes -f c++/defines
Same, but overriding the color of matches as inverted yellow (reverse video) and headings with yellow on blue using --pretty :
ug --pretty --colors="ms=yi:fn=hyB" -r -n -tc++ -f c++/includes -f c++/defines
To list all #define FOO... macros in C++ files, color-highlighted:
ug --color=always -r -n -tc++ -f c++/defines | ug 'FOO.*'
Same, but restricted to .cpp files only:
ug --color=always -r -n -Ocpp -f c++/defines | ug 'FOO.*'
To search tarballs for matching names of PDF files (assuming bash is our shell):
for tb in *.tar *.tar.gz *.tgz; do echo "$tb"; tar tfz "$tb" | ugrep '.*.pdf$'; done
- Back to table of contents
--cpp Output file matches in C++. See also options --format and -u.
--csv Output file matches in CSV. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
--json Output file matches in JSON. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
--xml Output file matches in XML. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
To recursively search for lines with TODO and display C++ file matches in JSON with line number properties:
ug -tc++ -n --json 'TODO'
To recursively search for lines with TODO and display C++ file matches in XML with line and column number attributes:
ug -tc++ -nk --xml 'TODO'
To recursively search for lines with TODO and display C++ file matches in CSV format with file pathname, line number, and column number fields:
ug -tc++ --csv -Hnk 'TODO'
To extract a table from an HTML file and put it in C/C++ source code using -o :
ug -o --cpp '<tr>.*</tr>' index.html > table.cpp
- Back to table of contents
--format=FORMAT
Output FORMAT-formatted matches. For example --format='%f:%n:%O%~'
outputs matching lines `%O' with filename `%f` and line number `%n'
followed by a newline `%~'. If -P is specified, FORMAT may include
`%1' to `%9', `%[NUM]#' and `%[NAME]#' to output group captures. A
`%%' outputs `%'. See `ugrep --help format' and `man ugrep'
section FORMAT for details. When option -o is specified, option -u
is also enabled. Context options -A, -B, -C and -y are ignored.
-P, --perl-regexp
Interpret PATTERN as a Perl regular expression.
Use option -P to use group captures and backreferences. Capturing groups in regex patterns are parenthesized expressions (pattern) . The first group is referenced in FORMAT by %1 , the second by %2 and so on. Named captures are of the form (?<NAME>pattern) and are referenced in FORMAT by %[NAME]# .
The following output formatting options may be used. The FORMAT string % -fields are listed in a table further below:
| ตัวเลือก | ผลลัพธ์ |
|---|---|
--format-begin=FORMAT | FORMAT beginning the search |
--format-open=FORMAT | FORMAT opening a file and a match was found |
--format=FORMAT | FORMAT for each match in a file |
--format-close=FORMAT | FORMAT closing a file and a match was found |
--format-end=FORMAT | FORMAT ending the search |
The following tables show the formatting options corresponding to --csv , --json , and --xml .
--csv| ตัวเลือก | format string (within quotes) |
|---|---|
--format-open | '%+' |
--format | '%[,]$%H%N%K%B%V%~%u' |
--json| ตัวเลือก | format string (within quotes) |
|---|---|
--format-begin | '[' |
--format-open | '%,%~ {%~ %[,%~ ]$%["file": ]H"matches": [' |
--format | '%,%~ { %[, ]$%["line": ]N%["column": ]K%["offset": ]B"match": %J }%u' |
--format-close | '%~ ]%~ }' |
--format-end | '%~]%~' |
--xml| ตัวเลือก | format string (within quotes) |
|---|---|
--format-begin | '<grep>%~' |
--format-open | ' <file%["]$%[ name="]I>%~' |
--format | ' <match%["]$%[ line="]N%[ column="]K%[ offset="]B>%X</match>%~%u' |
--format-close | ' </file>%~' |
--format-end | '</grep>%~' |
--only-line-number| ตัวเลือก | format string (within quotes) |
|---|---|
--format-open | '%+' |
--format | '%F%n%s%K%B%~%u' |
The following fields may be used in the FORMAT string:
| สนาม | เอาท์พุท |
|---|---|
%% | the percentage sign |
%~ | a newline (LF or CRLF in Windows) |
%F | if option -H is used: the file pathname and separator |
%[TEXT]F | if option -H is used: TEXT , the file pathname and separator |
%f | the file pathname |
%a | the file basename without directory path |
%p | the directory path to the file |
%z | the pathname in a (compressed) archive, without { and } |
%H | if option -H is used: the quoted pathname and separator, " and \ replace " and |
%+ | if option -+ or --heading is used: %F and a newline character, suppress all %F and %H afterward |
%[TEXT]H | if option -H is used: TEXT , the quoted pathname and separator, " and \ replace " and |
%h | the quoted file pathname, " and \ replace " and |
%I | if option -H is used: the pathname in XML and separator |
%[TEXT]I | if option -H is used: TEXT , the pathname as XML and separator |
%i | the file pathnames as XML |
%N | if option -n is used: the line number and separator |
%[TEXT]N | if option -n is used: TEXT , the line number and separator |
%n | the line number of the match |
%l | the last line number of the match (multi-line matching) |
%L | the number of lines matched (multi-line matching) |
%K | if option -k is used: the column number and separator |
%[TEXT]K | if option -k is used: TEXT , the column number and separator |
%k | the column number of the match |
%A | byte range (offset and end) of a match in hex |
%B | if option -b is used: the byte offset and separator |
%[TEXT]B | if option -b is used: TEXT , the byte offset and separator |
%b | the byte offset of the match |
%T | if option -T is used: TEXT and a tab character |
%[TEXT]T | if option -T is used: TEXT and a tab character |
%t | a tab character |
%[SEP]$ | set field separator to SEP for the rest of the format fields |
%[TEXT]< | if the first match: TEXT |
%[TEXT]> | if not the first match: TEXT |
%, | if not the first match: a comma, same as %[,]> |
%: | if not the first match: a colon, same as %[:]> |
%; | if not the first match: a semicolon, same as %[;]> |
%│ | if not the first match: a vertical bar, same as %[│]> |
%S | if not the first match: separator, see also %[SEP]$ |
%[TEXT]S | if not the first match: TEXT and separator, see also %[SEP]$ |
%s | the separator, see also %[TEXT]S and %[SEP]$ |
%R | if option --break or --heading is used: a newline |
%m | the number of matches, sequential (or number of matching files with --format-end ) |
%M | the number of matching lines (or number of matching files with --format-end ) |
%O | the matching line is output as is (a raw string of bytes) |
%o | the match is output as is (a raw string of bytes) |
%Q | the matching line as a quoted string, " and \ replace " and |
%q | the match as a quoted string, " and \ replace " and |
%C | the matching line formatted as a quoted C/C++ string |
%c | the match formatted as a quoted C/C++ string |
%J | the matching line formatted as a quoted JSON string |
%j | the match formatted as a quoted JSON string |
%V | the matching line formatted as a quoted CSV string |
%v | the match formatted as a quoted CSV string |
%X | the matching line formatted as XML character data |
%x | the match formatted as XML character data |
%Y | the matching line formatted in hex |
%y | the match formatted in hex |
%A | byte range of the match in hex |
%w | the width of the match, counting (wide) characters |
%d | the size of the match, counting bytes |
%e | the ending byte offset of the match |
%Z | the edit distance cost of an approximate match with option -Z |
%u | select unique lines only unless option -u is used |
%[hhhh]U | U+hhhh Unicode code point |
%[CODE]= | a color CODE, such as ms , see colors |
%= | turn color off |
%1 %2 ... %9 | the first regex group capture of the match, and so on up to group %9 , requires option -P |
%[NUM]# | the group capture NUM ; requires option -P |
%[NUM]b | the byte offset of the group capture NUM ; requires option -P |
%[NUM]e | the ending byte offset of the group capture NUM ; requires option -P |
%[NUM]d | the byte length of the group capture NUM ; requires option -P |
%[NUM]j | the group capture NUM as JSON; requires option -P |
%[NUM]q | the group capture NUM quoted; requires option -P |
%[NUM]x | the group capture NUM as XML; requires option -P |
%[NUM]y | the group capture NUM as hex; requires option -P |
%[NUM]v | the group capture NUM as CSV; requires option -P |
%[NUM1|NUM2|...]# | the first group capture NUM that matched; requires option -P |
%[NUM1|NUM2|...]b | the byte offset of the first group capture NUM that matched; requires option -P . |
%[NUM1|NUM2|...]e | the ending byte offset of the first group capture NUM that matched; requires option -P . |
%[NUM1|NUM2|...]d | the byte length of the first group capture NUM that matched; requires option -P . |
%[NUM1|NUM2|...]j | the first group capture NUM that matched, as JSON; requires option -P |
%[NUM1|NUM2|...]q | the first group capture NUM that matched, quoted; requires option -P |
%[NUM1|NUM2|...]x | the first group capture NUM that matched, as XML; requires option -P |
%[NUM1|NUM2|...]y | the first group capture NUM that matched, as hex; requires option -P |
%[NUM1|NUM2|...]v | the first group capture NUM that matched, as CSV; requires option -P |
%[NAME]# | the NAME d group capture; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME]b | the byte offset of the NAME d group capture; requires option -P and capturing pattern (?<NAME>PATTERN) . |
%[NAME]e | the ending byte offset of the NAME d group capture; requires option -P and capturing pattern (?<NAME>PATTERN) . |
%[NAME]d | the byte length of the NAME d group capture; requires option -P and capturing pattern (?<NAME>PATTERN) . |
%[NAME]j | the NAME d group capture as JSON; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME]q | the NAME d group capture quoted; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME]x | the NAME d group capture as XML; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME]y | the NAME d group capture as hex; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME]v | the NAME d group capture as CSV; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]# | the first NAME d group capture that matched; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]b | the byte offset of the first NAME d group capture that matched; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]e | the ending byte offset of the first NAME d group capture that matched; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]d | the byte length of the first NAME d group capture that matched; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]j | the first NAME d group capture that matched, as JSON; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]q | the first NAME d group capture that matched, quoted; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]x | the first NAME d group capture that matched, as XML; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]y | the first NAME d group capture that matched, as hex; requires option -P and capturing pattern (?<NAME>PATTERN) |
%[NAME1|NAME2|...]v | the first NAME d group capture that matched, as CSV; requires option -P and capturing pattern (?<NAME>PATTERN) |
%G | list of group capture indices/names of the match (see note) |
%[TEXT1|TEXT2|...]G | list of TEXT indexed by group capture indices that matched; requires option -P |
%g | the group capture index of the match or 1 (see note) |
%[TEXT1|TEXT2|...]g | the first TEXT indexed by the first group capture index that matched; requires option -P |
บันทึก:
%~ is explicitly specified in the format string.-o changes the output of the %O and %Q fields to output the match only.-c , -l and -o change the output of %C , %J , %X and %Y accordingly[TEXT] part of a field is optional and may be omitted. When present, the argument must be placed in [] brackets, for example %[,]F to output a comma, the pathname, and a separator, when option -H is used.%n are padded with spaces when %{width}n is specified.%O are cut to width when %{width}O is specified or when %{-width}O is specified to cut from the end of the line.%{-width}o or %{+width}o is specified for match fields such as %o , where %{width}o without a +/- sign cuts the match to the specified width.%[SEP]$ and %u are switches and do not write anything to the output.%F , %H , %N , %K , %B , %S , and %G may be changed by preceding the field with a %[SEP]$ . When [SEP] is not provided, reverts the separator to the default separator or the separator specified by --separator .%u is found anywhere in the specified format string, matching lines are output only once unless option -u , --ungroup is used or when a newline is matched.%g corresponds to the index of the sub-pattern matched among the alternations in the pattern when option -P is not used. For example foo|bar matches foo with index 1 and bar with index 2. With option -P , the index corresponds to the number of the first group captured in the specified pattern.%[TEXT1|TEXT2|...]G and %[TEXT1|TEXT2|...]g should correspond to the group capture index (see the note above), ie TEXT1 is output for index 1, TEXT2 is output for index 2, and so on. If the list is too short, the index value is output or the name of a named group capture is output.-T and --pretty add right-justifying spacing to fields %N and %K if no leading [TEXT] part is specified.%+ may be used in --format-open to output the pathname heading and a newline break, respectively. Field %+ suppresses %a , %F , %f , %H , %h and %p output. To output matching lines faster by omitting the header output and binary match checks, using --format with field %O (output matching line as is) and field %~ (output newline):
ug --format='%O%~' 'href=' index.html
Same, but also displaying the line and column numbers:
ug --format='%n%k: %O%~' 'href=' index.html
Same, but display a line at most once when matching multiple patterns, unless option -u is used:
ug --format='%u%n%k: %O%~' 'href=' index.html
To string together a list of unique line numbers of matches, separated by commas with field %, :
ug --format='%u%,%n' 'href=' index.html
To output the matching part of a line only with field %o (or option -o with field %O ):
ug --format='%o%~' "href=["'][^"']["']" index.html
To string together the pattern matches as CSV-formatted strings with field %v separated by commas with field %, :
ug --format='%,%v' "href=["'][^"']["']" index.html
To output matches in CSV (comma-separated values), the same as option --csv (works with options -H , -n , -k , -b to add CSV values):
ug --format='"%[,]$%H%N%K%B%V%~%u"' 'href=' index.html
To output matches in AckMate format:
ug --format=":%f%~%n;%k %w:%O%~" 'href=' index.html
To output the sub-pattern indices 1, 2, and 3 on the left to the match for the three patterns foo , bar , and baz in file foobar.txt :
ug --format='%g: %o%~' 'foo|bar|baz' foobar.txt
Same, but using a file foos containing three lines with foo , bar , and baz , where option -F is used to match strings instead of regex:
ug -F -f foos --format='%g: %o%~' foobar.txt
To output one , two , and a word for the sub-patterns [fF]oo , [bB]ar , and any other word w+ , respectively, using argument [one|two|a word] with field %g indexed by sub-pattern (or group captures with option -P ):
ug --format='%[one|two|a word]g%~' '([fF]oo)|([bB]ar)|(w+)' foobar.txt
To output a list of group capture indices with %G separated by the word and instead of the default colons with %[ and ]$ , followed by the matching line:
ug -P --format='%[ and ]$%G%$%s%O%~' '(foo)|(ba((r)|(z)))' foobar.txt
Same, but showing names instead of numbers:
ug -P --format='%[ and ]$%[foo|ba|r|z]G%$%s%O%~' '(foo)|(ba(?:(r)|(z)))' foobar.txt
Note that option -P is required for general use of group captures for sub-patterns. Named sub-pattern matches may be used with PCRE2 and shown in the output:
ug -P --format='%[ and ]$%G%$%s%O%~' '(?P<foo>foo)|(?P<ba>ba(?:(?P<r>r)|(?P<z>z)))' foobar.txt
- Back to table of contents
--replace=FORMAT
Replace matching patterns in the output by the specified FORMAT
with `%' fields. If -P is specified, FORMAT may include `%1' to
`%9', `%[NUM]#' and `%[NAME]#' to output group captures. A `%%'
outputs `%' and `%~' outputs a newline. See option --format,
`ugrep --help format' and `man ugrep' section FORMAT for details.
-y, --any-line
Any line is output (passthru). Non-matching lines are output as
context with a `-' separator. See also options -A, -B, and -C.
-P, --perl-regexp
Interpret PATTERN as a Perl regular expression.
--format=FORMAT
Output FORMAT-formatted matches. For example --format='%f:%n:%O%~'
outputs matching lines `%O' with filename `%f` and line number `%n'
followed by a newline `%~'. If -P is specified, FORMAT may include
`%1' to `%9', `%[NUM]#' and `%[NAME]#' to output group captures. A
`%%' outputs `%'. See `ugrep --help format' and `man ugrep'
section FORMAT for details. When option -o is specified, option -u
is also enabled. Context options -A, -B, -C and -y are ignored.
See customized output with --format for details on the FORMAT fields.
For option -o , the replacement is not automatically followed by a newline to allow for more flexibility in replacements. To output a newline, use %~ in the FORMAT string.
Use option -P to use group captures and backreferences. Capturing groups in regex patterns are parenthesized expressions (pattern) and the first is referenced in FORMAT by %1 , the second by %2 and so on. Named captures are of the form (?<NAME>pattern) and are referenced in FORMAT by %[NAME]# .
To display pattern matches with their sequential match number using --replace='%m:%o' where %m is the sequential match number and %o is the pattern matched:
ug --replace='%m:%o' pattern myfile.txt
Same, but passing the file through with option -y , while applying the replacements to the output:
ug -y --replace='%m:%o' pattern myfile.txt
To extract table cells from an HTML file using Perl matching ( -P ) to support group captures with lazy quantifier (.*?) , and translate the matches to a comma-separated list with format %,%1 (conditional comma and group capture):
ug -P -o '<td>(.*?)</td>' --replace='%,%1' index.html
Same, but using --format='%,%1' instead and we do not need -o (note that --replace color-highlights matches shown on a terminal but --format does not):
ug -P '<td>(.*?)</td>' --format='%,%1' index.html
Same, but displaying the formatted matches line-by-line, with --replace or with --format :
ug -P -o '<td>(.*?)</td>' --replace='%,%1' index.html
ug -P '<td>(.*?)</td>' --format='%1%~' index.html
To collect all href URLs from all HTML and PHP files down the working directory, then sort them:
ug -r -thtml,php -P '<[^<>]+hrefh*=h*.([^x27"]+).' --format='%1%~' | sort -u
Same, but much easier by using the predefined html/href pattern:
ug -r -thtml,php -P -f html/href --format='%1%~' | sort -u
Same, but in this case select <script> src URLs when referencing http and https sites:
ug -r -thtml,php -P '<script.*srch*=h*.(https?:[^x27"]+).' --format='%1%~' | sort -u
- Back to table of contents
--depth=[MIN,][MAX], -1, -2, -3, ... -9, -10, -11, -12, ...
Restrict recursive searches from MIN to MAX directory levels deep,
where -1 (--depth=1) searches the specified path without recursing
into subdirectories. Note that -3 -5, -3-5, and -35 search 3 to 5
levels deep. Enables -r if -R or -r is not specified.
-K [MIN,][MAX], --range=[MIN,][MAX], --min-line=MIN, --max-line=MAX
Start searching at line MIN, stop at line MAX when specified.
-m [MIN,][MAX], --min-count=MIN, --max-count=MAX
Require MIN matches, stop after MAX matches when specified. Output
MIN to MAX matches. For example, -m1 outputs the first match and
-cm1, (with a comma) counts nonzero matches. If -u is specified,
each individual match counts. See also option -K.
--max-files=NUM
Restrict the number of files matched to NUM. Note that --sort or
-J1 may be specified to produce replicable results. If --sort is
specified, the number of threads spawned is limited to NUM.
--sort[=KEY]
Displays matching files in the order specified by KEY in recursive
searches. Normally the ug command sorts by name whereas the ugrep
batch command displays matches in no particular order to improve
performance. The sort KEY can be `name' to sort by pathname
(default), `best' to sort by best match with option -Z (sort by
best match requires two passes over files, which is expensive),
`size' to sort by file size, `used' to sort by last access time,
`changed' to sort by last modification time and `created' to sort
by creation time. Sorting is reversed with `rname', `rbest',
`rsize', `rused', `rchanged', or `rcreated'. Archive contents are
not sorted. Subdirectories are sorted and displayed after matching
files. FILE arguments are searched in the same order as specified.
To show only up to the first 10 matching lines with FIXME in C++ files in the working directory and all subdirectories below:
ug -r -m10 -tc++ FIXME
Same, but recursively search up to two directory levels, meaning that ./ and ./sub/ are visited but not deeper:
ug -2 -m10 -tc++ FIXME
To show only the first two files that have one or more matches of FIXME in the list of files sorted by pathname, using --max-files=2 :
ug --sort -r --max-files=2 -tc++ FIXME
To search file install.sh for the occurrences of the word make after the first line, we use -K with line number 2 to start searching, where -n shows the line numbers in the output:
ug -n -K2 -w make install.sh
Same, but restricting the search to lines 2 to 40 (inclusive):
ug -n -K2,40 -w make install.sh
Same, but showing all lines 2 to 40 with -y :
ug -y -n -K2,40 -w make install.sh
Same, but showing only the first four matching lines after line 2, with one line of context:
ug -n -C1 -K2 -m4 -w make install.sh
- Back to table of contents
-Y, --empty
Permits empty matches. By default, empty matches are disabled,
unless a pattern begins with `^' or ends with `$'. Note that -Y
when specified with an empty-matching pattern, such as x? and x*,
match all input, not only lines containing the character `x'.
Option -Y permits empty pattern matches, like GNU/BSD grep. This option is introduced by ugrep to prevent accidental matching with empty patterns: empty-matching patterns such as x? and x* match all input, not only lines with x . By default, without -Y , patterns match lines with at least one x as intended.
This option is automatically enabled when a pattern starts with ^ or ends with $ is specified. For example, ^h*$ matches blank lines, including empty lines.
To recursively list files in the working directory with blank lines, ie lines with white space only, including empty lines (note that option -Y is implicitly enabled since the pattern starts with ^ and ends with $ ):
ug -l '^h*$'
- Back to table of contents
-i, --ignore-case
Perform case insensitive matching. By default, ugrep is case
sensitive. By default, this option applies to ASCII letters only.
Use options -P and -i for Unicode case insensitive matching.
-j, --smart-case
Perform case insensitive matching like option -i, unless a pattern
is specified with a literal ASCII upper case letter.
To match todo in myfile.cpp regardless of case:
ug -i 'todo' myfile.txt
To match todo XXX with todo in any case but XXX as given, with pattern (?i:todo) to match todo ignoring case:
ug '(?i:todo) XXX' myfile.cpp
- Back to table of contents
--sort[=KEY]
Displays matching files in the order specified by KEY in recursive
searches. Normally the ug command sorts by name whereas the ugrep
batch command displays matches in no particular order to improve
performance. The sort KEY can be `name' to sort by pathname
(default), `best' to sort by best match with option -Z (sort by
best match requires two passes over files, which is expensive),
`size' to sort by file size, `used' to sort by last access time,
`changed' to sort by last modification time and `created' to sort
by creation time. Sorting is reversed with `rname', `rbest',
`rsize', `rused', `rchanged', or `rcreated'. Archive contents are
not sorted. Subdirectories are sorted and displayed after matching
files. FILE arguments are searched in the same order as specified.
Matching files are displayed in the order specified by --sort per directory searched. By default, the ug command sorts by name whereas the output of the ugrep command is not sorted to improve performance, unless option -Q is used which sorts files by name. An optimized sorting method and strategy are implemented in the asynchronous output class to keep the overhead of sorting very low. Directories are displayed after files are displayed first, when recursing, which visually aids the user in finding the "closest" matching files first at the top of the displayed results.
To recursively search for C++ files that match main and sort them by date created:
ug --sort=created -tc++ 'main'
Same, but sorted by time changed from most recent to oldest:
ug --sort=rchanged -tc++ 'main'
- Back to table of contents
When searching non-binary files only, the binary content check is disabled with option -a ( --text ) to speed up searching and displaying pattern matches. For example, searching for lines with int in C++ source code:
ug -r -a -Ocpp -w 'int'
If a file has potentially many pattern matches, but each match is only one a single line, then option -u ( --ungroup ) can speed this up:
ug -r -a -u -Opython -w 'def'
Even greater speeds can be achieved with --format when searching files with many matches. For example, --format='%O%~' displays matching lines for each match on that line, while --format='%o%~' displays the matching part only. Note that the --format option does not check for binary matches, so the output is always "as is". To match text and binary, you can use --format='%C%~' to display matches formatted as quoted C++ strings with escapes. To display a line at most once (unless option -u is used), add the %u (unique) field to the format string, eg --format='%u%O%~' .
For example, to match all words recursively in the working directory with line and column numbers, where %n is the line number, %k is the column number, %o is the match (only matching), and %~ is a newline:
ug -r --format='%n,%k:%o%~' 'w+'
- Back to table of contents
To search for pattern -o in script.sh using -e to explicitly specify a pattern to prevent pattern -o from being interpreted as an option:
ug -n -e '-o' script.sh
Alternatively, using -- to end the list of command arguments:
ug -n -- '-o' script.sh
To recursively list all text files (.txt and .md) that do not properly end with a n ( -o is required to match n or z ):
ug -L -o -Otext 'nz'
To list all markdown sections in text files (.text, .txt, .TXT, and .md):
ug -o -ttext -e '^.*(?=r?n(===|---))' -e '^#{1,6}h+.*'
To display multi-line backtick and indented code blocks in markdown files with their line numbers, using a lazy quantifier *? to make the pattern compact:
ug -n -ttext -e '^```(.|n)*?n```' -e '^(t|[ ]{4}).*'
To find mismatched code (a backtick without matching backtick on the same line) in markdown:
ug -n -ttext -e '`[^`]+' -N '`[^`]*`'
- Back to table of contents
UGREP(1) User Commands UGREP(1)
NAME
ugrep, ug -- file pattern searcher
SYNOPSIS
ugrep [OPTIONS] [-i] [-Q|PATTERN] [-e PATTERN] [-N PATTERN] [-f FILE]
[-F|-G|-P|-Z] [-U] [-m [MIN,][MAX]] [--bool [--files|--lines]]
[-r|-R|-1|...|-9|-10|...] [-t TYPES] [-g GLOBS] [--sort[=KEY]]
[-l|-c] [-o] [-n] [-k] [-b] [-A NUM] [-B NUM] [-C NUM] [-y]
[--color[=WHEN]|--colour[=WHEN]] [--pretty] [--pager[=COMMAND]]
[--hexdump|--csv|--json|--xml] [-I] [-z] [--zmax=NUM] [FILE ...]
DESCRIPTION
The ugrep utility searches any given input files, selecting files and
lines that match one or more patterns specified as regular expressions or
as fixed strings. A pattern matches multiple input lines when the
pattern's regular expression matches one or more newlines. An empty
pattern matches every line. Each input line that matches at least one of
the patterns is written to the standard output.
The ug command is intended for interactive searching, using a .ugrep
configuration file located in the working directory or home directory,
see CONFIGURATION. ug is equivalent to ugrep --config --pretty --sort to
load a .ugrep file, enhance the terminal output, and sort files by name.
The ugrep+ and ug+ commands are the same as the ugrep and ug commands,
but also use filters to search pdfs, documents, e-books, and image
metadata, when the corresponding filter tools are installed.
A list of matching files is produced with option -l (--files-with-
matches). Option -c (--count) counts the number of matching lines. When
combined with option -o, counts the total number of matches. When
combined with option -m1, (--min-count=1), skips files with zero matches.
The default pattern syntax is an extended form of the POSIX ERE syntax,
same as option -E (--extended-regexp). Try ug --help regex for help with
pattern syntax and how to use logical connectives to specify Boolean
search queries with option -% (--bool) to match lines and -%% (--bool
--files) to match files. Options -F (--fixed-strings), -G (--basic-
regexp) and -P (--perl-regexp) specify other pattern syntaxes.
Option -i (--ignore-case) ignores case in ASCII patterns. When combined
with option -P, ignores case in Unicode patterns. Option -j (--smart-
case) enables -i only if the search patterns are specified in lower case.
Fuzzy (approximate) search is specified with option -Z (--fuzzy) with an
optional argument to control character insertions, deletions, and/or
substitutions. Try ug --help fuzzy for help with fuzzy search.
Note that pattern `.' matches any non-newline character. Pattern `n'
matches a newline character. Multiple lines may be matched with patterns
that match one or more newline characters.
The empty pattern "" matches all lines. Other empty-matching patterns do
not. For example, the pattern `a*' will match one or more a's. Option
-Y forces empty matches for compatibility with other grep tools.
Option -f FILE matches patterns specified in FILE.
By default Unicode patterns are matched. Option -U (--ascii or --binary)
disables Unicode matching for ASCII and binary pattern matching. Non-
Unicode matching is more efficient.
ugrep accepts input of various encoding formats and normalizes the output
to UTF-8. When a UTF byte order mark is present in the input, the input
is automatically normalized. An input encoding format may be specified
with option --encoding.
If no FILE arguments are specified and standard input is read from a
terminal, recursive searches are performed as if -r is specified. To
force reading from standard input, specify `-' as a FILE argument.
Directories specified as FILE arguments are searched without recursing
deeper into subdirectories, unless -R, -r, or -2...-9 is specified to
search subdirectories recursively (up to the specified depth.)
Option -I (--ignore-binary) ignores binary files. A binary file is a
file with non-text content. A file with zero bytes or invalid UTF
formatting is considered binary.
Hidden files and directories are ignored in recursive searches. Option
-. (--hidden) includes hidden files and directories in recursive
searches.
To match the names of files to search and the names of directories to
recurse, one or more of the following options may be specified. Option
-O specifies one or more filename extensions to match. Option -t
specifies one or more file types to search (-t list outputs a list of
types.) Option -g specifies a gitignore-style glob pattern to match
filenames. Option --ignore-files specifies a file with gitignore-style
globs to ignore directories and files. Try ug --help globs for help with
filename and directory name matching. See also section GLOBBING.
Compressed files and archives are searched with option -z (--decompress).
When used with option --zmax=NUM, searches the contents of compressed
files and archives stored within archives up to NUM levels.
A query terminal user interface (TUI) is opened with -Q (--query) to
interactively specify search patterns and view search results. A PATTERN
argument requires -e PATTERN to start the query TUI with the specified
pattern.
Output to a terminal for viewing is enhanced with --pretty, which is
enabled by default with the ug command.
A terminal output pager is enabled with --pager.
Customized output is produced with option --format or --replace. Try ug
--help format for help with custom formatting of the output. Predefined
formats include CSV with option --csv, JSON with option --json, and XML
with option --xml. Hexdumps are output with option -X (--hex) or with
option --hexdump to customize hexdumps. See also section FORMAT.
A `--' signals the end of options; the rest of the parameters are FILE
arguments, allowing filenames to begin with a `-' character.
Long options may start with `--no-' to disable, when applicable.
ug --help WHAT displays help on options related to WHAT.
The following options are available:
-A NUM, --after-context=NUM
Output NUM lines of trailing context after matching lines. Places
a --group-separator between contiguous groups of matches. If -o
is specified, output the match with context to fit NUM columns
after the match or shortens the match. See also options -B, -C
and -y.
-a, --text
Process a binary file as if it were text. This is equivalent to
the --binary-files=text option. This option might output binary
garbage to the terminal, which can have problematic consequences
if the terminal driver interprets some of it as commands.
--all, -@
Search all files except hidden: cancel previous file and directory
search restrictions and cancel --ignore-binary and --ignore-files
when specified. Restrictions specified after this option, i.e. to
the right, are still applied. For example, -@I searches all
non-binary files and -@. searches all files including hidden
files. Note that hidden files and directories are never searched,
unless option -. or --hidden is specified.
--and [-e] PATTERN
Specify additional PATTERN that must match. Additional -e PATTERN
following this option is considered an alternative pattern to
match, i.e. each -e is interpreted as an OR pattern enclosed
within the AND. For example, -e A -e B --and -e C -e D matches
lines with (`A' or `B') and (`C' or `D'). Note that multiple -e
PATTERN are alternations that bind more tightly together than
--and. Option --stats displays the search patterns applied. See
also options --not, --andnot, --bool, --files and --lines.
--andnot [-e] PATTERN
Combines --and --not. See also options --and, --not and --bool.
-B NUM, --before-context=NUM
Output NUM lines of leading context before matching lines. Places
a --group-separator between contiguous groups of matches. If -o
is specified, output the match with context to fit NUM columns
before the match or shortens the match. See also options -A, -C
and -y.
-b, --byte-offset
The offset in bytes of a pattern match is displayed in front of
the respective matched line. When -u is specified, displays the
offset for each pattern matched on the same line. Byte offsets
are exact for ASCII, UTF-8 and raw binary input. Otherwise, the
byte offset in the UTF-8 normalized input is displayed.
--binary-files=TYPE
Controls searching and reporting pattern matches in binary files.
TYPE can be `binary', `without-match`, `text`, `hex` and
`with-hex'. The default is `binary' to search binary files and to
report a match without displaying the match. `without-match'
ignores binary matches. `text' treats all binary files as text,
which might output binary garbage to the terminal, which can have
problematic consequences if the terminal driver interprets some of
it as commands. `hex' reports all matches in hexadecimal.
`with-hex' only reports binary matches in hexadecimal, leaving
text matches alone. A match is considered binary when matching a
zero byte or invalid UTF. Short options are -a, -I, -U, -W and
-X.
--bool, -%, -%%
Specifies Boolean query patterns. A Boolean query pattern is
composed of `AND', `OR', `NOT' operators and grouping with `('
`)'. Spacing between subpatterns is the same as `AND', `|' is the
same as `OR' and a `-' is the same as `NOT'. The `OR' operator
binds more tightly than `AND'. For example, --bool 'A|B C|D'
matches lines with (`A' or `B') and (`C' or `D'), --bool 'A -B'
matches lines with `A' and not `B'. Operators `AND', `OR', `NOT'
require proper spacing. For example, --bool 'A OR B AND C OR D'
matches lines with (`A' or `B') and (`C' or `D'), --bool 'A AND
NOT B' matches lines with `A' without `B'. Quoted subpatterns are
matched literally as strings. For example, --bool 'A "AND"|"OR"'
matches lines with `A' and also either `AND' or `OR'. Parentheses
are used for grouping. For example, --bool '(A B)|C' matches
lines with `A' and `B', or lines with `C'. Note that all
subpatterns in a Boolean query pattern are regular expressions,
unless -F is specified. Options -E, -F, -G, -P and -Z can be
combined with --bool to match subpatterns as strings or regular
expressions (-E is the default.) This option does not apply to -f
FILE patterns. The double short option -%% enables options --bool
--files. Option --stats displays the Boolean search patterns
applied. See also options --and, --andnot, --not, --files and
--lines.
--break
Adds a line break between results from different files. This
option is enabled by --heading.
-C NUM, --context=NUM
Output NUM lines of leading and trailing context surrounding each
matching line. Places a --group-separator between contiguous
groups of matches. If -o is specified, output the match with
context to fit NUM columns before and after the match or shortens
the match. See also options -A, -B and -y.
-c, --count
Only a count of selected lines is written to standard output. If
-o or -u is specified, counts the number of patterns matched. If
-v is specified, counts the number of non-matching lines. If -m1,
(with a comma or --min-count=1) is specified, counts only matching
files without outputting zero matches.
--color[=WHEN], --colour[=WHEN]
Mark up the matching text with the colors specified with option
--colors or the GREP_COLOR or GREP_COLORS environment variable.
WHEN can be `never', `always', or `auto', where `auto' marks up
matches only when output on a terminal. The default is `auto'.
--colors=COLORS, --colours=COLORS
Use COLORS to mark up text. COLORS is a colon-separated list of
one or more parameters `sl=' (selected line), `cx=' (context
line), `mt=' (matched text), `ms=' (match selected), `mc=' (match
context), `fn=' (file name), `ln=' (line number), `cn=' (column
number), `bn=' (byte offset), `se=' (separator), `qp=' (TUI
prompt), `qe=' (TUI errors), `qr=' (TUI regex), `qm=' (TUI regex
meta characters), `ql=' (TUI regex lists and literals), `qb=' (TUI
regex braces). Parameter values are ANSI SGR color codes or `k'
(black), `r' (red), `g' (green), `y' (yellow), `b' (blue), `m'
(magenta), `c' (cyan), `w' (white), or leave empty for no color.
Upper case specifies background colors. A `+' qualifies a color
as bright. A foreground and a background color may be combined
with font properties `n' (normal), `f' (faint), `h' (highlight),
`i' (invert), `u' (underline). Parameter `hl' enables file name
hyperlinks. Parameter `rv' reverses the `sl=' and `cx='
parameters when option -v is specified. Selectively overrides
GREP_COLORS. Legacy grep single parameter codes may be specified,
for example --colors='7;32' or --colors=ig to set ms (match
selected).
--config[=FILE], ---[FILE]
Use configuration FILE. The default FILE is `.ugrep'. The
working directory is checked first for FILE, then the home
directory. The options specified in the configuration FILE are
parsed first, followed by the remaining options specified on the
command line. The ug command automatically loads a `.ugrep'
configuration file, unless --config=FILE or --no-config is
specified.
--no-config
Do not automatically load the default .ugrep configuration file.
--no-confirm
Do not confirm actions in -Q query TUI. The default is confirm.
--cpp Output file matches in C++. See also options --format and -u.
--csv Output file matches in CSV. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
-D ACTION, --devices=ACTION
If an input file is a device, FIFO or socket, use ACTION to
process it. By default, ACTION is `skip', which means that
devices are silently skipped. If ACTION is `read', devices read
just as if they were ordinary files.
-d ACTION, --directories=ACTION
If an input file is a directory, use ACTION to process it. By
default, ACTION is `skip', i.e., silently skip directories unless
specified on the command line. If ACTION is `read', warn when
directories are read as input. If ACTION is `recurse', read all
files under each directory, recursively, following symbolic links
only if they are on the command line. This is equivalent to the
-r option. If ACTION is `dereference-recurse', read all files
under each directory, recursively, following symbolic links. This
is equivalent to the -R option.
--delay=DELAY
Set the default -Q key response delay. Default is 3 for 300ms.
--depth=[MIN,][MAX], -1, -2, -3, ... -9, -10, -11, ...
Restrict recursive searches from MIN to MAX directory levels deep,
where -1 (--depth=1) searches the specified path without recursing
into subdirectories. The short forms -3 -5, -3-5 and -3,5 search
3 to 5 levels deep. Enables -r if -R or -r is not specified.
--dotall
Dot `.' in regular expressions matches anything, including
newline. Note that `.*' matches all input and should not be used.
-E, --extended-regexp
Interpret patterns as extended regular expressions (EREs). This is
the default.
-e PATTERN, --regexp=PATTERN
Specify a PATTERN to search the input. An input line is selected
if it matches any of the specified patterns. This option is
useful when multiple -e options are used to specify multiple
patterns, or when a pattern begins with a dash (`-'), or to
specify a pattern after option -f or after the FILE arguments.
--encoding=ENCODING
The encoding format of the input. The default ENCODING is binary
and UTF-8 which are the same. Note that option -U specifies
binary PATTERN matching (text matching is the default.) ENCODING
can be: `binary', `ASCII', `UTF-8', `UTF-16', `UTF-16BE',
`UTF-16LE', `UTF-32', `UTF-32BE', `UTF-32LE', `LATIN1',
`ISO-8859-1', `ISO-8859-2', `ISO-8859-3', `ISO-8859-4',
`ISO-8859-5', `ISO-8859-6', `ISO-8859-7', `ISO-8859-8',
`ISO-8859-9', `ISO-8859-10', `ISO-8859-11', `ISO-8859-13',
`ISO-8859-14', `ISO-8859-15', `ISO-8859-16', `MAC', `MACROMAN',
`EBCDIC', `CP437', `CP850', `CP858', `CP1250', `CP1251', `CP1252',
`CP1253', `CP1254', `CP1255', `CP1256', `CP1257', `CP1258',
`KOI8-R', `KOI8-U', `KOI8-RU'.
--exclude=GLOB
Exclude files whose name matches GLOB, same as -g ^GLOB. GLOB can
use **, *, ?, and [...] as wildcards and to quote a wildcard or
backslash character literally. When GLOB contains a `/', full
pathnames are matched. Otherwise basenames are matched. When
GLOB ends with a `/', directories are excluded as if --exclude-dir
is specified. Otherwise files are excluded. Note that --exclude
patterns take priority over --include patterns. GLOB should be
quoted to prevent shell globbing. This option may be repeated.
--exclude-dir=GLOB
Exclude directories whose name matches GLOB from recursive
searches, same as -g ^GLOB/. GLOB can use **, *, ?, and [...] as
wildcards and to quote a wildcard or backslash character
literally. When GLOB contains a `/', full pathnames are matched.
Otherwise basenames are matched. Note that --exclude-dir patterns
take priority over --include-dir patterns. GLOB should be quoted
to prevent shell globbing. This option may be repeated.
--exclude-from=FILE
Read the globs from FILE and skip files and directories whose name
matches one or more globs. A glob can use **, *, ?, and [...] as
wildcards and to quote a wildcard or backslash character
literally. When a glob contains a `/', full pathnames are
matched. Otherwise basenames are matched. When a glob ends with
a `/', directories are excluded as if --exclude-dir is specified.
Otherwise files are excluded. A glob starting with a `!'
overrides previously-specified exclusions by including matching
files. Lines starting with a `#' and empty lines in FILE are
ignored. When FILE is a `-', standard input is read. This option
may be repeated.
--exclude-fs=MOUNTS
Exclude file systems specified by MOUNTS from recursive searches.
MOUNTS is a comma-separated list of mount points or pathnames to
directories. When MOUNTS is not specified, only descends into the
file systems associated with the specified file and directory
search targets, i.e. excludes all other file systems. Note that
--exclude-fs=MOUNTS take priority over --include-fs=MOUNTS. This
option may be repeated.
-F, --fixed-strings
Interpret pattern as a set of fixed strings, separated by
newlines, any of which is to be matched. This makes ugrep behave
as fgrep. If a PATTERN is specified, or -e PATTERN or -N PATTERN,
then this option has no effect on -f FILE patterns to allow -f
FILE patterns to narrow or widen the scope of the PATTERN search.
-f FILE, --file=FILE
Read newline-separated patterns from FILE. White space in
patterns is significant. Empty lines in FILE are ignored. If
FILE does not exist, the GREP_PATH environment variable is used as
path to FILE. If that fails, looks for FILE in
/usr/local/share/ugrep/patterns. When FILE is a `-', standard
input is read. Empty files contain no patterns; thus nothing is
matched. This option may be repeated.
--filter=COMMANDS
Filter files through the specified COMMANDS first before
searching. COMMANDS is a comma-separated list of `exts:command
arguments', where `exts' is a comma-separated list of filename
extensions and `command' is a filter utility. Files matching one
of `exts' are filtered. A `*' matches any file. The specified
`command' may include arguments separated by spaces. An argument
may be quoted to include spacing, commas or a `%'. A `%' argument
expands into the pathname to search. For example,
--filter='pdf:pdftotext % -' searches PDF files. The `%' expands
into a `-' when searching standard input. When a `%' is not
specified, the filter command should read from standard input and
write to standard output. Option --label=.ext may be used to
specify extension `ext' when searching standard input. This
option may be repeated.
--filter-magic-label=[+]LABEL:MAGIC
Associate LABEL with files whose signature "magic bytes" match the
MAGIC regex pattern. Only files that have no filename extension
are labeled, unless +LABEL is specified. When LABEL matches an
extension specified in --filter=COMMANDS, the corresponding
command is invoked. This option may be repeated.
--format=FORMAT
Output FORMAT-formatted matches. For example
--format='%f:%n:%O%~' outputs matching lines `%O' with filename
`%f` and line number `%n' followed by a newline `%~'. If -P is
specified, FORMAT may include `%1' to `%9', `%[NUM]#' and
`%[NAME]#' to output group captures. A `%%' outputs `%'. See
`ugrep --help format' and `man ugrep' section FORMAT for details.
When option -o is specified, option -u is also enabled. Context
options -A, -B, -C and -y are ignored.
--free-space
Spacing (blanks and tabs) in regular expressions are ignored.
-G, --basic-regexp
Interpret patterns as basic regular expressions (BREs).
-g GLOBS, --glob=GLOBS, --iglob=GLOBS
Only search files whose name matches the specified comma-separated
list of GLOBS, same as --include=glob for each `glob' in GLOBS.
When a `glob' is preceded by a `!' or a `^', skip files whose name
matches `glob', same as --exclude='glob'. When `glob' contains a
`/', full pathnames are matched. Otherwise basenames are matched.
When `glob' ends with a `/', directories are matched, same as
--include-dir='glob' and --exclude-dir='glob'. A leading `/'
matches the working directory. Option --iglob performs
case-insensitive name matching. This option may be repeated and
may be combined with options -M, -O and -t to expand searches.
See `ugrep --help globs' and `man ugrep' section GLOBBING for
details.
--glob-ignore-case
Perform case-insensitive glob matching in general.
--group-separator[=SEP]
Use SEP as a group separator for context options -A, -B and -C.
The default is a double hyphen (`--').
--no-group-separator
Removes the group separator line from the output for context
options -A, -B and -C.
-H, --with-filename
Always print the filename with output lines. This is the default
when there is more than one file to search.
-h, --no-filename
Never print filenames with output lines. This is the default when
there is only one file (or only standard input) to search.
--heading, -+
Group matches per file. Adds a heading and a line break between
results from different files. This option is enabled by --pretty
when the output is sent to a terminal.
--help [WHAT], -? [WHAT]
Display a help message on options related to WHAT when specified.
In addition, `--help regex' displays an overview of regular
expressions, `--help globs' displays an overview of glob syntax
and conventions. `--help fuzzy' displays details of fuzzy search
with option -Z and `--help format' displays a list of --format
fields.
--hexdump[=[1-8][a][bch][A[NUM]][B[NUM]][C[NUM]]]
Output matches in 1 to 8 columns of 8 hexadecimal octets. The
default is 2 columns or 16 octets per line. Argument `a' outputs
a `*' for all hex lines that are identical to the previous hex
line, `b' removes all space breaks, `c' removes the character
column, `h' removes hex spacing, `A' includes up to NUM hex lines
after a match, `B' includes up to NUM hex lines before a match and
`C' includes up to NUM hex lines before and after a match.
Arguments `A', `B' and `C' are the same as options -A, -B and -C
when used with --hexdump. See also options -U, -W and -X.
--hidden, -.
Search hidden files and directories.
--hyperlink[=[PREFIX][+]]
Hyperlinks are enabled for file names when colors are enabled.
Same as --colors=hl. When PREFIX is specified, replaces file://
with PREFIX:// in the hyperlink. A `+' includes the line number
in the hyperlink and when option -k is specified, the column
number.
-I, --ignore-binary
Ignore matches in binary files. This option is equivalent to the
--binary-files=without-match option.
-i, --ignore-case
Perform case insensitive matching. By default, ugrep is case
sensitive. By default, this option applies to ASCII letters only.
Use options -P and -i for Unicode case insensitive matching.
--ignore-files[=FILE]
Ignore files and directories matching the globs in each FILE that
is encountered in recursive searches. The default FILE is
`.gitignore'. Matching files and directories located in the
directory of the FILE and in subdirectories below are ignored.
Globbing syntax is the same as the --exclude-from=FILE gitignore
syntax, but files and directories are excluded instead of only
files. Directories are specifically excluded when the glob ends
in a `/'. Files and directories explicitly specified as command
line arguments are never ignored. This option may be repeated to
specify additional files.
--no-ignore-files
Do not ignore files, i.e. cancel --ignore-files when specified.
--include=GLOB
Only search files whose name matches GLOB, same as -g GLOB. GLOB
can use **, *, ?, and [...] as wildcards and to quote a wildcard
or backslash character literally. When GLOB contains a `/', full
pathnames are matched. Otherwise basenames are matched. When
GLOB ends with a `/', directories are included as if --include-dir
is specified. Otherwise files are included. Note that --exclude
patterns take priority over --include patterns. GLOB should be
quoted to prevent shell globbing. This option may be repeated.
--include-dir=GLOB
Only directories whose name matches GLOB are included in recursive
searches, same as -g GLOB/. GLOB can use **, *, ?, and [...] as
wildcards and to quote a wildcard or backslash character
literally. When GLOB contains a `/', full pathnames are matched.
Otherwise basenames are matched. Note that --exclude-dir patterns
take priority over --include-dir patterns. GLOB should be quoted
to prevent shell globbing. This option may be repeated.
--include-from=FILE
Read the globs from FILE and search only files and directories
whose name matches one or more globs. A glob can use **, *, ?,
and [...] as wildcards and to quote a wildcard or backslash
character literally. When a glob contains a `/', full pathnames
are matched. Otherwise basenames are matched. When a glob ends
with a `/', directories are included as if --include-dir is
specified. Otherwise files are included. A glob starting with a
`!' overrides previously-specified inclusions by excluding
matching files. Lines starting with a `#' and empty lines in FILE
are ignored. When FILE is a `-', standard input is read. This
option may be repeated.
--include-fs=MOUNTS
Only file systems specified by MOUNTS are included in recursive
searches. MOUNTS is a comma-separated list of mount points or
pathnames to directories. When MOUNTS is not specified, restricts
recursive searches to the file system of the working directory,
same as --include-fs=. (dot). Note that --exclude-fs=MOUNTS take
priority over --include-fs=MOUNTS. This option may be repeated.
--index
Perform fast index-based recursive search. This option assumes,
but does not require, that files are indexed with ugrep-indexer.
This option also enables option -r or --recursive. Skips indexed
non-matching files, archives and compressed files. Significant
acceleration may be achieved on cold (not file-cached) and large
file systems, or any file system that is slow to search. Note
that the start-up time to search may be increased when complex
search patterns are specified that contain large Unicode character
classes combined with `*' or `+' repeats, which should be avoided.
Option -U (--ascii) improves performance. Option --stats displays
an index search report.
-J NUM, --jobs=NUM
Specifies the number of threads spawned to search files. By
default an optimum number of threads is spawned to search files
simultaneously. -J1 disables threading: files are searched in the
same order as specified.
-j, --smart-case
Perform case insensitive matching, unless a pattern is specified
with a literal upper case ASCII letter.
--json Output file matches in JSON. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
-K [MIN,][MAX], --range=[MIN,][MAX], --min-line=MIN, --max-line=MAX
Start searching at line MIN, stop at line MAX when specified.
-k, --column-number
The column number of a pattern match is displayed in front of the
respective matched line, starting at column 1. Tabs are expanded
in counting columns, see also option --tabs.
-L, --files-without-match
Only the names of files not containing selected lines are written
to standard output. Pathnames are listed once per file searched.
If the standard input is searched, the string ``(standard input)''
is written.
-l, --files-with-matches
Only the names of files containing selected lines are written to
standard output. ugrep will only search a file until a match has
been found, making searches potentially less expensive. Pathnames
are listed once per file searched. If the standard input is
searched, the string ``(standard input)'' is written.
--label=LABEL
Displays the LABEL value when input is read from standard input
where a file name would normally be printed in the output.
Associates a filename extension with standard input when LABEL has
a suffix. The default value is `(standard input)'.
--line-buffered
Force output to be line buffered instead of block buffered.
--lines
Boolean line matching mode for option --bool, the default mode.
-M MAGIC, --file-magic=MAGIC
Only search files matching the magic signature pattern MAGIC. The
signature "magic bytes" at the start of a file are compared to the
MAGIC regex pattern. When matching, the file will be searched.
When MAGIC is preceded by a `!' or a `^', skip files with matching
MAGIC signatures. This option may be repeated and may be combined
with options -O and -t to expand the search. Every file on the
search path is read, making searches potentially more expensive.
-m [MIN,][MAX], --min-count=MIN, --max-count=MAX
Require MIN matches, stop after MAX matches when specified.
Output MIN to MAX matches. For example, -m1 outputs the first
match and -cm1, (with a comma) counts nonzero matches. If -u is
specified, each individual match counts. See also option -K.
--match
Match all input. Same as specifying an empty pattern to search.
--max-files=NUM
Restrict the number of files matched to NUM. Note that --sort or
-J1 may be specified to produce replicable results. If --sort is
specified, the number of threads spawned is limited to NUM.
--mmap[=MAX]
Use memory maps to search files. By default, memory maps are used
under certain conditions to improve performance. When MAX is
specified, use up to MAX mmap memory per thread.
-N PATTERN, --neg-regexp=PATTERN
Specify a negative PATTERN to reject specific -e PATTERN matches
with a counter pattern. Note that longer patterns take precedence
over shorter patterns, i.e. a negative pattern must be of the same
length or longer to reject matching patterns. Option -N cannot be
specified with -P. This option may be repeated.
-n, --line-number
Each output line is preceded by its relative line number in the
file, starting at line 1. The line number counter is reset for
each file processed.
--not [-e] PATTERN
Specifies that PATTERN should not match. Note that -e A --not -e
B matches lines with `A' or lines without a `B'. To match lines
with `A' that have no `B', specify -e A --andnot -e B. Option
--stats displays the search patterns applied. See also options
--and, --andnot, --bool, --files and --lines.
-O EXTENSIONS, --file-extension=EXTENSIONS
Only search files whose filename extensions match the specified
comma-separated list of EXTENSIONS, same as -g '*.ext' for each
`ext' in EXTENSIONS. When an `ext' is preceded by a `!' or a `^',
skip files whose filename extensions matches `ext', same as -g
'^*.ext'. This option may be repeated and may be combined with
options -g, -M and -t to expand the recursive search.
-o, --only-matching
Only the matching part of a pattern match is output. If -A, -B or
-C is specified, fits the match and its context on a line within
the specified number of columns.
--only-line-number
Only the line number of a matching line is output. The line
number counter is reset for each file processed.
--files, -%%
Boolean file matching mode, the opposite of --lines. When
combined with option --bool, matches a file if all Boolean
conditions are satisfied. For example, --bool --files 'A B|C -D'
matches a file if some lines match `A', and some lines match
either `B' or `C', and no line matches `D'. See also options
--and, --andnot, --not, --bool and --lines. The double short
option -%% enables options --bool --files.
-P, --perl-regexp
Interpret PATTERN as a Perl regular expression using PCRE2. Note
that Perl pattern matching differs from the default grep POSIX
pattern matching.
-p, --no-dereference
If -R or -r is specified, do not follow symbolic links, even when
symbolic links are specified on the command line.
--pager[=COMMAND]
When output is sent to the terminal, uses COMMAND to page through
the output. COMMAND defaults to environment variable PAGER when
defined or `less'. Enables --heading and --line-buffered.
--pretty[=WHEN]
When output is sent to a terminal, enables --color, --heading, -n,
--sort, --tree and -T when not explicitly disabled. WHEN can be
`never', `always', or `auto'. The default is `auto'.
-Q[=DELAY], --query[=DELAY]
Query mode: start a TUI to perform interactive searches. This
mode requires an ANSI capable terminal. An optional DELAY
argument may be specified to reduce or increase the response time
to execute searches after the last key press, in increments of
100ms, where the default is 3 (300ms delay). No whitespace may be
given between -Q and its argument DELAY. Initial patterns may be
specified with -e PATTERN, i.e. a PATTERN argument requires option
-e. Press F1 or CTRL-Z to view the help screen. Press F2 or
CTRL-Y to invoke a command to view or edit the file shown at the
top of the screen. The command can be specified with option
--view and defaults to environment variable PAGER when defined, or
VISUAL or EDITOR. Press Tab or Shift-Tab to navigate directories
and to select a file to search. Press Enter to select lines to
output. Press ALT-l for option -l to list files, ALT-n for -n,
etc. Non-option commands include ALT-] to increase context and
ALT-} to increase fuzzyness. See also options --no-confirm,
--delay, --split and --view.
-q, --quiet, --silent
Quiet mode: suppress all output. Only search a file until a match
has been found.
-R, --dereference-recursive
Recursively read all files under each directory, following
symbolic links to files and directories, unlike -r.
-r, --recursive
Recursively read all files under each directory, following
symbolic links only if they are on the command line. Note that
when no FILE arguments are specified and input is read from a
terminal, recursive searches are performed as if -r is specified.
--replace=FORMAT
Replace matching patterns in the output by FORMAT with `%' fields.
If -P is specified, FORMAT may include `%1' to `%9', `%[NUM]#' and
`%[NAME]#' to output group captures. A `%%' outputs `%' and `%~'
outputs a newline. See also option --format, `ugrep --help
format' and `man ugrep' section FORMAT for details.
-S, --dereference-files
When -r is specified, follow symbolic links to files, but not to
directories. The default is not to follow symbolic links.
-s, --no-messages
Silent mode: nonexistent and unreadable files are ignored and
their error messages and warnings are suppressed.
--save-config[=FILE] [OPTIONS]
Save configuration FILE to include OPTIONS. Update FILE when
first loaded with --config=FILE. The default FILE is `.ugrep',
which is automatically loaded by the ug command. When FILE is a
`-', writes the configuration to standard output. Only part of
the OPTIONS are saved that do not cause searches to fail when
combined with other options. Additional options may be specified
by editing the saved configuration file. A configuration file may
be modified manually to specify one or more config[=FILE] to
indirectly load the specified FILE, but recursive config loading
is not allowed.
--separator[=SEP], --context-separator=SEP
Use SEP as field separator between file name, line number, column
number, byte offset and the matched line. The default separator
is a colon (`:') and a bar (`|') for multi-line pattern matches,
and a dash (`-') for context lines. See also option
--group-separator.
--split
Split the -Q query TUI screen on startup.
--sort[=KEY]
Displays matching files in the order specified by KEY in recursive
searches. Normally the ug command sorts by name whereas the ugrep
batch command displays matches in no particular order to improve
performance. The sort KEY can be `name' to sort by pathname
(default), `best' to sort by best match with option -Z (sort by
best match requires two passes over files, which is expensive),
`size' to sort by file size, `used' to sort by last access time,
`changed' to sort by last modification time and `created' to sort
by creation time. Sorting is reversed with `rname', `rbest',
`rsize', `rused', `rchanged', or `rcreated'. Archive contents are
not sorted. Subdirectories are sorted and displayed after
matching files. FILE arguments are searched in the same order as
specified.
--stats
Output statistics on the number of files and directories searched
and the inclusion and exclusion constraints applied.
-T, --initial-tab
Add a tab space to separate the file name, line number, column
number and byte offset with the matched line.
-t TYPES, --file-type=TYPES
Search only files associated with TYPES, a comma-separated list of
file types. Each file type corresponds to a set of filename
extensions passed to option -O and filenames passed to option -g.
For capitalized file types, the search is expanded to include
files with matching file signature magic bytes, as if passed to
option -M. When a type is preceded by a `!' or a `^', excludes
files of the specified type. Specifying the initial part of a
type name suffices when the choice is unambiguous. This option
may be repeated. The possible file types can be (-tlist displays
a list): `actionscript', `ada', `asm', `asp', `aspx', `autoconf',
`automake', `awk', `Awk', `basic', `batch', `bison', `c', `c++',
`clojure', `cpp', `csharp', `css', `csv', `dart', `Dart',
`delphi', `elisp', `elixir', `erlang', `fortran', `gif', `Gif',
`go', `groovy', `gsp', `haskell', `html', `jade', `java', `jpeg',
`Jpeg', `js', `json', `jsp', `julia', `kotlin', `less', `lex',
`lisp', `lua', `m4', `make', `markdown', `matlab', `node', `Node',
`objc', `objc++', `ocaml', `parrot', `pascal', `pdf', `Pdf',
`perl', `Perl', `php', `Php', `png', `Png', `prolog', `python',
`Python', `r', `rpm', `Rpm', `rst', `rtf', `Rtf', `ruby', `Ruby',
`rust', `scala', `scheme', `shell', `Shell', `smalltalk', `sql',
`svg', `swift', `tcl', `tex', `text', `tiff', `Tiff', `tt',
`typescript', `verilog', `vhdl', `vim', `xml', `Xml', `yacc',
`yaml', `zig'.
--tabs[=NUM]
Set the tab size to NUM to expand tabs for option -k. The value
of NUM may be 1 (no expansion), 2, 4, or 8. The default size is
8.
--tag[=TAG[,END]]
Disables colors to mark up matches with TAG. END marks the end of
a match if specified, otherwise TAG. The default is `___'.
--tree, -^
Output directories with matching files in a tree-like format for
option -c or --count, -l or --files-with-matches, -L or
--files-without-match. This option is enabled by --pretty when
the output is sent to a terminal.
-U, --ascii, --binary
Disables Unicode matching for ASCII and binary matching. PATTERN
matches bytes, not Unicode characters. For example, -U 'xa3'
matches byte A3 (hex) instead of the Unicode code point U+00A3
represented by the UTF-8 sequence C2 A3. See also option
--dotall.
-u, --ungroup
Do not group multiple pattern matches on the same matched line.
Output the matched line again for each additional pattern match.
-V, --version
Display version with linked libraries and exit.
-v, --invert-match
Selected lines are those not matching any of the specified
patterns.
--view[=COMMAND]
Use COMMAND to view/edit a file in -Q query TUI by pressing
CTRL-Y.
-W, --with-hex
Output binary matches in hexadecimal, leaving text matches alone.
This option is equivalent to the --binary-files=with-hex option.
To omit the matching line from the hex output, use both options -W
and --hexdump. See also options -U.
-w, --word-regexp
The PATTERN is searched for as a word, such that the matching text
is preceded by a non-word character and is followed by a non-word
character. Word-like characters are Unicode letters, digits and
connector punctuations such as underscore.
--width[=NUM]
Truncate the output to NUM visible characters per line. The width
of the terminal window is used if NUM is not specified. Note that
double wide characters in the output may result in wider lines.
-X, --hex
Output matches and matching lines in hexadecimal. This option is
equivalent to the --binary-files=hex option. To omit the matching
line from the hex output use option --hexdump. See also option
-U.
-x, --line-regexp
Select only those matches that exactly match the whole line, as if
the patterns are surrounded by ^ and $.
--xml Output file matches in XML. If -H, -n, -k, or -b is specified,
additional values are output. See also options --format and -u.
-Y, --empty
Permits empty matches. By default, empty matches are disabled,
unless a pattern begins with `^' or ends with `$'. With this
option, empty-matching patterns such as x? and x*, match all
input, not only lines containing the character `x'.
-y, --any-line, --passthru
Any line is output (passthru). Non-matching lines are output as
context with a `-' separator. See also options -A, -B and -C.
-Z[best][+-~][MAX], --fuzzy[=[best][+-~][MAX]]
Fuzzy mode: report approximate pattern matches within MAX errors.
The default is -Z1: one deletion, insertion or substitution is
allowed. If `+`, `-' and/or `~' is specified, then `+' allows
insertions, `-' allows deletions and `~' allows substitutions.
For example, -Z+~3 allows up to three insertions or substitutions,
but no deletions. If `best' is specified, then only the best
matching lines are output with the lowest cost per file. Option
-Zbest requires two passes over a file and cannot be used with
standard input or Boolean queries. Option --sort=best orders
matching files by best match. The first character of an
approximate match always matches a character at the beginning of
the pattern. To fuzzy match the first character, replace it with
a `.' or `.?'. Option -U applies fuzzy matching to ASCII and
bytes instead of Unicode text. No whitespace may be given between
-Z and its argument.
-z, --decompress
Search compressed files and archives. Archives (.cpio, .pax,
.tar) and compressed archives (e.g. .zip, .7z, .taz, .tgz, .tpz,
.tbz, .tbz2, .tb2, .tz2, .tlz, .txz, .tzst) are searched and
matching pathnames of files in archives are output in braces.
When used with option --zmax=NUM, searches the contents of
compressed files and archives stored within archives up to NUM
levels. If -g, -O, -M, or -t is specified, searches files stored
in archives whose filenames match globs, match filename
extensions, match file signature magic bytes, or match file types,
respectively. Supported compression formats: gzip (.gz), compress
(.Z), zip, 7z, bzip2 (requires suffix .bz, .bz2, .bzip2, .tbz,
.tbz2, .tb2, .tz2), lzma and xz (requires suffix .lzma, .tlz, .xz,
.txz), lz4 (requires suffix .lz4), zstd (requires suffix .zst,
.zstd, .tzst), brotli (requires suffix .br).
--zmax=NUM
When used with option -z (--decompress), searches the contents of
compressed files and archives stored within archives by up to NUM
expansion stages. The default --zmax=1 only permits searching
uncompressed files stored in cpio, pax, tar, zip and 7z archives;
compressed files and archives are detected as binary files and are
effectively ignored. Specify --zmax=2 to search compressed files
and archives stored in cpio, pax, tar, zip and 7z archives. NUM
may range from 1 to 99 for up to 99 decompression and de-archiving
steps. Increasing NUM values gradually degrades performance.
-0, --null
Output a zero-byte (NUL) after the file name. This option can be
used with commands such as `find -print0' and `xargs -0' to
process arbitrary file names.
EXIT STATUS
The ugrep utility exits with one of the following values:
0 One or more lines were selected.
1 No lines were selected.
>1 An error occurred.
If -q or --quiet or --silent is used and a line is selected, the exit
status is 0 even if an error occurred.
CONFIGURATION
The ug command is intended for context-dependent interactive searching
and is equivalent to the ugrep --config --pretty --sort command to load
the default configuration file `.ugrep' when present in the working
directory or in the home directory.
A configuration file contains `NAME=VALUE' pairs per line, where `NAME`
is the name of a long option (without `--') and `=VALUE' is an argument,
which is optional and may be omitted depending on the option. Empty
lines and lines starting with a `#' are ignored.
The --config=FILE option and its abbreviated form ---FILE load the
specified configuration file located in the working directory or, when
not found, located in the home directory. An error is produced when FILE
is not found or cannot be read.
Command line options are parsed in the following order: the configuration
file is loaded first, followed by the remaining options and arguments on
the command line.
The --save-config option saves a `.ugrep' configuration file to the
working directory with a subset of the options specified on the command
line. The --save-config=FILE option saves the configuration to FILE.
The configuration is written to standard output when FILE is a `-'.
GLOBBING
Globbing is used by options -g, --include, --include-dir, --include-from,
--exclude, --exclude-dir, --exclude-from and --ignore-files to match
pathnames and basenames in recursive searches. Glob arguments for these
options should be quoted to prevent shell globbing.
Globbing supports gitignore syntax and the corresponding matching rules,
except that a glob normally matches files but not directories. If a glob
ends in a path separator `/', then it matches directories but not files,
as if --include-dir or --exclude-dir is specified. When a glob contains
a path separator `/', the full pathname is matched. Otherwise the
basename of a file or directory is matched. For example, *.h matches
foo.h and bar/foo.h. bar/*.h matches bar/foo.h but not foo.h and not
bar/bar/foo.h. Use a leading `/' to force /*.h to match foo.h but not
bar/foo.h.
When a glob starts with a `^' or a `!' as in -g^GLOB, the match is
negated. Likewise, a `!' (but not a `^') may be used with globs in the
files specified --include-from, --exclude-from, and --ignore-files to
negate the glob match. Empty lines or lines starting with a `#' are
ignored.
Glob Syntax and Conventions
* Matches anything except /.
? Matches any one character except /.
[abc-e]
Matches one character a,b,c,d,e.
[^abc-e]
Matches one character not a,b,c,d,e,/.
[!abc-e]
Matches one character not a,b,c,d,e,/.
/ When used at the start of a glob, matches if pathname has no /.
When used at the end of a glob, matches directories only.
**/ Matches zero or more directories.
/** When used at the end of a glob, matches everything after the /.
? Matches a ? or any other character specified after the backslash.
Glob Matching Examples
* Matches a, b, x/a, x/y/b
a Matches a, x/a, x/y/a, but not b, x/b, a/a/b
/* Matches a, b, but not x/a, x/b, x/y/a
/a Matches a, but not x/a, x/y/a
a?b Matches axb, ayb, but not a, b, ab, a/b
a[xy]b Matches axb, ayb but not a, b, azb
a[a-z]b
Matches aab, abb, acb, azb, but not a, b, a3b, aAb, aZb
a[^xy]b
Matches aab, abb, acb, azb, but not a, b, axb, ayb
a[^a-z]b
Matches a3b, aAb, aZb but not a, b, aab, abb, acb, azb
a/*/b Matches a/x/b, a/y/b, but not a/b, a/x/y/b
**/a Matches a, x/a, x/y/a, but not b, x/b.
a/**/b Matches a/b, a/x/b, a/x/y/b, but not x/a/b, a/b/x
a/** Matches a/x, a/y, a/x/y, but not a, b/x
a?b Matches a?b, but not a, b, ab, axb, a/b
Note that exclude glob patterns take priority over include glob patterns
when specified with options -g, --exclude, --exclude-dir, --include and
include-dir.
Glob patterns specified with prefix `!' in any of the files associated
with --include-from, --exclude-from and --ignore-files will negate a
previous glob match. That is, any matching file or directory excluded by
a previous glob pattern specified in the files associated with --exclude-
from or --ignore-file will become included again. Likewise, any matching
file or directory included by a previous glob pattern specified in the
files associated with --include-from will become excluded again.
ENVIRONMENT
GREP_PATH
May be used to specify a file path to pattern files. The file
path is used by option -f to open a pattern file, when the pattern
file does not exist.
GREP_COLOR
May be used to specify ANSI SGR parameters to highlight matches
when option --color is used, e.g. 1;35;40 shows pattern matches in
bold magenta text on a black background. Deprecated in favor of
GREP_COLORS, but still supported.
GREP_COLORS
May be used to specify ANSI SGR parameters to highlight matches
and other attributes when option --color is used. Its value is a
colon-separated list of ANSI SGR parameters that defaults to
cx=33:mt=1;31:fn=1;35:ln=1;32:cn=1;32:bn=1;32:se=36 with
additional parameters for TUI colors
:qp=1;32:qe=1;37;41:qm=1;32:ql=36:qb=1;35. The mt=, ms=, and mc=
capabilities of GREP_COLORS take priority over GREP_COLOR. Option
--colors takes priority over GREP_COLORS.
GREP_COLORS
Colors are specified as string of colon-separated ANSI SGR parameters of
the form `what=substring', where `substring' is a semicolon-separated
list of ANSI SGR codes or `k' (black), `r' (red), `g' (green), `y'
(yellow), `b' (blue), `m' (magenta), `c' (cyan), `w' (white). Upper case
specifies background colors. A `+' qualifies a color as bright. A
foreground and a background color may be combined with one or more font
properties `n' (normal), `f' (faint), `h' (highlight), `i' (invert), `u'
(underline). Substrings may be specified for:
sl= selected lines.
cx= context lines.
rv swaps the sl= and cx= capabilities when -v is specified.
mt= matching text in any matching line.
ms= matching text in a selected line. The substring mt= by default.
mc= matching text in a context line. The substring mt= by default.
fn= filenames.
ln= line numbers.
cn= column numbers.
bn= byte offsets.
se= separators.
rv a Boolean parameter, switches sl= and cx= with option -v.
hl a Boolean parameter, enables filename hyperlinks (33]8;;link).
ne a Boolean parameter, disables ``erase in line'' 33[K.
qp= TUI prompt.
qe= TUI errors.
qr= TUI regex.
qm= TUI regex meta characters.
ql= TUI regex lists and literals.
qb= TUI regex braces.
FORMAT
Option --format=FORMAT specifies an output format for file matches.
Fields may be used in FORMAT, which expand into the following values:
%[TEXT]F
if option -H is used: TEXT, the file pathname and separator.
%f the file pathname.
%a the file basename without directory path.
%p the directory path to the file.
%z the file pathname in a (compressed) archive.
%[TEXT]H
if option -H is used: TEXT, the quoted pathname and separator, "
and \ replace " and .
%h the quoted file pathname, " and \ replace " and .
%[TEXT]I
if option -H is used: TEXT, the pathname as XML character data and
separator.
%i the file pathname as XML character data.
%[TEXT]N
if option -n is used: TEXT, the line number and separator.
%n the line number of the match.
%[TEXT]K
if option -k is used: TEXT, the column number and separator.
%k the column number of the match.
%[TEXT]B
if option -b is used: TEXT, the byte offset and separator.
%b the byte offset of the match.
%[TEXT]T
if option -T is used: TEXT and a tab character.
%t a tab character.
%[SEP]$
set field separator to SEP for the rest of the format fields.
%[TEXT]<
if the first match: TEXT.
%[TEXT]>
if not the first match: TEXT.
%, if not the first match: a comma, same as %[,]>.
%: if not the first match: a colon, same as %[:]>.
%; if not the first match: a semicolon, same as %[;]>.
%| if not the first match: a vertical bar, same as %[|]>.
%[TEXT]S
if not the first match: TEXT and separator, see also %[SEP]$.
%s the separator, see also %[TEXT]S and %[SEP]$.
%~ a newline character.
%M the number of matching lines
%m the number of matches
%O the matching line is output as a raw string of bytes.
%o the match is output as a raw string of bytes.
%Q the matching line as a quoted string, " and \ replace " and .
%q the match as a quoted string, " and \ replace " and .
%C the matching line formatted as a quoted C/C++ string.
%c the match formatted as a quoted C/C++ string.
%J the matching line formatted as a quoted JSON string.
%j the match formatted as a quoted JSON string.
%V the matching line formatted as a quoted CSV string.
%v the match formatted as a quoted CSV string.
%X the matching line formatted as XML character data.
%x the match formatted as XML character data.
%w the width of the match, counting wide characters.
%d the size of the match, counting bytes.
%e the ending byte offset of the match.
%Z the edit distance cost of an approximate match with option -Z
%u select unique lines only, unless option -u is used.
%1 the first regex group capture of the match, and so on up to group
%9, same as %[1]#; requires option -P.
%[NUM]#
the regex group capture NUM; requires option -P.
%[NUM]b
the byte offset of the group capture NUM; requires option -P. Use
e for the ending byte offset and d for the byte length.
%[NUM1|NUM2|...]#
the first group capture NUM that matched; requires option -P.
%[NUM1|NUM2|...]b
the byte offset of the first group capture NUM that matched;
requires option -P. Use e for the ending byte offset and d for
the byte length.
%[NAME]#
the NAMEd group capture; requires option -P and capturing pattern
`(?<NAME>PATTERN)', see also %G.
%[NAME]b
the byte offset of the NAMEd group capture; requires option -P and
capturing pattern `(?<NAME>PATTERN)'. Use e for the ending byte
offset and d for the byte length.
%[NAME1|NAME2|...]#
the first NAMEd group capture that matched; requires option -P and
capturing pattern `(?<NAME>PATTERN)', see also %G.
%[NAME1|NAME2|...]b
the byte offset of the first NAMEd group capture that matched;
requires option -P and capturing pattern `(?<NAME>PATTERN)'. Use
e for the ending byte offset and d for the byte length.
%G list of group capture indices/names that matched; requires option
-P.
%[TEXT1|TEXT2|...]G
list of TEXT indexed by group capture indices that matched;
requires option -P.
%g the group capture index/name matched or 1; requires option -P.
%[TEXT1|TEXT2|...]g
the first TEXT indexed by the first group capture index that
matched; requires option -P.
%% the percentage sign.
Formatted output is written without a terminating newline, unless %~ or
`n' is explicitly specified in the format string.
The [TEXT] part of a field is optional and may be omitted. When present,
the argument must be placed in [] brackets, for example %[,]F to output a
comma, the pathname, and a separator.
%[SEP]$ and %u are switches and do not send anything to the output.
The separator used by the %F, %H, %I, %N, %K, %B, %S and %G fields may be
changed by preceding the field by %[SEP]$. When [SEP] is not provided,
this reverts the separator to the default separator or the separator
specified with --separator.
Formatted output is written for each matching pattern, which means that a
line may be output multiple times when patterns match more than once on
the same line. If field %u is specified anywhere in a format string,
matching lines are output only once, unless option -u, --ungroup is
specified or when more than one line of input matched the search pattern.
Additional formatting options:
--format-begin=FORMAT
the FORMAT when beginning the search.
--format-open=FORMAT
the FORMAT when opening a file and a match was found.
--format-close=FORMAT
the FORMAT when closing a file and a match was found.
--format-end=FORMAT
the FORMAT when ending the search.
The context options -A, -B, -C, -y, and display options --break,
--heading, --color, -T, and --null have no effect on formatted output.
EXAMPLES
Display lines containing the word `patricia' in `myfile.txt':
$ ugrep -w patricia myfile.txt
Display lines containing the word `patricia', ignoring case:
$ ugrep -wi patricia myfile.txt
Display lines approximately matching the word `patricia', ignoring case
and allowing up to 2 spelling errors using fuzzy search:
$ ugrep -Z2 -wi patricia myfile.txt
Count the number of lines containing `patricia', ignoring case:
$ ugrep -cwi patricia myfile.txt
Count the number of words `patricia', ignoring case:
$ ugrep -cowi patricia myfile.txt
List lines with `amount' and a decimal, ignoring case (space is AND):
$ ugrep -i -% 'amount +(.+)?' myfile.txt
Alternative query:
$ ugrep -wi -e amount --and '+(.+)?' myfile.txt
List all Unicode words in a file:
$ ugrep -o 'w+' myfile.txt
List the laughing face emojis (Unicode code points U+1F600 to U+1F60F):
$ ugrep -o '[x{1F600}-x{1F60F}]' myfile.txt
Check if a file contains any non-ASCII (i.e. Unicode) characters:
$ ugrep -q '[^[:ascii:]]' myfile.txt && echo "contains Unicode"
Display the line and column number of `FIXME' in C++ files using
recursive search, with one line of context before and after a matched
line:
$ ugrep -C1 -R -n -k -tc++ FIXME
Display the line and column number of `FIXME' in long Javascript files
using recursive search, showing only matches with up to 10 characters of
context before and after:
$ ugrep -o -C20 -R -n -k -tjs FIXME
Find blocks of text between lines matching BEGIN and END by using a lazy
quantifier `*?' to match only what is necessary and pattern `n' to match
newlines:
$ ugrep -n 'BEGIN.*n(.*n)*?.*END' myfile.txt
Likewise, list the C/C++ comments in a file and line numbers:
$ ugrep -n -e '//.*' -e '/*(.*n)*?.**+/' myfile.cpp
The same, but using predefined pattern c++/comments:
$ ugrep -n -f c++/comments myfile.cpp
List the lines that need fixing in a C/C++ source file by looking for the
word `FIXME' while skipping any `FIXME' in quoted strings:
$ ugrep -e FIXME -N '"(\.|\r?n|[^\n"])*"' myfile.cpp
The same, but using predefined pattern cpp/zap_strings:
$ ugrep -e FIXME -f cpp/zap_strings myfile.cpp
Find lines with `FIXME' or `TODO', showing line numbers:
$ ugrep -n -e FIXME -e TODO myfile.cpp
Find lines with `FIXME' that also contain `urgent':
$ ugrep -n -e FIXME --and urgent myfile.cpp
The same, but with a Boolean query pattern (a space is AND):
$ ugrep -n -% 'FIXME urgent' myfile.cpp
Find lines with `FIXME' that do not also contain `later':
$ ugrep -n -e FIXME --andnot later myfile.cpp
The same, but with a Boolean query pattern (a space is AND, - is NOT):
$ ugrep -n -% 'FIXME -later' myfile.cpp
Output a list of line numbers of lines with `FIXME' but not `later':
$ ugrep -e FIXME --andnot later --format='%,%n' myfile.cpp
Recursively list all files with both `FIXME' and `LICENSE' anywhere in
the file, not necessarily on the same line:
$ ugrep -l -%% 'FIXME LICENSE'
Find lines with `FIXME' in the C/C++ files stored in a tarball:
$ ugrep -z -tc++ -n FIXME project.tgz
Recursively find lines with `FIXME' in C/C++ files, but do not search any
`bak' and `old' directories:
$ ugrep -n FIXME -tc++ -g^bak/,^old/
Recursively search for the word `copyright' in cpio, jar, pax, tar, zip,
7z archives, compressed and regular files, and in PDFs using a PDF
filter:
$ ugrep -z -w --filter='pdf:pdftotext % -' copyright
Match the binary pattern `A3hhhhA3' (hex) in a binary file without
Unicode pattern matching -U (which would otherwise match `xaf' as a
Unicode character U+00A3 with UTF-8 byte sequence C2 A3) and display the
results in hex with --hexdump with C1 to output one hex line before and
after each match:
$ ugrep -U --hexdump=C1 'xa3[x00-xff]{2}xa3' a.out
Hexdump an entire file using a pager for viewing:
$ ugrep -X --pager '' a.out
List all files that are not ignored by one or more `.gitignore':
$ ugrep -l '' --ignore-files
List all files containing a RPM signature, located in the `rpm' directory
and recursively below up to two levels deeper (3 levels total):
$ ugrep -3 -l -tRpm '' rpm/
Monitor the system log for bug reports and ungroup multiple matches on a
line:
$ tail -f /var/log/system.log | ugrep -u -i -w bug
Interactive fuzzy search with Boolean search queries:
$ ugrep -Q -l -% -Z3 --sort=best
Display all words in a MacRoman-encoded file that has CR newlines:
$ ugrep --encoding=MACROMAN 'w+' mac.txt
Display options related to "fuzzy" searching:
$ ugrep --help fuzzy
COPYRIGHT
Copyright (c) 2021,2024 Robert A. van Engelen <[email protected]>
ugrep is released under the BSD-3 license. All parts of the software
have reasonable copyright terms permitting free redistribution. This
includes the ability to reuse all or parts of the ugrep source tree.
SEE ALSO
ugrep-indexer(1), grep(1), zgrep(1).
BUGS
Report bugs at: <https://github.com/Genivia/ugrep/issues>
ugrep 7.1.1 November 29, 2024 UGREP(1)
- Back to table of contents
For PCRE regex patterns with option -P , please see the PCRE documentation https://www.pcre.org/original/doc/html/pcrepattern.html. The pattern syntax has more features than the pattern syntax described below. For the patterns in common the syntax and meaning are the same.
Note that [[:space:]] and s and inverted bracket lists [^...] are modified in ugrep to prevent matching newlines n . This modification is done to replicate the behavior of grep.
An empty pattern is a special case that matches everything except empty files, ie does not match zero-length files, as per POSIX.1 grep standard.
A regex pattern is an extended set of regular expressions (ERE), with nested sub-expression patterns φ and ψ :
| ลวดลาย | ไม้ขีด |
|---|---|
x | matches the character x , where x is not a special character |
. | matches any single character except newline (unless in dotall mode) |
. | matches . (dot), special characters are escaped with a backslash |
n | matches a newline, others are a (BEL), b (BS), t (HT), v (VT), f (FF), and r (CR) |
| matches the NUL character |
cX | matches the control character X mod 32 (eg cA is x01 ) |
141 | matches an 8-bit character with octal value 141 , ie a |
x7f | matches an 8-bit character with hexadecimal value 7f |
x{3B1} | matches Unicode character U+03B1, ie α |
u{3B1} | matches Unicode character U+03B1, ie α |
o{141} | matches Unicode character U+0061, ie a , in octal |
p{C} | matches a character in Unicode category C |
Q...E | matches the quoted content between Q and E literally |
[abc] | matches one of a , b , or c |
[0-9] | matches a digit 0 to 9 |
[^0-9] | matches any character except a digit and excluding n |
φ? | matches φ zero or one time (optional) |
φ* | matches φ zero or more times (repetition) |
φ+ | matches φ one or more times (repetition) |
φ{2,5} | matches φ two to five times (repetition) |
φ{2,} | matches φ at least two times (repetition) |
φ{2} | matches φ exactly two times (repetition) |
φ?? | matches φ zero or once as needed (lazy optional) |
φ*? | matches φ a minimum number of times as needed (lazy repetition) |
φ+? | matches φ a minimum number of times at least once as needed (lazy repetition) |
φ{2,5}? | matches φ two to five times as needed (lazy repetition) |
φ{2,}? | matches φ at least two times or more as needed (lazy repetition) |
φψ | matches φ then matches ψ (concatenation) |
φ⎮ψ | matches φ or matches ψ (alternation) |
(φ) | matches φ as a group |
(?:φ) | matches φ as a group without capture |
(?=φ) | matches φ without consuming it, ie lookahead (without option -P : nothing may occur after (?=φ) ) |
(?^φ) | matches φ and ignores it, marking everything in the pattern as a non-match |
^φ | matches φ at the start of input or start of a line (nothing may occur before ^ ) |
φ$ | matches φ at the end of input or end of a line (nothing may occur after $ ) |
Aφ | matches φ at the start of input (nothing may occur before A ) |
φz | matches φ at the end of input (nothing may occur after z ) |
bφ | matches φ starting at a word boundary (without option -P : nothing may occur before b ) |
φb | matches φ ending at a word boundary (without option -P : nothing may occur after b ) |
Bφ | matches φ starting at a non-word boundary (without option -P : nothing may occur before B ) |
φB | matches φ ending at a non-word boundary (without option -P : nothing may occur after B ) |
<φ | matches φ that starts a word (without option -P : nothing may occur before < ) |
>φ | matches φ that starts a non-word (without option -P : nothing may occur before > ) |
φ< | matches φ that ends a non-word (without option -P : nothing may occur after < ) |
φ> | matches φ that ends a word (without option -P : nothing may occur after > ) |
(?i:φ) | matches φ ignoring case |
(?s:φ) | . (dot) in φ matches newline |
(?x:φ) | ignore all whitespace and comments in φ |
(?#:X) | all of X is skipped as a comment |
The order of precedence for composing larger patterns from sub-patterns is as follows, from high to low precedence:
(φ) , (?:φ) , (?=φ) , and inline modifiers (?imsux:φ)? , * , + , {n,m}φψ^ , $ , < , > , b , B , A , zφ|ψ(?imsux)φ- Back to table of contents
Character classes in bracket lists represent sets of characters. Sets can be negated (inverted), subtracted, intersected, and merged (not supported by PCRE2 with option -P ):
| ลวดลาย | ไม้ขีด |
|---|---|
[a-zA-Z] | matches a letter |
[^a-zA-Z] | matches a non-letter (character class negation), newlines are not matched |
[az−−[aeiou]] | matches a consonant (character class subtraction) |
[az&&[^aeiou]] | matches a consonant (character class intersection) |
[az⎮⎮[AZ]] | matches a letter (character class union) |
Bracket lists cannot be empty, so [] and [^] are invalid. In fact, the first character after the bracket is always part of the list. So [][] is a list that matches a ] and a [ , [^][] is a list that matches anything but ] and [ , and [-^] is a list that matches a - and a ^ .
Negated character classes such as [^az] do not match newlines for compatibility with traditional grep pattern matching.
- Back to table of contents
The POSIX form can only be used in bracket lists, for example [[:lower:][:digit:]] matches an ASCII lower case letter or a digit.
You can also use the p{C} form for class C and upper case P{C} form that has the same meaning as p{^C} , which matches any character except characters in the class C . For example, P{ASCII} is the same as p{^ASCII} which is the same as [[:^ascii]] .
| POSIX form | ไม้ขีด |
|---|---|
[:ascii:] | matches an ASCII character U+0000 to U+007F including n |
[:space:] | matches a white space character [ tvfr] excluding n |
[:xdigit:] | matches a hex digit [0-9A-Fa-f] |
[:cntrl:] | matches a control character [x00-tx0b-x1fx7f] excluding n |
[:print:] | matches a printable character [x20-x7e] |
[:alnum:] | matches a alphanumeric character [0-9A-Za-z] |
[:alpha:] | matches a letter [A-Za-z] |
[:blank:] | matches a blank character h same as [ t] |
[:digit:] | matches a digit [0-9] |
[:graph:] | matches a visible character [x21-x7e] |
[:lower:] | matches a lower case letter [az] |
[:punct:] | matches a punctuation character [x21-x2fx3a-x40x5b-x60x7b-x7e] |
[:upper:] | matches an upper case letter [AZ] |
[:word:] | matches a word character [0-9A-Za-z_] |
[:^blank:] | matches a non-blank characater H same as [^ t] |
[:^digit:] | matches a non-digit [^0-9] |
POSIX character categories only cover ASCII, [[:^ascii]] is empty and therefore invalid to use. By contrast, [^[:ascii]] is a Unicode character class that excludes the ASCII character category.
Note that the patterns [[:ascii:]] and negated classes such as [[:^digit:]] match newlines, which is the official definition of these POSIX categories. By contrast, GNU/BSD grep never match newlines. As a consequence, more patterns may match.
Negated character classes of the form [^...] match any Unicode character except the given characters and does not match newlines either. For example [^[:digit:]] matches non-digits (including Unicode) and does not match newlines. By contrast, [[:^digit:]] matches ASCII non-digits, including newlines.
Option -U disables Unicode wide-character matching, ie ASCII matching.
| Unicode category | ไม้ขีด |
|---|---|
. | matches any single Unicode character except newline n unless with --dotall |
a | matches BEL U+0007 |
d | matches a digit [0-9] or p{Nd} |
D | matches a non-digit including n |
e | matches ESC U+001b |
f | matches FF U+000c |
h | matches a blank [ t] |
H | matches a non-blank [^ t] including n |
l | matches a lower case letter p{Ll} |
n | matches LF U+000a |
N | matches a non-LF character |
r | matches CR U+000d |
R | matches a Unicode line break ( rn , r , v , f , n , U+0085, U+2028 and U+2029) |
s | matches a white space character [ tvfrx85p{Z}] excluding n |
S | matches a non-white space character and excluding n |
t | matches TAB U+0009 |
u | matches an upper case letter p{Lu} |
v | matches VT U+000b or vertical space character with option -P |
w | matches a word character [0-9A-Za-z_] or [p{L}p{Nd}p{Pc}] |
W | matches a non-Unicode word character including n |
X | matches any ISO-8859-1 or Unicode character including n |
p{Space} | matches a white space character [ tvfrx85p{Z}] excluding n |
p{Unicode} | matches any Unicode character U+0000 to U+10FFFF minus U+D800 to U+DFFF |
p{ASCII} | matches an ASCII character U+0000 to U+007F including n |
p{Non_ASCII_Unicode} | matches a non-ASCII character U+0080 to U+10FFFF minus U+D800 to U+DFFF |
p{L&} | matches a character with Unicode property L& (ie property Ll, Lu, or Lt) |
p{Letter} , p{L} | matches a character with Unicode property Letter |
p{Mark} , p{M} | matches a character with Unicode property Mark |
p{Separator} , p{Z} | matches a character with Unicode property Separator |
p{Symbol} , p{S} | matches a character with Unicode property Symbol |
p{Number} , p{N} | matches a character with Unicode property Number |
p{Punctuation} , p{P} | matches a character with Unicode property Punctuation |
p{Other} , p{C} | matches a character with Unicode property Other |
p{Lowercase_Letter} , p{Ll} | matches a character with Unicode sub-property Ll |
p{Uppercase_Letter} , p{Lu} | matches a character with Unicode sub-property Lu |
p{Titlecase_Letter} , p{Lt} | matches a character with Unicode sub-property Lt |
p{Modifier_Letter} , p{Lm} | matches a character with Unicode sub-property Lm |
p{Other_Letter} , p{Lo} | matches a character with Unicode sub-property Lo |
p{Non_Spacing_Mark} , p{Mn} | matches a character with Unicode sub-property Mn |
p{Spacing_Combining_Mark} , p{Mc} | matches a character with Unicode sub-property Mc |
p{Enclosing_Mark} , p{Me} | matches a character with Unicode sub-property Me |
p{Space_Separator} , p{Zs} | matches a character with Unicode sub-property Zs |
p{Line_Separator} , p{Zl} | matches a character with Unicode sub-property Zl |
p{Paragraph_Separator} , p{Zp} | matches a character with Unicode sub-property Zp |
p{Math_Symbol} , p{Sm} | matches a character with Unicode sub-property Sm |
p{Currency_Symbol} , p{Sc} | matches a character with Unicode sub-property Sc |
p{Modifier_Symbol} , p{Sk} | matches a character with Unicode sub-property Sk |
p{Other_Symbol} , p{So} | matches a character with Unicode sub-property So |
p{Decimal_Digit_Number} , p{Nd} | matches a character with Unicode sub-property Nd |
p{Letter_Number} , p{Nl} | matches a character with Unicode sub-property Nl |
p{Other_Number} , p{No} | matches a character with Unicode sub-property No |
p{Dash_Punctuation} , p{Pd} | matches a character with Unicode sub-property Pd |
p{Open_Punctuation} , p{Ps} | matches a character with Unicode sub-property Ps |
p{Close_Punctuation} , p{Pe} | matches a character with Unicode sub-property Pe |
p{Initial_Punctuation} , p{Pi} | matches a character with Unicode sub-property Pi |
p{Final_Punctuation} , p{Pf} | matches a character with Unicode sub-property Pf |
p{Connector_Punctuation} , p{Pc} | matches a character with Unicode sub-property Pc |
p{Other_Punctuation} , p{Po} | matches a character with Unicode sub-property Po |
p{Control} , p{Cc} | matches a character with Unicode sub-property Cc |
p{Format} , p{Cf} | matches a character with Unicode sub-property Cf |
p{UnicodeIdentifierStart} | matches a character in the Unicode IdentifierStart class |
p{UnicodeIdentifierPart} | matches a character in the Unicode IdentifierPart class |
p{IdentifierIgnorable} | matches a character in the IdentifierIgnorable class |
p{JavaIdentifierStart} | matches a character in the Java IdentifierStart class |
p{JavaIdentifierPart} | matches a character in the Java IdentifierPart class |
p{CsIdentifierStart} | matches a character in the C# IdentifierStart class |
p{CsIdentifierPart} | matches a character in the C# IdentifierPart class |
p{PythonIdentifierStart} | matches a character in the Python IdentifierStart class |
p{PythonIdentifierPart} | matches a character in the Python IdentifierPart class |
To specify a Unicode block as a category use p{IsBlockName} with a Unicode BlockName .
To specify a Unicode language script, use p{Language} with a Unicode Language .
Unicode language script character classes differ from the Unicode blocks that have a similar name. For example, the p{Greek} class represents Greek and Coptic letters and differs from the Unicode block p{IsGreek} that spans a specific Unicode block of Greek and Coptic characters only, which also includes unassigned characters.
- Back to table of contents
For the pattern syntax of ugrep option -P (Perl regular expressions), see for example Perl regular expression syntax. However, ugrep enhances the Perl regular expression syntax with all of the features listed in POSIX regular expression syntax.
- Back to table of contents
If something is not working, then please check the tutorial and the man page. If you can't find it there and it looks like a bug, then report an issue on GitHub. Bug reports are quickly addressed.
Copyright (c) Robert van Engelen, 2024
