ugrep
v7.1.1
[リードミー|ユーザーガイド |インデックス作成 |ベンチマーク | Ｑ＆Ａ】
オプション -Q を使用すると、入力時にファイルを検索するためのクエリ TUI が開きます。
ugrep は高速でユーザーフレンドリーで、ユーザーが望んでいたたくさんの新機能を備えています
組み込みヘルプを備えた対話型 TUI、AND/OR/NOT パターンを使用した Google のような検索、あいまい検索、(ネストされた) zip/7z/tar/pax/cpio アーカイブ、tarball および圧縮ファイル gz/Z/bz/ の検索が含まれます。 bz2/lzma/xz/lz4/zstd/brotli、バイナリ ファイルの検索と hexdump、PDF、doc、docx などのドキュメントの検索、および出力JSON、XML、CSV、または独自にカスタマイズした形式
特別なコマンドライン オプションを必要としない、複数行のパターン マッチングを備えた Unicode 拡張正規表現パターン構文
低速でコールドなファイル システムの検索を高速化するファイル インデクサーが含まれています
GNU grep の真のドロップイン代替品 (実際には互換性のないコマンドラインを実装している場合に「 ug代替手段」または「代替手段」であると主張する他の一般的な grep とは異なります (ug をgrep 、 egrep 、およびfgrepにコピーまたはシンボリックリンクすることを前提としています)オプションを使用し、互換性のない正規表現マッチャーを使用します。つまり、ugrep がサポートする場合は Perl 正規表現のみと POSIX BRE (grep) および ERE (egrep) を使用します。すべての正規表現モード
ベンチマークは、ugrep が高性能 DFA ベースの正規表現マッチャー RE/flex を使用した最速の grep (の 1 つ) であることを示しています。
何かを改善したり、ugrep に追加したりする必要がある場合は、私に知らせてください。
最優先事項は、ugrep にバグがなく信頼性があることを継続的に確認するための品質保証です。
ugrep の実行をさらに高速化します。たとえば #432、#421 を参照してください。
再現可能なパフォーマンス結果を共有する
ug対話型で使用するためのもので、作業ディレクトリまたはホーム ディレクトリにあるオプションの .ugrep 設定ファイルをロードします。ug ug+ PDF、ドキュメント、電子書籍、画像メタデータも検索します。
ugrep 、.ugrep 設定ファイルを使用せずに GNU grep のようにバッチで使用します。ugrep ugrep+ PDF、ドキュメント、電子書籍、画像メタデータも検索します
デフォルトで Unicode パターンに一致し、UTF-8、UTF-16、および UTF-32 でエンコードされたファイルを自動的に検索します
正規表現パターン内のnまたはR含む複数の行と一致します。これを行うために特別なオプションは必要ありません。
組み込みヘルプ: ug --help 、 ug --help WHAT探しているWHATに関連するオプションを表示します。
ug --help regex 、 ug --help globs 、 ug --help fuzzy 、 ug --help format 。
対話型での使用を目的としたugコマンドで使用されるカスタマイズ可能な構成ファイルにより、ユーザーフレンドリーであり、好みの .ugrep 構成ファイルをロードします。
ug PATTERN ... ugrep --config PATTERN ...
ug --save-config ...options-you-want-to-save...作業ディレクトリに .ugrep 設定ファイルを保存します。これにより、次回そこでug実行するときにこれらのオプションが使用されます。これをホーム ディレクトリで実行して、通常使用するオプションを含む .ugrep 構成ファイルを保存します。
対話型クエリ TUI。F1 または CTRL-Z を押してヘルプを表示し、TAB/SHIFT-TAB を押してディレクトリおよびファイルに移動します
ug -Q ug -Q -e PATTERN
-Qコマンド ラインのPATTERNを置き換え、TUI で対話的にパターンを入力できるようにします。 TUI では、ALT + 文字キーを使用して短い「文字オプション」のオン/オフを切り替えます。たとえば、ALT-n (オプション-n ) で行番号の表示/非表示を切り替えます。
アーカイブ (zip、tar、pax、jar、cpio、7z) および圧縮ファイル (gz、Z、bz、bz2、lzma、xz、lz4、zstd、brotli) のコンテンツを検索します。
ug -z PATTERN ... ug -z --zmax=2 PATTERN ...
-z --zmax=2を指定すると、圧縮ファイルおよびアーカイブ内にネストされたアーカイブが検索されます。 --zmax引数の範囲は 1 (デフォルト) から 99 までで、ネストされたアーカイブを検索するための最大 99 の解凍およびアーカイブ解除ステップが可能です。
AND (またはスペースのみ)、 OR (またはバー| )、 NOT (またはダッシュ- ) を使用した-%パターンを使用し、引用符を使用して正確に一致させ、 ( )でグループ化して、Google のようなブール クエリ パターンで検索します (下の左側）;または、オプション-e (「or」として)、 --and 、 --andnot 、および--not正規表現パターンを使用します (以下の右側に示されています)。
ug -% 'A B C' ... ug -e 'A' --and 'B' --and 'C' ...
ug -% 'A|B C' ... ug -e 'A' -e 'B' --and 'C' ...
ug -% 'A -B -C' ... ug -e 'A' --andnot 'B' --andnot 'C' ...
ug -% 'A -(B|C)'... ug -e 'A' --andnot 'B' --andnot 'C' ...
ug -% '"abc" "def"' ... ug -e 'QabcE' --and 'QdefE' ...
ここで、 A 、 B 、およびC任意の正規表現パターンです (文字列を検索するにはオプション-Fを使用します)
オプション-%% ( --bool --files ) を指定して、ファイル全体にブール クエリを適用します。ファイル全体のパターンの一致によってすべてのブール条件が満たされる場合、ファイルは一致します。それ以外の場合、grep ユーティリティは一般に行ベースのパターン マッチャーであるため、デフォルトでブール条件が単一行に適用されます。オプション--stats検索の完了後にクエリを人間が判読できる形式で表示します。
ファイル名拡張子に関連付けられたフィルターを使用して、 ug+で PDF、doc、docx、電子書籍などを検索します。
ug+ PATTERN ...
または、フィルター ユーティリティを使用するには、ファイル タイプを指定して--filter指定します。
ug --filter='pdf:pdftotext % -' PATTERN ...
ug --filter='doc:antiword %' PATTERN ...
ug --filter='odt,docx,epub,rtf:pandoc --wrap=preserve -t plain % -o -' PATTERN ...
ug --filter='odt,doc,docx,rtf,xls,xlsx,ppt,pptx:soffice --headless --cat %' PATTERN ...
ug --filter='pem:openssl x509 -text,cer,crt,der:openssl x509 -text -inform der' PATTERN ...
ug --filter='latin1:iconv -f LATIN1 -t UTF-8' PATTERN ...
ug+コマンドはugコマンドと同じですが、フィルタを使用して PDF、ドキュメント、画像メタデータを検索します。
オプション-o ( --only-matching ) とコンテキスト オプション-ABCを使用して水平コンテキストを表示します。たとえば、JavaScript や JSON ソースなどの非常に長い行で一致を検索します。
ug -o -C20 -nk PATTERN longlines.js
-o -C20 、一致の前 20 文字と一致後の 20 文字のコンテキストを持つすべての一致 (つまり、合計 40 Unicode 文字) に適合します。 -nk 、行番号と列番号を出力します。
指定されたレーベンシュタイン距離内で、あいまい検索を使用して近似パターンの一致を検索します。
ug -Z PATTERN ... ug -Z3 PATTTERN ...
-Zn最大nの追加文字、欠落文字、または置換文字に一致します。 -Z+n最大n個の追加文字に一致します。 -Zn最大nの欠落文字に一致し、 -Z~n最大nの置換文字に一致します。 -Zデフォルトは-Z1です。
正規表現による Fzf のような検索 (または-Fによる固定文字列)、 -Z+4による最大 4 つの追加文字とのあいまい一致、 -wによる単語のみ、ファイル全体のブール検索には-%%使用
ug -Q -%% -l -w -Z+4 --sort=best
-l TUI 内の一致するファイルをリストします。Tab TABを押してからALT-y押してファイルを表示します。SHIFT SHIFT-TABとAlt-lを押して戻ると、最も一致する順に並べられた一致ファイルのリストが表示されます。
バイナリ ファイルを検索し、バイナリ パターンに一致する 16 進ダンプを表示します (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文字列c 、16 進間隔hなしで、一致の前後に 1 つの追加の 16 進行C1を付けずに4列の 16 進数を表示します。
ファイル タイプまたはファイル「マジック バイト」で検索するファイルを含めるか、 ^で除外します。
ug -t TYPE PATTERN ... ug -t ^TYPE PATTERN ...
ug -M 'MAGIC' PATTERN ... ug -M '^MAGIC' PATTERN ...
gitignore スタイルのグロブに一致するファイルとディレクトリを検索対象に含めるか、 ^で除外します。
ug -g 'FILEGLOB' PATTERN ... ug -g '^FILEGLOB' PATTERN ...
ug -g 'DIRGLOB/' PATTERN ... ug -g '^DIRGLOB/' PATTERN ...
ug -g 'PATH/FILEGLOB' PATTERN ... ug -g '^PATH/FILEGLOB' PATTERN ...
ug -g 'PATH/DIRGLOB/' PATTERN ... ug -g '^PATH/DIRGLOB/' PATTERN ...
ファイル名拡張子 (サフィックス) で検索するファイルを含めるか、 -g"*.EXT"の短縮形である^を使用してファイルを除外します。
ug -O EXT PATTERN ... ug -O ^EXT PATTERN ...
検索対象の隠しファイル (ドットファイル) とディレクトリを含めます (デフォルトでは省略されています)
ug -. PATTERN ... ug -g'.*,.*/' PATTERN ...
常にugで隠しファイルを検索するには、 .ugrep でhidden指定します。
.gitignore などで指定されたファイルを除外します。
ug --ignore-files PATTERN ... ug --ignore-files=.ignore PATTERN ...
.ugrep でignore-files指定すると、常にugで無視されます。必要に応じて、 ignore-files=...を追加します。
否定的なパターン (「これには一致するが、あれには一致しない」) を除く検索パターン
ug -e PATTERN -N NOTPATTERN ... ug -e '[0-9]+' -N 123 ...
事前定義された正規表現パターンを使用して、ソース コード、JavaScript、XML、JSON、HTML、PHP、マークダウンなどを検索します。
ug PATTERN -f c++/zap_comments -f c++/zap_strings ...
ug PATTERN -f php/zap_html ...
ug -f js/functions ... | ug PATTERN ...
一致するファイルを名前、最適一致、サイズ、時間で並べ替えます
ug --sort PATTERN ... ug --sort=size PATTERN ...
ug --sort=changed PATTERN ... ug --sort=created PATTERN ...
ug -Z --sort=best PATTERN ... ug --no-sort PATTERN ...
CSV、JSON、XML、およびユーザー指定の形式で結果を出力します
ug --csv PATTERN ... ug --json PATTERN ...
ug --xml PATTERN ... ug --format='file=%f line=%n match=%O%~' PATTERN ...
ug --help formatカスタマイズされた出力のフォーマット%フィールドに関するヘルプを表示します。
PCRE の Perl 互換の正規表現パターンで検索し、サブパターンの一致を表示または置換します
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でオプションで使用する format %フィールドに関するヘルプを表示します。
ISO-8859-1 ～ 16、CP 437、CP 850、MACROMAN、KOI8 などの特定のエンコード形式のファイルを検索します。
ug --encoding=LATIN1 PATTERN ...
Homebrew を使用して最新の ugrep をインストールします。
$ brew install ugrep
または MacPorts を使用してインストールします。
$ sudo port install ugrep
これにより、 ugrepおよびugコマンドがインストールされます。ug ug ugrepと同じですが、作業ディレクトリまたはホーム ディレクトリに存在する場合は構成ファイル .ugrep もロードされます。
Winget でインストールwinget install Genivia.ugrep
または Chocolatey choco install ugrepでインストールします
または、Scoop scoop install ugrepでインストールします
または、フル機能のugrep.exe実行可能ファイルをリリース アーティファクトとして https://github.com/Genivia/ugrep/releases からダウンロードします。 zip 形式のリリースには、メインのugrep.exeバイナリとug.exe含まれています。 ugコマンドは対話型での使用を目的としており、 .ugrep構成ファイル (作業ディレクトリまたはホーム ディレクトリに存在する場合) から設定をロードして読み取ります。
ugrep.exeとug.exeを実行パスに追加します。 [設定]に移動し、 [設定の検索]で「パス」を検索します。 [環境変数] -> [パス] -> [新規]を選択し、 ugrep.exeおよびug.exe実行可能ファイルを配置したディレクトリを追加します。
ヒント
Windows コマンド ラインでugrep.exeおよびug.exe使用する場合の実用的なヒント:
'引用符を使用せず、代わりに"を使用してください。ほとんどの Windows コマンド ユーティリティでは、一'引用符がコマンド ライン引数の一部であるとみなされます。GLOBコマンド ライン引数の代わりにオプション-g/GLOBを使用して指定するのが最適です。""を指定すると、これは Powershell などの一部の Windows コマンド インタープリターによって無視される場合があります。その場合は、代わりにオプション--matchを指定する必要があります。n代わりにR使用して、 rnペアや単一のrとnなどの Unicode 改行と一致させたい場合があります。 $ 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 がインストールされていない場合は、 sudo apt-get install -y libpcre2-devなどで PCRE2 をインストールするか、PCRE2 をダウンロードしてインストール手順に従います。あるいは、Boost.Regex をダウンロードし、 ./bootstrap.shおよびsudo ./b2 --with-regex installを実行します。 「Boost: はじめに」を参照してください。
オプション-z (圧縮ファイルとアーカイブの検索) を使用するには、zlib ライブラリがインストールされている必要があります。ほとんどのシステムにインストールされています。そうでない場合は、たとえばsudo apt-get install -y libz-devを使用してインストールします。 .bzおよび.bz2ファイルを検索するには、たとえばsudo apt-get install -y libbz2-devを使用して、bzip2 ライブラリ (推奨) をインストールします。 .lzmaおよび.xzファイルを検索するには、たとえばsudo apt-get install -y liblzma-devを使用して、lzma ライブラリ (推奨) をインストールします。 .lz4ファイルを検索するには、たとえばsudo apt-get install -y liblz4-devを使用して、lz4 ライブラリ (オプション、必須ではありません) をインストールします。 .zstファイルを検索するには、 sudo apt-get install -y libzstd-devなどを使用して、zstd ライブラリ (オプション、必須ではありません) をインストールします。 .brファイルを検索するには、 sudo apt-get install -y libbrotli-devなどを使用して、brotli ライブラリ (オプション、必須ではありません) をインストールします。 .bz3ファイルを検索するには、たとえばsudo apt-get install -y bzip3を使用して、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
これにより、 ./configureとmake -jを使用してugrep/srcディレクトリにugrep実行可能ファイルがビルドされ、 make testで検証されます。すべてのテストに合格すると、 ugrep実行可能ファイルがugrep/bin/ugrepにコピーされ、シンボリックリンクugrep/bin/ug -> ugrep/bin/ugrepがugコマンドに追加されます。
ug ugrepと同じですが、作業ディレクトリまたはホーム ディレクトリに存在する場合、設定ファイル .ugrep もロードすることに注意してください。これは、.ugrep でugのデフォルト オプションを定義できることを意味します。
インストールされたライブラリまたはローカル ライブラリへの代替パスは、 ./build.shで指定できます。利用可能なビルド オプションに関するヘルプを表示するには:
$ ./build.sh --help
以下を指定して静的実行可能ファイルをビルドできます。
$ ./build.sh --enable-static
brotli など、ライブラリが静的にリンクされていない場合、これは失敗する可能性があります。その場合は、 ./build.sh --enable-static --without-brotliを試してください。
ポケベルなど、カスタマイズされたデフォルトを有効にしてugrep構築できます。
$ ./build.sh --enable-pager
ビルドのデフォルトを選択するオプションには次のものがあります。
--helpビルド オプションを表示します--enable-static可能であれば、静的実行可能ファイルをビルドします--enable-hidden常に隠しファイルとディレクトリを検索します--enable-pager常にページャーを使用して端末に出力を表示します--enable-pretty端末への出力を色付けし、ファイル名の見出しを追加します--disable-auto-color自動カラーを無効にします。色を表示するには、ugrep オプション--color=autoが必要です--disable-mmapメモリマップされたファイルを無効にする--disable-sse2 SSE2 と AVX の最適化を無効にします--disable-avx2 AVX2 および AVX512BW の最適化を無効にしますが、サポートされている場合は SSE2 でコンパイルします。--disable-neon ARM NEON/AArch64 の最適化を無効にします--with-grep-path GREP_PATHが定義されていない場合のデフォルトの-fパス--with-grep-colors GREP_COLORSが定義されていない場合のデフォルトの色ビルドが完了したら、 ugrep/bin/ugrepとugrep/bin/ugを、 ~/binディレクトリなどの便利な場所にコピーします。または、 ugrepおよびugコマンドとマニュアル ページをインストールする場合は、次のようにします。
$ sudo make install
これにより、オプション-fの事前定義されたパターンを含むパターン ファイルも/usr/local/share/ugrep/patterns/にインストールされます。オプション-f 、まず作業ディレクトリでパターン ファイルの存在を確認し、見つからない場合は環境変数GREP_PATH確認してパターン ファイルをロードし、見つからない場合はインストールされている事前定義パターン ファイルを読み取ります。
残念ながら、git クローンはタイムスタンプを保持しないため、「警告: システムに 'aclocal-1.15' がありません。」というメッセージが表示される可能性があります。または、 make実行時に自動ヘッダーが見つからなかった。
この問題を回避するには、次を実行します。
$ autoreconf -fi
$ ./build.sh
GCC 8 以降では、 「注: 引数にパラメータを渡す ... GCC 7.1 で変更されました」のような警告が生成される場合があります。これらの警告は無視してください。
Ubuntu コンテナーでugrep構築するための Dockerfile が含まれています。
開発者は、たとえば ThreadSanitizer でデータ競合を検出するなど、重要な変更を行うときにサニタイザーを使用してugrepコードを検証することをお勧めします。
$ ./build.sh CXXFLAGS='-fsanitize=thread -O1 -g'
私たちは、clang AddressSanitizer、MemorySanitizer、ThreadSanitizer、および UnknownBehaviorSanitizer を使用してugrepチェックしました。これらのオプションは実行時に重大なオーバーヘッドを引き起こすため、最終ビルドには使用しないでください。
?目次に戻る
ugrepおよびugコマンドはデフォルトでバイナリ ファイルを検索し、.gitignore で指定されたファイルを無視しないことに注意してください。これにより、オプション-Iおよび--ignore-filesが使用されない限り、再帰的検索パフォーマンスの比較は意味を持ちません。これらのオプションをugのデフォルトにするには、単にignore-binaryとignore-files .ugrep設定ファイルに追加します。
最新の ugrep の最新のパフォーマンス比較については、ugrep パフォーマンス ベンチマークを参照してください。 Ugrep は、GNU grep、Silver Searcher、ack、sift よりも高速です。 Ugrep の速度は、ほとんどのベンチマークで ripgrep を上回ります。
まず、ファイルを再帰的に検索するために Vim で:grepコマンドを定義しましょう。これを行うには、ルート ディレクトリにある.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
これは、Vim :grepコマンドで-j大文字と小文字を区別しない検索を指定します。大文字と小文字を区別して検索するには、 grepprgから -j削除します。同じ行にある複数の一致は、クイックフィックス ウィンドウに個別にリストされます。これが望ましくない場合は、 grepprgから -u削除してください。この変更により、行上の最初の一致のみが表示されます。オプション--ignore-files .gitignoreファイルで指定されたファイルをスキップします (存在する場合)。再帰的検索の深さを現在のディレクトリのみに制限するには、 grepprgに -1を追加します。
これで、Vim で Vim :grepコマンドを呼び出して、指定したPATH上のファイルでPATTERN一致を検索できるようになりました。
:grep PATTERN [PATH]
PATH省略すると、作業ディレクトリが検索されます。 Vim で現在開いているファイルのみを検索するには、 PATHとして%を使用します。
:grep PATTERN %
:grepコマンドを使用すると、クイックフィックス ウィンドウに結果が表示され、見つかった一致にすばやくジャンプできます。
最新の一致リストを表示するクイックフィックス ウィンドウを開くには:
:copen
このウィンドウ内の行をダブルクリックして (または行を選択して Enter キーを押して)、一致するファイルおよびファイル内の場所にジャンプします。コマンド:cnおよび:cp入力すると、それぞれ次または前の一致にジャンプします。クイックフィックス ウィンドウの検索結果を更新するには、検索結果を grep するだけです。たとえば、作業ディレクトリ内でFIXMEとマークされた C++ ソース コードを再帰的に検索するには、次のようにします。
:grep -tc++ FIXME
クイックフィックスウィンドウを閉じるには:
:cclose
:grepコマンドでugrepオプションを使用すると、たとえば、現在のファイル内の単一行および複数行のコメントを選択できます。
:grep -f c++/comments %
スペースを節約するために、クイックフィックスには複数行のコメントの最初の行のみが表示されます。複数行の一致のすべての行を表示するには、 grepformatから%-G削除します。
人気のある Vim ツールは ctrlp.vim で、次のものとともにインストールされます。
$ cd ~/.vim
$ git clone https://github.com/kien/ctrlp.vim.git bundle/ctrlp.vim
CtrlP は、次の行を.vimrcに追加することでugrep を使用します。
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ディレクトリの検索を 3 レベル (作業ディレクトリとその下の 2 レベルまで) に制限します。
Vim を起動し、次のコマンドを入力します。
:helptags ~/.vim/bundle/ctrlp.vim/doc
Vim で CtrlP ドキュメントを表示するには、次のコマンドを入力します。
:help ctrlp.txt
?目次に戻る
Manuel Uberti のおかげで、Emacs でugrep を使用できるようになりました。 Emacs 内で GNU grep の代わりにugrep を使用するには、 .emacs.d/init.elファイルに次の行を追加します。
(setq-default xref-search-program ‘ugrep)
これは、 Xref に依存するproject-find-regexpなどの Emacs コマンドがugrepの機能を活用できるようになったということを意味します。
さらに、Emacs grep コマンドでgrep使用することもできます。たとえば、 grep-template次のようにカスタマイズすることで、 ugrepでlgrep実行できます。
(setq-default grep-template "ugrep --color=always -0Iinr -e <R>")
Emacs バージョン 29 (以降) をお持ちでない場合は、Emacs master ブランチから Emacs をダウンロードしてビルドするか、 ugrepとの Xref 統合を手動で有効にすることができます。
(with-eval-after-load 'xref
(push '(ugrep . "xargs -0 ugrep <C> --null -ns -e <R>")
xref-search-program-alist)
(setq-default xref-search-program 'ugrep))
?目次に戻る
すぐに使用できるugrep は、標準の GNU/BSD grep コマンドライン オプションをすべてサポートしており、それらの多くも改善しています。詳細については、grep に対する顕著な改善点を参照してください。
GNU/BSD grep ASCII/LATIN1 の非 UTF Unicode パターンに厳密にこだわりたい場合は、オプション-U使用して完全な Unicode パターン マッチングを無効にします。
実際、オプション-U 、 -Y 、 - を指定してugrep実行します-. --sort使用すると、 egrepとまったく同じように動作し、ASCII/LATIN1 の非 UTF Unicode パターンのみに一致し、空のパターンが隠しファイルを無視するのではなく、一致および検索できるようになります。 grep の等価性を参照してください。
オプション-U 、 -Y 、 -. --sortまたは必要に応じて他のオプションを含めます。
または、 ugrepこれらの名前にコピーすることで、 grep 、 egrepおよびfgrep実行可能ファイルを作成できます。 ugrep (またはugrep.exe ) 実行可能ファイルがgrep ( grep.exe )、 egrep ( egrep.exe )、 fgrep ( fgrep.exe ) としてコピーされ、オプション-U 、 -Yおよび-. -G ( grep 、 -E ( egrep 、 -F ( fgrepのいずれかを指定すると、自動的に有効になります。さらに、 zgrep 、 zegrep 、 zfgrepとしてコピーすると、オプション-zが有効になります。たとえば、 ugrepがzegrepとしてコピーされる場合、オプションは-z 、 -E 、 -Y 、 -.および--sortが有効になっています。
同様に、 ugrepへのシンボリックリンクとハードリンクも、 grep 、 egrep 、およびfgrep置換を作成するために正常に機能します。たとえば、シンボリックリンクegrep作成するには、次のようにします。
sudo ln -s `which ugrep` /opt/local/bin/egrep
/opt/local/bin単なる例であり、 $pathに含まれる場合と含まれない場合があり、 $pathに応じてegrep実行時に見つかる場合と見つからない場合があります。
次のオプションを使用した場合、 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 UTF-8 シーケンス C2 A3 で表される Unicode コード ポイント U+00A3 ではなく、バイト A3 と一致します。 ugrep のデフォルトでは、 xa3 U+00A3 と一致します。テキスト パターンの検索には-U使用せず、バイナリ検索、またはこれらのファイルをバイナリとして報告せずに latin-1 (iso-8859-1) ファイルを検索する場合にのみ使用することをお勧めします (ugrep v3.5.0 以降)。-Y空の一致を有効にするため、たとえばパターンa* 、 aのシーケンスではなくすべての行に一致します。 ugrep のデフォルトでは、パターンa* aのシーケンスと一致します。さらに、ugrep では、パターンa*b*c*は、デフォルトで一致すると想定されているものと一致します。改善点を参照してください。-.隠しファイル (ドットファイル) を検索します。デフォルトでは、ほとんどの Unix ユーティリティと同様に、隠しファイルは無視されます。--sort 、パス名でソートされた出力を指定します。最初にソートされた一致ファイルが表示され、続いてサブディレクトリ内のソートされた再帰的一致が表示されます。それ以外の場合、パフォーマンスを向上させるために、一致するファイルは特定の順序で報告されません。-Dreadと-dread GNU/BSD grep のデフォルトですが、推奨されません。説明については改善点を参照してください。?目次に戻る
生産性を向上させるために.bashrcに追加する一般的に使用されるエイリアス:
alias uq = 'ug -Q' # interactive TUI search (uses .ugrep config)
alias uz = 'ug -z' # compressed files and archives search (uses .ugrep config)
alias ux = 'ug -U --hexdump' # binary pattern search (uses .ugrep config)
alias ugit = 'ug -R --ignore-files' # works like git-grep & define your preferences in .ugrep config
alias grep = 'ug -G' # search with basic regular expressions (BRE) like grep
alias egrep = 'ug -E' # search with extended regular expressions (ERE) like egrep
alias fgrep = 'ug -F' # find string(s) like fgrep
alias zgrep = 'ug -zG' # search compressed files and archives with BRE
alias zegrep = 'ug -zE' # search compressed files and archives with ERE
alias zfgrep = 'ug -zF' # find string(s) in compressed files and/or archives
alias xdump = 'ugrep -X ""' # hexdump files without searching (don't use .ugrep config)
alias zmore = 'ugrep+ -z -I -+ --pager ""' # view compressed, archived and regular files (don't use .ugrep config)
?目次に戻る
-Qを使用して対話型クエリ TUI を開始します。n 。-Uで無効になります)。--bool )。--ignore-filesオプションを使用して gitignore をサポートします。-Zによるあいまい (近似) マッチングをサポートします。-zを使用して圧縮ファイルとアーカイブを検索します。-zを使用して cpio、jar、pax、tar、zip、および 7z アーカイブを検索します。-zおよび--zmax=NUMを指定してアーカイブ内に保存された cpio、jar、pax、tar、zip、および 7z アーカイブを最大NUMレベルまで再帰的に検索します。--filterで pdf、doc、docx、xls、xlsx、epub などを検索します。-rを使用します。-.で有効になります)。-Eは egrep であり、 -G BRE を有効にします)。-J1で無効になります)。-W (バイナリ一致を 16 進数で出力し、テキスト一致出力を通常どおり出力) および-X (すべての一致を 16 進数で出力) を使用して 16 進ダンプを生成します。--formatオプションを使用) で一致を出力できます。-f 、 GREP_PATH環境変数、または/usr/local/share/ugrep/patternsにインストールされている事前定義パターンを使用します。 -fが指定され、1 つ以上の-eパターンも指定されている場合、オプション-F 、 -x 、および-w -fパターンに適用されません。これは、これらのオプションで適切に動作しなくなる可能性がある事前定義されたパターンで-fを使用した場合の混乱を避けるためです。-O 、 -M 、および-tそれぞれファイル拡張子、ファイル署名のマジック バイト パターン、および事前定義されたファイル タイプを指定します。これにより、たとえば再帰検索オプション-Rおよび-rを使用して、ディレクトリ ツリー内の特定の種類のファイルを検索できるようになります。オプション-O 、 -M 、および-t 、cpio、jar、pax、tar、zip、および 7z ファイル内のアーカイブ ファイルにも適用されます。-k , --column-number 、オプション--tabsで指定されたようにタブを展開することでタブ間隔を考慮して列番号を表示します。-P (Perl 正規表現) は、後方参照 ( --formatを使用) と後読みをサポートします。これは、PCRE2 または Boost.Regex ライブラリを使用して、PCRE のような構文で高速に Perl 正規表現を照合します。-bとオプション-oまたはオプション-uを併用すると、ugrep は、GNU/BSD grep によって報告される一致した行の先頭のバイト オフセットではなく、パターン一致の正確なバイト オフセットを表示します。-u 、 --ungroup使用すると、複数の一致を 1 行にグループ化しません。このオプションは、行上の追加のパターン一致ごとに、一致した入力行を再度表示します。このオプションは、ファイルごとに一致した行数ではなく、ファイルごとのパターン一致の総数を報告するオプション-cと併用すると特に便利です。-Y使用すると、空のパターンの照合が有効になります。空の一致パターンを使用した grep は奇妙で、GNU grep と BSD grep では異なる結果が得られます。デフォルトでは、空の一致はugrepによって出力されません。これにより、「ランダムな」結果が生じる可能性のある間違いを回避できます。たとえば、GNU/BSD grep では、パターンa*入力内のすべての行と一致し、実際にはxyzと 3 回一致します ( x 、 y 、 z前と間の空の遷移)。空の一致を許可するには、 ugrepオプション-Yが必要です。 ^で始まるか$で終わるパターン ( ^h*$など) は空と一致します。これらのパターンでは、オプション-Yが自動的に有効になります。-D, --devices=ACTIONは、デフォルトではreadではなくskipます。これにより、デフォルトでデバイスをread GNU/BSD grep で発生する可能性がある、再帰的に検索されるディレクトリ内の名前付きパイプで予期せずハングすることが防止されます。-d, --directories=ACTIONは、デフォルトではreadではなくskipます。デフォルトでは、コマンドラインで指定されたディレクトリが検索されますが、サブディレクトリのさらに深くまで再帰的に検索されることはありません。-N PATTERNを提供します。これは、すべてのX入力をスキップし、検索からX削除する形式(?^X)のパターンです。たとえば、否定パターンを使用すると、ソース コード内の識別子を検索するときに文字列やコメントをスキップし、文字列やコメントに含まれない一致を見つけることができます。事前定義されたzapパターンは否定パターンを使用します。たとえば、C++ コメント内のパターン一致を無視するには、 -f cpp/zap_commentsを使用します。GREP_OPTIONS環境変数を無視します。また、GNU grep はこの理由でGREP_OPTIONS放棄しました。作業ディレクトリまたはホーム ディレクトリ (存在する場合) にある .ugrep 構成ファイルをロードするugコマンドを使用するか、シェル エイリアスを使用して特定の検索オプションを備えた新しいコマンドを作成してください。?目次に戻る
作業ディレクトリまたはホーム ディレクトリに配置された構成ファイル.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
C++ ファイルで正規表現パターンを使用して#define (および# defineなど) を検索するには ( *と?のシェルのグロビングを防ぐためにパターンを引用符で囲む必要があることに注意してください):
ug -tc++ '#[t ]*define'
ディレクトリmyproject内のシンボリックリンク ( -r ) をたどらずにmainを単語 ( -w ) として再帰的に検索し、一致した行の隣に一致する行番号 ( -n ) と列番号 ( -k ) を表示するには、次のようにします。
ug -r -nkw main myproject
同じですが、深く再帰せずにmyprojectのみを検索します (デフォルトでは、ディレクトリ引数は 1 つのレベルで検索されることに注意してください)。
ug -nkw main myproject
同じですが、 -2を使用してmyprojectと 1 つ深いサブディレクトリ レベル (2 レベル) を検索します。
ug -2 -nkw main myproject
同じですが、 -tc++を使用してmyprojectとそのサブディレクトリ内の C++ ファイルのみを検索します。
ug -tc++ -2 -nkw main myproject
同じですが、 -zを使用すると、アーカイブ (zip ファイルや tar ファイルなど) および圧縮ファイル内も検索できます。
ug -z -tc++ -2 -nkw main myproject
gitignored ファイルを無視して、 mainの作業ディレクトリを再帰的に検索します (たとえば、 .gitignoreが作業ディレクトリ以下にあると仮定します)。
ug --ignore-files -tc++ -nkw main
.gitignoreファイルによって無視されない、作業ディレクトリ以降のすべてのファイルをリストするには、次のようにします。
ug --ignore-files -l ''
-t引数に対応して検索されるファイル名拡張子と「マジック バイト」（シバン）のリストを表示するには、次のようにします。
ug -tlist
-lを使用した拡張子とシバンに基づいて、すべてのシェル ファイルを再帰的にリストするには ( ''空でないファイルに一致することに注意してください)。
ug -l -tShell ''
?目次に戻る
文字列やコメント ブロックを無視してソース コード内のmainを検索するには、オプション-N指定して否定パターンを使用し、C/C++ で引用された文字列やコメント ブロック内の不要な一致をスキップします。
ug -r -nkw -e 'main' -N '"(\.|\r?n|[^\n"])*"|//.*|/*(.*n)*?.**+/' myproject
正しく入力するのは大変な作業です。あなたも私と同じなら、もっと重要なことに取り組んでいるときに、正規表現パターンをいじることに時間を費やしたくないでしょう。 ugrepツールとともにインストールされるugrepの事前定義パターン ( -f ) を使用する簡単な方法があります。
ug -r -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
このクエリは、README、Makefile など、C/C++ ソース コード以外のファイルも検索します。 -rを使用してシンボリックリンクもスキップします。 C/C ++ファイルを選択して、オプション-tc,c++使用してC/C ++ファイルを選択して、 -RのファイルとディレクトリにSymlinksを含めることにより、このクエリを改善しましょう。
ug -R -tc,c++ -nkw 'main' -f c/zap_strings -f c/zap_comments myproject
識別子mainのみを探したいが、 mainh*( main(としてではない場合はどうなりますか？
ug -R -tc,c++ -nkw -e 'main' -N 'mainh*(' -f c/zap_strings -f c/zap_comments myproject
これにより、 -eおよび-Nオプションを使用して、それぞれパターンとネガティブパターンを明示的に指定します。これは、基本的にパターンmain|(?^mainh*()形成します。ここで、 hスペースとタブと一致します。一般に、ネガティブパターンは、興味のないパターンマッチを除外するのに役立ちます。
別の例として、C/C ++コメントブロックでFIXME単語を検索したいとします。そのために、最初にUGREPの事前定義されたc/commentsパターンでコメントブロックを選択し、次にパイプを使用してFIXMEで行を選択することができます。
ug -R -tc,c++ -nk -f c/comments myproject | ug -w 'FIXME'
パイプで結果をフィルタリングすることは、一般に、一部の検索ツールが使用するロジックを使用するよりも簡単です。このアプローチは、UNIXスピリットに従って、ユーティリティをシンプルに保ち、より複雑なタスクのために組み合わせて使用します。
文字列やコメントをスキップしながら、Javaソースコードで見つかったすべての識別子のソートされたリストを作成しましょう。
ug -R -tjava -f java/names myproject | sort -u
これは、regex p{JavaIdentifierStart}p{JavaIdentifierPart}* patterns/java/namesで定義されているJava Unicode識別子と一致します。
従来のグレップとグレップのようなツールを使用すると、関数qsortを定義するC/C ++ソースファイルを再帰的に検索するのに多大な努力が必要です。
ug -R --include='*.c' --include='*.cpp' '^([ t]*[[:word:]:*&]+)+[ t]+qsort[ t]*([^;n]+$' myproject
幸いなことに、 UGREPを使用すると、Option -Oc,cpp使用し、すべての関数定義を生成するツールでインストールされている定義済みパターンfunctions使用して、拡張機能.cまたは.cppを使用してファイル内のすべての関数定義を選択できます。次に、必要なものを選択します。
ug -R -Oc,cpp -nk -f c/functions | ug 'qsort'
-tc,c++使用してC/C ++ファイルを選択できたことに注意してください。ただし、 .cおよび.cppファイルのみを検索する場合はヘッダーファイルも含まれます。
また、 .gitignoreで定義されている検索からファイルやディレクトリをスキップすることもできます。そのためには、1つ以上の.gitignoreファイルが見つかった場合、 .gitignoreのグローブに一致する再帰検索からファイルとディレクトリを除外するために--ignore-files使用します。
ug -R -tc++ --ignore-files -f c++/defines
これにより、 #define行（ -f c++/defines ）の作業ディレクトリでC ++ファイル（ -tc++ ）が検索され、 .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.*'
これにより、 .gitignoreで定義されたファイルをスキップして、C/C ++ソースコードファイルのすべての#define FOO...マクロのカラーハイライト付きリストが返されます。
除外は常に包含よりも優先されるため、 --excludeは--includeしないため、 --include-from='.gitignore'は補完されないことに注意してください。 --include --include-dirで明示的に指定されたファイルのみが訪問されます。ファイルとディレクトリの両方と見なされるグローブのリストから、それぞれ--includeと--include-dirに追加するグローブのリスト--include-from 。これは、このファイルにディレクトリ名とディレクトリパスが明示的にリストされていない場合、 --include-fromを使用して訪問されないことを意味します。
UGREPは、入力が有効な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検索後に使用される構成ファイルを表示します。
名前の構成ファイルは、コマンドラインオプションの数を1つだけに削減し---FILE FILEで指定されたオプションのコレクションを使用することにより、カスタム検索タスクを合理化することを目的としています。 --config=FILEオプションとその略式フォーム---FILEワーキングディレクトリにある、またはホームディレクトリにある場合は、見つかった場合は、見つかっていない場合は：
ug ---FILE PATTERN ...
ugrep ---FILE PATTERN ...
FILEが見つからない場合、または読み取れない場合にエラーが生成されます。
名前の構成ファイルは、プロジェクトの開発ワークフローにおけるタスクの要件に固有のオプションのコレクションを定義するために使用できます。たとえば、FIXMEおよびTODOアイテムを使用してコメントのソースコードとドキュメントをチェックして、未解決の問題を報告するため。このような名前の構成ファイルは、プロジェクトディレクトリに配置することでプロジェクトにローカライズすることも、ホームディレクトリに配置してグローバルにすることもできます。視覚的なフィードバックの場合、このタスクに固有の配色を構成FILEのオプションcolorsで指定して、デフォルトの構成とは対照的に、名前付き構成によって生成される出力を識別するのに役立ちます。
--save-configオプションは、 --configがロードされた現在の構成を使用して、 .ugrep構成ファイルをワーキングディレクトリに保存します。これにより、現在の構成と、指定された場合は追加のオプションを組み合わせて保存します。検索結果に悪影響を与えることができない他のオプションやオプションと競合できないオプションのみが保存されます。
--save-config=FILEオプションは、指定されたFILEに構成を保存します。構成は、 FILEが-の場合、標準出力に書き込まれます。
または、構成ファイルを手動で作成または変更することもできます。構成ファイルには、1つ以上のconfig[=FILE] FILE含まれる場合があります。 Manuallを作成する最も簡単な方法は、ファイルの上部にconfig指定し、デフォルトをオーバーライドする長いオプションが続くことです。
?目次に戻る
-Q[=DELAY], --query[=DELAY]
Query mode: start a TUI to perform interactive searches. This mode
requires an ANSI capable terminal. An optional DELAY argument may
be specified to reduce or increase the response time to execute
searches after the last key press, in increments of 100ms, where
the default is 3 (300ms delay). No whitespace may be given between
-Q and its argument DELAY. Initial patterns may be specified with
-e PATTERN, i.e. a PATTERN argument requires option -e. Press F1
or CTRL-Z to view the help screen. Press F2 or CTRL-Y to invoke a
command to view or edit the file shown at the top of the screen.
The command can be specified with option --view, or defaults to
environment variable PAGER when defined, or EDITOR. Press Tab and
Shift-Tab to navigate directories and to select a file to search.
Press Enter to select lines to output. Press ALT-l for option -l
to list files, ALT-n for -n, etc. Non-option commands include
ALT-] to increase context. See also options --no-confirm, --delay,
--split and --view.
--no-confirm
Do not confirm actions in -Q query TUI. The default is confirm.
--delay=DELAY
Set the default -Q key response delay. Default is 3 for 300ms.
--split
Split the -Q query TUI screen on startup.
--view[=COMMAND]
Use COMMAND to view/edit a file in -Q query TUI by pressing CTRL-Y.
このオプションは、ユーザーインターフェイスを開始して、検索パターンをインタラクティブに入力します。
-c一致をカウントできます。 Alt -Cを再び押すことは-c無効にします。オプションは、検索中またはヘルプ画面を表示するときにALTキーで切り替えることができます。 ALT/METAキーがサポートされていない場合（X11 Xtermなど）、Ctrl-Oを押し続けてオプションに対応するキーを押します。-gファイルとディレクトリマッチンググローブを入力または編集します。 Pressing ESCは、コントロールをクエリパターンプロンプトに戻します（グローブは保存されます）。グローブの前にあるとき!または、 ^ 、グローブがA /含むときにグローブと一致する名前のファイルをスキップします、フルパス名は一致します。それ以外の場合は、ベースネームが一致します。グローブがA /で終わると、ディレクトリが一致します。Q> （正常）、 F> （固定文字列）、 G> （基本的なregex）、 P> （perlマッチング）、およびZ> （ファジーマッチング）の間の切り替えです。 --glob=プロンプトが表示されると、Gitignoreスタイルのグローブパターンのコンマ分離リストが入力される場合があります。 ESCを押すと、コントロールをパターンプロンプトに戻します。--viewで指定されたポケットベルのあるファイルを表示します。--view=COMMANDで指定できます。それ以外の場合は、 PAGERまたはEDITOR環境変数を使用して、Ctrl-Yを使用してコマンドを呼び出します。この機能を使用するには、出力でファイル名を有効にして表示する必要があります。--colorオプションに応じて色付けされます。DELAY値を指定します。ただし、押した各キーによる検索を繰り返し開始およびキャンセルした結果、値が低い場合にシステム負荷が増加する可能性があります。--heading有効になります。 Alt-+を押して見出しを切り替えます。クエリTUIキーマッピング：
| キー | 関数 |
|---|---|
Alt-key | keyに対応するUGREPコマンドラインオプションを切り替えます |
Alt-/ xxxx / | Unicode hexコードポイントu+xxxxを挿入します |
Esc Ctrl-C | 戻るか終了します |
Ctrl-Q | 選択モードで選択された結果をクイックエグジットと出力 |
Tab | 画面の上部に表示されているファイルのディレクトリへのchdirまたはファイルを選択する |
Shift-Tab | Chdir 1つのレベルアップまたは解除ファイル |
Enter | 選択モードを入力し、選択した行を切り替えて、出口で出力します |
Up Ctrl-P | 上に移動 |
Down Ctrl-N | 下に移動 |
Left Ctrl-B | 左に移動 |
Right Ctrl-F | 右に移動 |
PgUp Ctrl-G | ディスプレイをページで移動します |
PgDn Ctrl-D | ディスプレイをページで移動します |
Alt-Up | ディスプレイアップを1/2ページ（MacOS Shift-Up ） |
Alt-Down | ディスプレイを1/2ページ（MacOS Shift-Down ）に移動する |
Alt-Left | ディスプレイを1/2ページ左に移動（MacOS Shift-Left ） |
Alt-Right | ディスプレイを1/2ページ（Macos Shift-Right ）右に移動する |
Home Ctrl-A | カーソルをラインの先頭に移動します |
Ctrl-E End | カーソルをラインの端まで移動します |
Ctrl-K | カーソルの後に削除します |
Ctrl-L | 画面を更新します |
Ctrl-O + key | Alt-keyと同じように、 keyに対応するugrepコマンドラインオプションを切り替える |
Ctrl-R F4 | ブックマークにジャンプします |
Ctrl-S | 次の監督/ファイル/コンテキストにジャンプします |
Ctrl-T F5 | 分割画面のトグル（ --splitはスプリットスクリーンTUIを開始します） |
Ctrl-U | カーソルの前に削除します |
Ctrl-V | 逐語的な文字 |
Ctrl-W | 1つの監督/ファイル/コンテキストをジャンプします |
Ctrl-X F3 | ブックマークを設定します |
Ctrl-Y F2 | 画面の上部に表示されているファイルを表示または編集します |
Ctrl-Z F1 | ヘルプとオプションを表示します |
Ctrl-^ | Chdirは、開始作業ディレクトリに戻ります |
Ctrl-] | カラー/モノを切り替えます |
Ctrl- | プロセスを終了します |
ワーキングディレクトリおよび以下のファイルをインタラクティブに検索するには：
ug -Q
同じですが、C ++ファイルのみに制限され、 .gitignoreファイルを無視します。
ug -Q -tc++ --ignore-files
ワーキングディレクトリおよび以下のすべてのメイクファイルをインタラクティブに検索するには：
ug -Q -g 'Makefile*' -g 'makefile*'
同じですが、最大2つのディレクトリレベル（作業と1つのサブディレクトリレベル）の場合：
ug -Q -2 -g 'Makefile*' -g 'makefile*'
main.cppの内容をインタラクティブに表示して検索します。ここで、 -y非一致線をコンテキストとして表示します。
ug -Q -y main.cpp
main.cppインタラクティブに検索するには、検索パターンTODOと5行のマッチコンテキストから始まります（コンテキストをインタラクティブに有効にして無効にすることができます。
ug -Q -C5 -e TODO main.cpp
アーカイブの内容を表示して検索するには（Zip、Tarballなど）。
ug -Q -z archive.tar.gz
UGREPクエリ選択モードを使用して、 project.zipからファイルをインタラクティブにunzipします。
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 '' .
Directory mydirのすべての非空白ファイルをリストしますが、より深くはありません（ファイル引数が与えられているため）：
ug -l '' mydir
Symlinksに続いて、Directory mydirおよびより深いすべての空でないファイルをリストするには：
ug -R -l '' mydir
サブディレクトリのみを訪問しながら、指定されたパス上のすべての非空白のファイルを再帰的にリストするために、1つのレベルの深いmydir/*/でディレクトリmydir/およびサブディレクトリが訪問されます（ -2 -l -l2に省略できることに注意してください）：
ug -2 -l '' mydir
Directory mydirのすべての非空白ファイルを再帰的にリストし、シンボリックリンクに従わない（ mydirなどのコマンドラインを除く）：
ug -rl '' mydir
テキストCPP一致するすべてのメイクファイルを再帰的にリストするには：
ug -l -tmake 'CPP'
すべてのMakefile.*一致するbin_PROGRAMS ：
ug -l -g'Makefile.*' 'bin_PROGRAMS'
extension .shを使用して、すべての非空白のファイルを-Oshで再帰的にリストするには：
ug -l -Osh ''
拡張機能と-tShellに基づいてすべてのシェルスクリプトを再帰的にリストします。
ug -l -tShell ''
拡張機能に基づいてすべてのシェルスクリプトを-tshellのみに再帰的にリストするには：
ug -l -tshell ''
?目次に戻る
--bool, -%, -%%
Specifies Boolean query patterns. A Boolean query pattern is
composed of `AND', `OR', `NOT' operators and grouping with `(' `)'.
Spacing between subpatterns is the same as `AND', `|' is the same
as `OR' and a `-' is the same as `NOT'. The `OR' operator binds
more tightly than `AND'. For example, --bool 'A|B C|D' matches
lines with (`A' or `B') and (`C' or `D'), --bool 'A -B' matches
lines with `A' and not `B'. Operators `AND', `OR', `NOT' require
proper spacing. For example, --bool 'A OR B AND C OR D' matches
lines with (`A' or `B') and (`C' or `D'), --bool 'A AND NOT B'
matches lines with `A' without `B'. Quoted subpatterns are matched
literally as strings. For example, --bool 'A "AND"|"OR"' matches
lines with `A' and also either `AND' or `OR'. Parentheses are used
for grouping. For example, --bool '(A B)|C' matches lines with `A'
and `B', or lines with `C'. Note that all subpatterns in a Boolean
query pattern are regular expressions, unless -F is specified.
Options -E, -F, -G, -P and -Z can be combined with --bool to match
subpatterns as strings or regular expressions (-E is the default.)
This option does not apply to -f FILE patterns. The double short
option -%% enables options --bool --files. Option --stats displays
the Boolean search patterns applied. See also options --and,
--andnot, --not, --files and --lines.
--files
Boolean file matching mode, the opposite of --lines. When combined
with option --bool, matches a file if all Boolean conditions are
satisfied. For example, --bool --files 'A B|C -D' matches a file
if some lines match `A', and some lines match either `B' or `C',
and no line matches `D'. See also options --and, --andnot, --not,
--bool and --lines. The double short option -%% enables options
--bool --files.
--lines
Boolean line matching mode for option --bool, the default mode.
--and [[-e] PATTERN] ... -e PATTERN
Specify additional patterns to match. Patterns must be specified
with -e. Each -e PATTERN following this option is considered an
alternative pattern to match, i.e. each -e is interpreted as an OR
pattern. For example, -e A -e B --and -e C -e D matches lines with
(`A' or `B') and (`C' or `D'). Note that multiple -e PATTERN are
alternations that bind more tightly together than --and. Option
--stats displays the search patterns applied. See also options
--not, --andnot, and --bool.
--andnot [[-e] PATTERN] ...
Combines --and --not. See also options --and, --not, and --bool.
--not [-e] PATTERN
Specifies that PATTERN should not match. Note that -e A --not -e B
matches lines with `A' or lines without a `B'. To match lines with
`A' that have no `B', specify -e A --andnot -e B. Option --stats
displays the search patterns applied. See also options --and,
--andnot, and --bool.
--stats
Output statistics on the number of files and directories searched,
and the inclusion and exclusion constraints applied.
--and 、 --not 、および--andnotオプションには-e PATTERNが必要であることに注意してください。
-%オプションは、すべてのパターンをブールベースにし、最高レベルの優先順位から最低の次の論理操作をサポートします。
| オペレーター | 代替 | 結果 |
|---|---|---|
"x" | x文字通り、正確に指定したとおりに一致させます（標準の正規表現を使用してQおよびE使用） | |
( ) | ブール式グループ化 | |
-x | NOT x | 反転した一致、つまりxが一致しない場合、つまり一致します |
x|y | x OR y | xまたはyで行を一致させます |
xy | x AND y | xとyの両方で行を一致させます |
xとy特別なシンボルから始まらないサブパターンです| 、 - 、および( （引用符またはエスケープを使用してこれらに一致させる）;
-そして、同じではNOT 、優先されるOR 、それは-x|y == (-x)|yを意味します。
|またはORであり、優先されますANDつまり、 xy|z == x (y|z)を意味します。
--statsオプションは、検索が完了した後、CNF（接続詞正規形式）に変換された人間の読み取り可能な形式でブールクエリを表示します。検索なしでCNFを表示するには、 echo | ugrep -% '...' --stats 。
サブパターンは出力でカラーハイライトされていますが、 NOTものを除きます（ x|-yのような著しいパターンを使用する場合、サブパターンではNOTラインに表示される場合があります）。 Subpatternsが重複する場合があることに注意してください。その場合、最初のマッチングサブパターンのみが色のハイライトされています。
SubpatternsがNewlinesと一致する場合、複数の線が一致する場合があります。ただし、1つの例外があります。 (?=X) lookaheadsで終了するサブパターンは、 X複数の行にまたがる場合に一致しない場合があります。
空のパターンは任意のライン（GREP標準）に一致します。したがって、 -% 'x|""|y'すべてに一致し、 xとy色のハイライトではありません。オプション-y 、すべての行をコンテキストとして表示するために使用する必要があります。たとえば、 -y 'x|y' 。
FZFのようなインタラクティブクエリ（ファジーマッチング付きの固定文字列付きのブール検索で、 -wのある-Z+4と一致する最大4つの余分な文字を許可します）、タブと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
myfile.txtにhotとdog両方を含む線を見つけるには：
ug -% 'hot dog' myfile.txt
ug -e hot --and dog myfile.txt
myfile.txtでplaceを含むラインを見つけてから、 hotdogまたはtaco （またはその両方）を見つけるには：
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
fastとfood両方に一致するが、 myfile.txtではbadないdinerやラインのラインを見つけるには：
ug -% 'diner|(fast food -bad)' myfile.txt
fast foodのあるライン（正確に）またはdinerのあるラインを見つけるが、 myfile.txtではbadもoldないラインを見つけるために：
ug -% '"fast food"|diner -bad -old' myfile.txt
同じですが、同じ意味を持つ別のブール式を使用してください：
ug -% '"fast food"|diner -(bad|old)' myfile.txt
myfile.txtでgood暗示するdinerのある線を見つけるために（つまり、 dinerのないgoodラインを見せ、 dinerと一緒にラインを見せますが、論理的に暗示されているgoodだけです！）：
ug -% 'good|-diner' myfile.txt
ug -e good --not diner myfile.txt
myfile.txtでfooと-barと"baz"含む線を見つけるには（それではありません- " 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グレップオプションよりも強力なブールクエリオプションを備えたブールクエリパターンも参照してください。
ファイルmyfile.shにラインを表示するが、一致する行ではない^[ t]*# ：
ug -v '^[ t]*#' myfile.sh
Scottyではなく、 FIXMEとurgentのラインをmyfile.cpp検索するには：
ugrep FIXME myfile.cpp | ugrep urgent | ugrep -v Scotty
同じですが、ブールクエリに-%を使用してください：
ug -% 'FIXME urgent -Scotty' myfile.cpp
負のパターン0d+を使用して555 0パターン d+ +を使用して小数を検索するには：
ug -e 'd+' -N '0d+' -N 555 myfile.cpp
「ネガティブパターン」を使用して、ファイルmyfile.pyでdisplay一致させずにdispで始まる単語を検索するには、 -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
同じですが、 h*を使用して-vと-x使用します。すなわち^h*$ ：
ug -v -x 'h*' myfile.py
単語のdisplay含まないすべてのPythonファイルを再帰的にリストし、文字列やコメントで単語を発生させることを許可します。
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 ：
| エンコーディング | パラメータ |
|---|---|
| アスキー | 該当なし |
| UTF-8 | 該当なし |
| bomを伴うUTF-16 | 該当なし |
| BOMでUTF-32 | 該当なし |
| UTF-16は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 |
| マクロマン（cr = newline） | MACROMAN |
| EBCDIC | EBCDIC |
| DOSコードページ437 | CP437 |
| DOSコードページ850 | CP850 |
| DOSコードページ858 | CP858 |
| Windowsコードページ1250 | CP1250 |
| Windowsコードページ1251 | CP1251 |
| Windowsコードページ1252 | CP1252 |
| Windowsコードページ1253 | CP1253 |
| Windowsコードページ1254 | CP1254 |
| Windowsコードページ1255 | CP1255 |
| Windowsコードページ1256 | CP1256 |
| Windowsコードページ1257 | CP1257 |
| Windowsコードページ1258 | CP1258 |
| Koi8-r | KOI8-R |
| KOI8-U | KOI8-U |
| Koi8-ru | KOI8-RU |
正規表現パターンは常にUTF-8で指定されていることに注意してください（ASCIIを含む）。バイナリパターンを使用したバイナリファイルを検索するには、-u、-w、および-xを使用したバイナリファイルの検索と表示を参照してください。
ASCII（つまり7ビット）のすべてのファイルを再帰的にリストするには：
ug -L '[^[:ascii:]]'
非ASSASCII、つまりUTF-8、UTF-16、およびUTF-32ファイルが非ASCII Unicode文字（U+0080以降）のすべてのファイルを再帰的にリストするには：
ug -l '[^[:ascii:]]'
ファイルに非ASCIIユニコード（U+0080以降）が含まれているかどうかを確認するには：
ug -q '[^[:ascii:]]' myfile && echo "contains Unicode"
ファイル--format="%o%無効なUnicode文字を削除するには（バイナリデータが検出されて拒否され、新しいラインが追加されているため-oが機能しないことに注意してください。 ):
ug "[p{Unicode}n]" --format="%o" badfile.txt
Code Pointを一致させることにより、無効なUTFコンテンツ（IE無効なUTF-8バイトシーケンスまたはUTF-8/16/32コードポイントを含むファイル）を備えたファイルを再帰的にリストします.ネガティブパターン-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
UTF-16 BOMでマークされているUTF-16ファイルで下または大文字でloremを検索するには：
ug -iw 'lorem' utf16lorem.txt
UTF16LOREM.TXTを検索するには、このファイルにUTF-16 BOMがない場合、 --encodingを使用してください。
ug --encoding=UTF-16 -iw 'lorem' utf16lorem.txt
ISO-8859-1でエンコードされたspanish-iso.txt検索するには：
ug --encoding=ISO-8859-1 -w 'año' spanish-iso.txt
?目次に戻る
-o, --only-matching
Output only the matching part of lines. If -A, -B or -C is
specified, fits the match and its context on a line within the
specified number of columns.
複数の行は、Newline文字に一致するパターンと一致する場合があります。 Option -o使用して、一致するフルラインではなく、試合のみを出力します。
nラインブレークに一致するには、LF文字に一致するパターンにn含めます。 rnおよびnラインブレイクを一致させる場合は、 r?n使用するか、単にR使用して、ユニコードラインブレークrn 、 r 、 v 、 f 、 n 、uを一致させるだけです。 +0085、U+2028およびU+2029。
c/c ++ /*...*/マルチラインコメントに一致する：
ug '/*(.*n)*?.**+/' myfile.cpp
-fc/commentsを使用した事前定義されたc/comments -oを使用してC/C ++コメントに合わせます。
ug -of c/comments myfile.cpp
sed -n '/begin/,/end/p'と同じ：怠zyな繰り返しを使用して、 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.
マッチングラインの前後に2つのコンテキストを表示するには：
ug -C2 'FIXME' myfile.cpp
一致した行の後に3行のコンテキストを表示するには：
ug -A3 'FIXME.*' myfile.cpp:
C関数定義で一致する各ラインの前にコンテキストの1つの行を表示するには（C名は非統合です）。
ug -B1 -f c/functions myfile.c
C ++関数定義を使用して各マッチングラインの前にコンテキストの1行を表示するには（C ++名前はUnicodeになる場合があります）：
ug -B1 -f c++/functions myfile.cpp
-yとの一致する線のコンテキストとして非一致線を表示するには：
ug -y -f c++/functions myfile.cpp
1つのHexdumpコンテキストの1行で一致する線のヘクスダンプを表示するには：
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が記載されています。このリストは、確立されたファイル名拡張機能と「マジックバイト」に基づいています。リストされていないファイルタイプがある場合は、Options -Oおよび/または-Mを使用します。エイリアスを定義することをお勧めします。たとえば、 alias ugft='ugrep -Oft'は、filename suffix .ftを使用してファイルを検索する速記です。
-tc++ 、 -o 、 -n 、および-f c++/functionsを持つ線番号を使用して、c/c ++ファイル（ .h 、 .hpp 、 .c 、 .cppなど）に関数定義を再帰的に表示するために：
ug -on -tc++ -f c++/functions
-Oc,cpp 、 -o 、 -n 、および-f c++/functionsを持つ行番号を持つ.cおよび.cppファイルの関数定義を再帰的に表示するには：
ug -on -Oc,cpp -f c++/functions
接尾.sh付きファイルを除き、ファイル名拡張機能とシェルシバンとファイルを一致させるために、 -tShellを使用してすべてのシェルファイルを再帰的にリストします。
ug -l -tShell -O^sh ''
すべての非シェルファイルを-t^Shellで再帰的にリストするには：
ug -l -t^Shell ''
すべてのシェルファイルを、シェルファイル名の拡張機能を持たないシェルシバンで再帰的にリストするには：
ug -l -tShell -t^shell ''
C/C ++コメントでFIXMEを使用して行を検索するには、Multi-Line文字列のFIXMEを除外します。
ug -n 'FIXME' -f c++/zap_strings myfile.cpp
C ++文字列の一致を除外しながら、入力のラインを一致させるためにTODO入力から標準入力からFIXME読むには：
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 ）、Compress（ .Z ）、BZIP2（ .bz 、 .bz2 、 .bzip2 ）、LZMA（ .lzma ）、XZ（ .xz ）、LZ4（ .lz4 ）、ZSTD（ .zst 、 .zstd ）、brotli（ .br ）およびbzip3（ .bz3 ）は、対応するライブラリがインストールされ、ugrepでコンパイルされている場合にオプション-zで検索されます。このオプションでは、ファイルを圧縮する必要はありません。非圧縮ファイルも検索されますが、遅くなります。
他の圧縮形式は、 UGREPフィルターで検索できます。
アーカイブ（CPIO、JAR、PAX、TAR、ZIP、7Z）は、オプション-zで検索されます。一致するアーカイブ内の通常のファイルは、 {および}ブレースに囲まれたアーカイブパス名とともに出力されます。サポートされているタール形式は、V7、USTAR、GNU、Oldgnu、およびPaxです。サポートされているCPIO形式は、ODC、NEWC、およびCRCです。サポートされていないのは、時代遅れの非ポート可能な古いバイナリCPIO形式です。アーカイブ形式のCPIO、TAR、およびPAXは、ファイル名の接尾辞とは無関係に、コンテンツに基づいてオプション-zで自動的に認識されます。
デフォルトでは、ZIPアーカイブ内に保存されている非圧縮アーカイブも検索されます。ZIPおよび7Zアーカイブに保存されているすべてのCPIO、PAX、およびTARファイルは、自動的に認識および検索されます。ただし、デフォルトでは、アーカイブ内に保存されている圧縮ファイルは認識されません。たとえば、TARファイル内に保存されているZIPファイルは検索されませんが、すべての圧縮ファイルとアーカイブは、それらを減圧せずにバイナリファイルであるかのように検索されます。
--zmax=NUMは、最大NUMレベルの深さまで圧縮されたファイルとアーカイブを含むアーカイブを検索します。 NUMの値は、最大99の減圧および除去ステップで1〜99の範囲で、最大99のネストされたアーカイブを拡張します。大きい--zmax=NUM値はパフォーマンスを低下させます。 TARファイルに保存されているZIPファイルの検索など、ほとんどの実用的なユースケースでは--zmax=2が十分であるため、99が必要になる可能性は低いです。
Option -zがオプション-g 、 -O 、 -M 、または-tで使用される場合、ファイル名選択基準（GLOB、拡張機能、マジックバイト、またはファイルタイプ）に一致するArchivesおよび圧縮および非圧縮ファイルが検索されます。たとえば、 ugrep -r -z -tc++ main.cppやzipおよびtarアーカイブなどmain.cpp C ++ファイルを検索します。検索には、存在するときにmain.cpp.gzやmain.cpp.xzなどの圧縮C ++ファイルも含まれています。また、 main.cppなどのCPIO、PAX、TAR、ZIP、および7Zアーカイブが含まれるC ++ファイルを検索します。オプション--stats使用して、再帰検索でファイルパス名をフィルタリングするために適用されたグローブパターンのリストを表示し、アーカイブコンテンツを検索するときに表示します。
オプション-zがオプション-g 、 -O 、 -M 、または-tで使用される場合、CPIO、JAR、PAX、TAR、ZIP、7Zアーカイブを検索して、ファイル名選択基準に一致するアーカイブされたファイルが検索されます。
GZIP、Compress、およびZIP形式は自動的に検出されます。これは、標準入力（パイプからリダイレクトされた入力など）からGZIP圧縮データを読み取るときに役立ちます。その他の圧縮形式では、ファイル名の接尾辞が必要です： .bz 、 .bz2 、またはbzip2の.bzip2 、lzmaの.lzma 、xzの.xz 、zstdの.lz4 、 .zst .zstd brotliおよび.bz3の.br BZIP3の場合。また、gzip用の圧縮タールアーカイブ.tpz速記.taz 、 .tgz .tbz .tbz2 、 .tb2 、および.tz2 for bzip2、lzmaの.tlz 、xzの.txz 、zstdの.tzstは認識されます。標準入力からUGREPでこれらの形式を検索するには、オプションを使用します--label='stdin.bz2' for bzip2、 --label='stdin.lzma' for lzma、 --label='stdin.xz' for xz、 --label='stdin.lz4 for lz4および--label='stdin.zst for zstdなど。 stdinという名前は任意であり、省略される場合があります。
| 形式 | ファイル名の接尾辞 | Tar/Paxアーカイブショートサフィックス | 接尾辞が必要ですか？ | stdinのugrep | 図書館 |
|---|---|---|---|---|---|
| gzip | .gz | .taz 、 .tgz 、 .tpz | いいえ | 自動 | リブズ |
| 圧縮する | .Z | .taZ 、 .tZ | いいえ | 自動 | 内蔵 |
| ジップ | .zip 、 .zipx 、 .ZIP | いいえ | 自動 | リブズ | |
| 7zip | .7z | はい | --label=.7z | 内蔵 | |
| bzip2 | .bz 、 .bz2 、 .bzip2 | .tb2 、 .tbz 、 .tbz2 、 .tz2 | はい | --label=.bz2 | リブズ2 |
| ルズマ | .lzma | .tlz | はい | --label=.lzma | リブルズマ |
| xz | .xz | .txz | はい | --label=.xz | リブルズマ |
| lz4 | .lz4 | はい | --label=.lz4 | liblz4 | |
| zstd | .zst 、 .zstd | .tzst | はい | --label=.zst | libzstd |
| ブロトリ | .br | はい | --label=.br | libbrotlidec | |
| BZIP3 | .bz3 | はい | --label=.bz3 | libbzip3 |
GZIP、BZIP2、XZ、LZ4、およびZSTD形式は、連結された圧縮ファイルをサポートしています。連結された圧縮ファイルは、1つのファイルとして検索されます。
サポートされているZIP圧縮法は、保存されています（0）、デフレート（8）、BZIP2（12）、LZMA（14）、XZ（95）、ZSTD（93）が保存されます。 BZIP2、LZMA、XZ、およびZSTDメソッドは、UGREPを対応する圧縮ライブラリにコンパイルする必要があります。
暗号化されたZIPアーカイブの検索はサポートされていません（おそらく、強化のリクエストに応じて、おそらく将来のリリースでは）。
7zipアーカイブを検索すると、他の方法に比べてより多くのRAMと時間がかかります。 7ZIP LZMA SDK実装は、ストリーミングをサポートせず、物理的なシーク可能な7Zファイルを必要とします。これは、アーカイブ内にネストされたときに7Zファイルを検索できないことを意味します。 7zipを避けるのが最善です。 7zipのサポートは./build.sh --disable-7zipで無効にすることができます。
オプション-z 、タスクの並列性にスレッドを使用して、減圧ストリームの検索と同時に減圧器を実行することにより、大きなファイルの検索をスピードアップします。
package.zipアーカイブに保存されているすべての非空白ファイルをリストするには、すべてのCPIO、PAX、TAR、ZIP、および7Zファイルの内容を含む：保存されています。
ug --zmax=2 -z -l '' package.zip
同じですが、 ugrep -tlistを呼び出すスクリプトを含む-tPythonソースコードファイルのみをリストします。
ug --zmax=2 -z -l -tPython '' package.zip
依存関係を持つTARファイルとして配布されたPythonアプリケーションを検索するには、ホイール（Pythonコードを備えたZIPファイル）として、 app.tgzでmy_class単語を検索します。
ug --zmax=2 -z -tPython -w my_class app.tgz
CおよびC ++のコメントをスキップしながら、単語my_functionの圧縮ファイルを含む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'
TODOおよびFIXME行のproject.zipでファイルmain.cpp検索するには：
ug -z -g main.cpp -w -e 'TODO' -e 'FIXME' project.zip
TODOおよびFIXMEラインを使用してC ++ファイルをTarball project.tar.gz検索するには：
ug -z -tc++ -w -e 'TODO' -e 'FIXME' project.tar.gz
GLOWに一致するファイルを検索するには*.txt project.zipで、Word licenseのZipがいずれにしても（ -g GLOB引数を引用する必要があることに注意してください）：
ug -z -g '*.txt' -w -i 'license' project.zip
Tarball project.tgzのすべてのC ++ファイルを表示およびページに表示します。
ug --pager -z -tc++ '' project.tgz
GitignoreスタイルのGlob /**/projects/project1.* projects.tgzに一致するファイルをリストするには、 December 12にテキストをアーカイブに含むファイルを選択します。
ug -z -l -g '/**/projects/project1.*' -F 'December 12' projects.tgz
-Ojarと-OMF搭載したJARファイルでMeta -inf/manifest.mfデータを表示するには、JARファイルとMFファイルを選択します（ -Ojarが必要です。代わりに標準入力）：
ug -z -h -OMF,jar '' my.jar
project.tgzからFIXME含むc ++ファイルを抽出するには、 -m1を使用して--format="'%z '"を使用して、単語をFIXMEに一致させるアーカイブにあるファイルのパス名のスペース分離リストを生成します。
tar xzf project.tgz `ugrep -z -l -tc++ --format='%z ' -w FIXME project.tgz`
findを使用して深さFirst検索を実行するには、 cpioとugrep使用してファイルを検索します。
find . -depth -print | cpio -o | ugrep -z 'xyz'
?目次に戻る
--ignore-files[=FILE]
Ignore files and directories matching the globs in each FILE that
is encountered in recursive searches. The default FILE is
`.gitignore'. Matching files and directories located in the
directory of the FILE and in subdirectories below are ignored.
Globbing syntax is the same as the --exclude-from=FILE gitignore
syntax, but files and directories are excluded instead of only
files. Directories are specifically excluded when the glob ends in
a `/'. Files and directories explicitly specified as command line
arguments are never ignored. This option may be repeated to
specify additional files.
-M MAGIC, --file-magic=MAGIC
Only files matching the signature pattern MAGIC are searched. The
signature "magic bytes" at the start of a file are compared to
the MAGIC regex pattern. When matching, the file will be searched.
When MAGIC is preceded by a `!' or a `^', skip files with matching
MAGIC signatures. This option may be repeated and may be combined
with options -O and -t to expand the search. Every file on the
search path is read, making searches potentially more expensive.
-O EXTENSIONS, --file-extension=EXTENSIONS
Search only files whose filename extensions match the specified
comma-separated list of EXTENSIONS, same as --include='*.ext' for
each `ext' in EXTENSIONS. When `ext' is preceded by a `!' or a
`^', skip files whose filename extensions matches `ext', same as
--exclude='*.ext'. This option may be repeated and may be combined
with options -g, -M and -t to expand the recursive search.
-t TYPES, --file-type=TYPES
Search only files associated with TYPES, a comma-separated list of
file types. Each file type corresponds to a set of filename
extensions passed to option -O and filenames passed to option -g.
For capitalized file types, the search is expanded to include files
with matching file signature magic bytes, as if passed to option
-M. When a type is preceded by a `!' or a `^', excludes files of
the specified type. This option may be repeated.
-g GLOBS, --glob=GLOBS
Search only files whose name matches the specified comma-separated
list of GLOBS, same as --include='glob' for each `glob' in GLOBS.
When a `glob' is preceded by a `!' or a `^', skip files whose name
matches `glob', same as --exclude='glob'. When `glob' contains a
`/', full pathnames are matched. Otherwise basenames are matched.
When `glob' ends with a `/', directories are matched, same as
--include-dir='glob' and --exclude-dir='glob'. A leading `/'
matches the working directory. This option may be repeated and may
be combined with options -M, -O and -t to expand searches. See
`ugrep --help globs' and `man ugrep' section GLOBBING for details.
--stats
Output statistics on the number of files and directories searched,
and the inclusion and exclusion constraints applied.
#!から始まるすべてのファイルを再帰的にリストするシバン：
ug -l -M'#!' ''
#ではないが#!シバン：
ug -l -M'#' -M'^#!' ''
-tPythonを使用して、すべてのpythonファイル（extension .pyまたはshebang）を再帰的にリストするには：
ug -l -tPython ''
すべての非シェルファイルを-t^Shellで再帰的にリストするには：
ug -l -t^Shell ''
- で非表示ファイルを含むインポートステートメントを持つpythonファイル（extension .pyまたはshebang）を再帰的にリストします-. :
ug -l. -tPython -f python/imports
?目次に戻る
-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.
パターンの始まりは、常に短いパターンの多くの誤った「ランダム化」マッチを防ぐための実用的な戦略として、おおよその一致の最初のキャラクターと常に一致します。これにより、検索速度も大幅に向上します。最初の文字をオプションでオプションにして、例えばp?atternまたはパターンの開始としてドットを使用して、幅広い文字を一致させます（ただし、これは遅いです）。
ラインフィード（ n ）およびnul（ ）文字は、ファジーマッチがregexパターンで指定された線の数を超えてパターンマッチを拡張しないように削除または置換されることはありません。
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.
?目次に戻る
--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'
?目次に戻る
--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.
?目次に戻る
--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
?目次に戻る
-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'
?目次に戻る
--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
?目次に戻る
-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
?目次に戻る
--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'
?目次に戻る
-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
?目次に戻る
-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'
?目次に戻る
--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= | ファイル名 |
ln= | line numbers |
cn= | column numbers |
bn= | byte offsets |
se= | separators |
hl | hyperlink file names, same as --hyperlink |
qp= | TUI prompt |
qe= | TUI errors |
qr= | TUI regex |
qm= | TUI regex meta characters |
ql= | TUI regex lists and literals |
qb= | TUI regex braces |
Multiple SGR codes may be specified for a single parameter when separated by a semicolon, eg mt=1;31 specifies bright red. The following SGR codes are available on most color terminals:
| コード | c | 効果 | コード | c | 効果 |
|---|---|---|---|---|---|
| 0 | n | normal font and color | 2 | f | faint (not widely supported) |
| 1 | h | highlighted bold font | 21 | H | highlighted bold off |
| 4 | あなた | 下線 | 24 | U | underline off |
| 7 | 私 | invert video | 27 | 私 | invert off |
| 30 | k | 黒文字 | 90 | +k | bright gray text |
| 31 | r | 赤文字 | 91 | +r | bright red text |
| 32 | g | green text | 92 | +g | bright green text |
| 33 | y | yellow text | 93 | +y | bright yellow text |
| 34 | b | 青い文字 | 94 | +b | bright blue text |
| 35 | メートル | magenta text | 95 | +m | bright magenta text |
| 36 | c | cyan text | 96 | +c | bright cyan text |
| 37 | w | 白い文字 | 97 | +w | bright white text |
| 40 | K | 黒の背景 | 100 | +K | bright gray background |
| 41 | R | 濃い赤の背景 | 101 | +R | bright red background |
| 42 | G | 濃い緑色の背景 | 102 | +G | bright green background |
| 43 | Y | dark yellow backgrounda | 103 | +Y | bright yellow background |
| 44 | B | dark blue background | 104 | +B | bright blue background |
| 45 | M | dark magenta background | 105 | +M | bright magenta background |
| 46 | C | dark cyan background | 106 | +C | bright cyan background |
| 47 | W | dark white background | 107 | +W | 明るい白い背景 |
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
?目次に戻る
--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
?目次に戻る
--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
?目次に戻る
--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
?目次に戻る
--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
?目次に戻る
-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*$'
?目次に戻る
-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
?目次に戻る
--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'
?目次に戻る
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+'
?目次に戻る
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 '`[^`]*`'
?目次に戻る
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)
?目次に戻る
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)φ?目次に戻る
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.
?目次に戻る
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.
?目次に戻る
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.
?目次に戻る
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
