HFST-GREP(1)

✨ NAME ✨

hfst-grep — search for PATTERN in each FILE or standard input. That's the whole vibe, bestie. 💅

---

🦋 SYNOPSIS 🦋

hfst-grep [OPTIONS...] PATTERN [FILE...]

---

🌸 DESCRIPTION 🌸

Okay so real talk: this thing goes hunting for PATTERN in every FILE you throw at it, or in standard input if you don't name any files. By default, PATTERN is a Xerox regular expression (XRE for short, iykyk). Like, for example:

hfst-grep 'h e l l o %  w o r l d' menu.h menu.c

Obsessed. Anyway, here's everything it can do 👑

🎀 Common options: 🎀

• -h, --help — prints the help message, like a lil pep talk
• -V, --version — prints version info, so you know exactly which era of this icon you're on
• -v, --verbose — prints verbosely while processing, it will NOT stop yapping
• -q, --quiet — only prints fatal errors and the output you actually asked for
• -s, --silent — alias of --quiet, same energy, different name
• -9, --format=TYPE — compiles expressions to TYPE automata

🧚 Regexp selection and interpretation: 🧚

• -E, --extended-regexp — PATTERN is an extended regular expression (ERE)
• -F, --fixed-strings — PATTERN is a set of newline-separated fixed strings
• -G, --basic-regexp — PATTERN is a basic regular expression (BRE)
• -P, --perl-regexp — PATTERN is a Perl regular expression
• -X, --xerox-regexp — PATTERN is a Xerox regular expression
• -e, --regexp=PATTERN — use PATTERN for matching
• -f, --file=FILE — obtain PATTERN from FILE
• -I, --ignore-case — ignore case distinctions, we're not being picky here
• -w, --word-regexp — forces PATTERN to match only whole words
• -x, --line-regexp — forces PATTERN to match only whole lines
• -z, --null-data — a data line ends in a 0 byte, not a newline

🌈 Miscellaneous options: 🌈

• --no-messages — suppress error messages (living in denial, respectfully)
• --invert-match — select non-matching lines, the contrarian arc

👑 Output control: 👑

• -m, --max-count=NUM — stop after NUM matches
• -b, --byte-offset — print the byte offset with output lines
• -n, --line-number — print line number with output lines
• --line-buffered — flush output on every line
• -H, --with-filename — print the filename for each match
• -h, --no-filename — suppress the prefixing filename on output (yes, -h is also --help up there, it's giving double life 💀)
• --label=LABEL — print LABEL as the filename for standard input
• -o, --only-matching — show only the part of a line matching PATTERN
• --binary-files=TYPE — assume that binary files are TYPE; TYPE is binary, text, or without-match
• -a, --text — equivalent to --binary-files=text
• -d, --directories=ACTION — how to handle directories; ACTION is read, recurse, or skip
• -D, --devices=ACTION — how to handle devices, FIFOs and sockets; ACTION is read or skip
• -R, -r, --recursive — equivalent to --directories=recurse
• --include=FILE_PATTERN — search only files that match FILE_PATTERN
• --exclude=FILE_PATTERN — skip files and directories matching FILE_PATTERN
• --exclude-from=FILE — skip files matching any file pattern from FILE
• --exclude-dir=PATTERN — directories that match PATTERN will be skipped
• -L, --files-without-match — print only names of *FILE*s containing no match
• -l, --files-with-matches — print only names of *FILE*s containing matches
• -c, --count — print only a count of matching lines per FILE
• -T, --initial-tab — make tabs line up (if needed)
• -Z, --null — print 0 byte after FILE name

💜 Context control: 💜

• -B, --before-context=NUM — print NUM lines of leading context
• -A, --after-context=NUM — print NUM lines of trailing context
• -C, --context=NUM — print NUM lines of output context
• --color[=WHEN], --colour[=WHEN] — use markers to highlight the matching strings; WHEN is always, never, or auto
• -U, --binary — do not strip CR characters at EOL (MSDOS)
• -u, --unix-byte-offsets — report offsets as if CRs were not there (MSDOS)

---

😭 REPORTING BUGS 😭

Found a bug? Not the vibe, but thank you for your service 🫶 Report bugs to <hfst-bugs@helsinki.fi> or directly to the bug tracker at: <https://github.com/hfst/hfst/issues>

The hfst-grep home page lives at: <https://github.com/hfst/hfst/wiki/HfstGrep>

General help using HFST software: <https://github.com/hfst/hfst/wiki>

---

💖 COPYRIGHT 💖

Copyright © 2017 University of Helsinki, License GPLv3: GNU GPL version 3 <http://gnu.org/licenses/gpl.html>

This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. (Say it louder for the people in the back.)

---

That's the whole page, bestie — HFST manual, August 2018, HFST-GREP(1), sourced from the HFST project. Go forth and grep. Periodt. 💅✨