sharkdp/fd
Glossary
Terms used throughout the fd source tree and this wiki.
| Term | Meaning |
|---|---|
| smart case | Default matching mode: case-insensitive unless the pattern contains a literal uppercase character. Implemented in pattern_has_uppercase_char in src/regex_helper.rs and applied in construct_config in src/main.rs. |
.fdignore |
A per-project ignore file that uses .gitignore syntax but is specific to fd. Recognised by the walker via WalkBuilder::add_custom_ignore_filename(".fdignore") in src/walk.rs. |
| global ignore file | A user-level fdignore at ${XDG_CONFIG_HOME}/fd/ignore (or the platform equivalent resolved by etcetera). Read in WorkerState::build_walker (src/walk.rs). |
--unrestricted / -u |
Alias for --no-ignore --hidden. Counted as a u8 (rg_alias_hidden_ignore) in Opts so users can pass -uu for the same effect. |
| smart strip-cwd | When the user did not pass any search path and is not piping or executing commands, fd strips the leading ./ from results for readability. See Opts::strip_cwd_prefix and Config::strip_cwd_prefix (src/cli.rs, src/config.rs). |
| smart-buffering | The ReceiverBuffer first buffers up to 1000 results or 100 ms (MAX_BUFFER_LENGTH/DEFAULT_MAX_BUFFER_TIME in src/walk.rs), sorts them, and then switches to streaming mode for the rest of the search. |
Batch |
A Vec<WorkerResult> shared via Arc<Mutex<Option<Vec<...>>>> so multiple sender threads can append cheaply between channel sends. Defined in src/walk.rs. |
WorkerResult |
Either an Entry(DirEntry) or an Error(ignore::Error). The error variant carries filesystem traversal errors that may be reported to stderr depending on --show-errors. |
DirEntry |
fd's wrapper around either an ignore::DirEntry (Normal) or a PathBuf for a broken symlink. Caches metadata and lscolors::Style lazily. See src/dir_entry.rs. |
| broken symlink | A symlink whose target does not exist. fd preserves it in output by constructing DirEntry::broken_symlink(path) when the underlying ignore walker reports NotFound for an entry whose symlink_metadata says it is a symlink. |
| placeholder / token | The substitution variables used by --exec and --format: {}, {/}, {//}, {.}, {/.}, plus {{/}} for literal braces. Modeled by Token in src/fmt/mod.rs. |
CommandSet |
A collection of CommandTemplates plus an ExecutionMode (OneByOne or Batch). Built from CLI args in the custom Exec parser in src/cli.rs. |
CommandBuilder |
The argv-builder used in batch mode. It uses argmax::Command::args_would_fit to flush before exceeding ARG_MAX. See src/exec/mod.rs. |
| prune | When --prune is set the walker returns WalkState::Skip after a match, so matching directories are reported but not descended into. Toggled by Config::prune and applied in spawn_senders in src/walk.rs. |
ignore_contain |
Directories that contain a named entry are skipped entirely. Originally added for CACHEDIR.TAG (10.4.0). Implemented in the entry filter in spawn_senders. |
| OSC 8 hyperlink | The escape sequence \x1B]8;;<url>\x1B\\<text>\x1B]8;;\x1B\\ used by --hyperlink. URLs are constructed by PathUrl in src/hyperlink.rs. |
| smart-quote | (Reserved phrase, no implementation) — fd does not quote results; users requesting null-terminated output should pass -0/--print0. |
SizeFilter |
Parsed -S/--size constraint, e.g., +1mb, -500ki. Defined in src/filter/size.rs. |
TimeFilter |
Parsed --changed-within / --changed-before constraint. Accepts durations (30min), datetimes (2024-02-12), Spans, RFC3339 timestamps, or @<unix-seconds>. Implemented in src/filter/time.rs. |
OwnerFilter |
Unix-only -o user:group constraint, with optional ! negation. Defined in src/filter/owner.rs. |
FileTypes |
The bag of booleans behind -t/--type. Includes executables_only and empty_only flags that act as additional gates on top of file/directory selection. See src/filetypes.rs. |
| MSRV | Minimum Supported Rust Version. Currently 1.90.0, declared in Cargo.toml and enforced by the min_version CI job. |
| Argmax | The argmax crate. fd uses it to track how many bytes have been added to a Command so that --exec-batch flushes before the kernel rejects the call. |
Built by Factory AutoWiki from public repository content. It is a generated preview for codebase exploration, not source-maintained documentation.