DASHT-QUERY-LINE(1)

πŸ“¦ version 2.4.0, in nixos 26.05, nixpkgs unstable

πŸ’… DASHT-QUERY-LINE(1) β€” bestie's guide to the dasht-query-line manual page πŸŽ€

okay so this is DASHT-QUERY-LINE(1), from the General Commands Manual, and it's genuinely one of those pages that just… ate. no notes.


🌸 NAME 🌸

dasht-query-line β€” it searches your Dash docsets (Dash is over at <https://kapeli.com/dash> πŸ’–) and then emits groups of lines at you. that's the whole vibe.


✨ SYNOPSIS ✨

dasht-query-line [PATTERN] [DOCSET]...

πŸ¦‹ Examples πŸ¦‹

  • dasht-query-line β€” no args, no stress: gives you Topics (A-Z) from each installed docset. literally every docset you have, alphabetized, slaying.
  • dasht-query-line 'c - x' β€” searches for "c - x" across all installed docsets.
  • dasht-query-line 'c - x' bash β€” searches for "c - x" only in the "bash" docset. narrowed down, focused, main character energy.
  • dasht-query-line 'c - x' bash css β€” searches for "c - x" only in the "bash" and "css" docsets. two besties only.

πŸ’œ DESCRIPTION πŸ’œ

So what it does: it searches for PATTERN in all your installed Dash docsets (again: <https://kapeli.com/dash>), and if you want, it can restrict itself to only the docsets whose names match the *DOCSET*s you pass in. how? by calling dasht-query-exec(1). 🫢

then it emits the results in groups of lines, exactly like the "Results" bit down below describes. however β€” and this is the important part β€” if no results were found, this program exits with a nonzero status. no results, no chill, nonzero exit. 😭

πŸ”Ž Searching πŸ”Ž

Whitespace characters inside PATTERN get treated as wildcards. but the SQL LIKE wildcard characters % and _? nope, not wildcards β€” they're taken literally. icon behavior honestly.

Before it searches, PATTERN gets surrounded by whitespace wildcards so it can match anywhere: beginning, middle, or end. which means β€” plot twist β€” if PATTERN is undefined, it becomes a whitespace wildcard and therefore matches everything. πŸ’€

πŸŽ€ Results πŸŽ€

Every search result gets printed to stdout as a group of four lines of text:

  • name = VALUE β€” the name of the token that matched the PATTERN.
  • type = VALUE β€” the type of that token, as defined in the docset.
  • from = VALUE β€” the name of the docset where this result was found.
  • url = VALUE β€” the URL of the API documentation for this result.

for example, here's a search result for "c - x" from the "bash" docset:

name = undo (C-_ or C-x C-u)
type = Function
from = Bash
url = file:///home/sunny/.local/share/dasht/docsets/Bash.docset/Contents/Resources/Documents/bash/Miscellaneous-Commands.html#//apple_ref/Function/undo%20%28C%2D%5F%20or%20C%2Dx%20C%2Du%29

🌈 ENVIRONMENT 🌈

  • DASHT_DOCSETS_DIR β€” tells it where on the filesystem your Dash docsets (yep, <https://kapeli.com/dash>) are installed. if it's undefined, its value is assumed to be $XDG_DATA_HOME/dasht/docsets/ or β€” if XDG_DATA_HOME is also undefined β€” $HOME/.local/share/dasht/docsets/.

⭐ EXIT STATUS ⭐

  • 44 β€” No results were found.

πŸ‘‘ SEE ALSO πŸ‘‘

dasht-query-exec(1), dasht-query-html(1), dasht-docsets(1), dasht(1), and Dash <https://kapeli.com/dash> β€” go read them, iykyk 🧚


🌸 AUTHOR 🌸

Written in 2016 by Suraj N. Kurapati <https://github.com/sunaku/dasht>, and distributed under the terms of the ISC license (see the LICENSE file). periodt. πŸ“œ


and that's the whole page, bestie πŸ’… β€” this version is 2.4.0, dated 2020-05-16, and no cap, you now know dasht-query-line better than most people know their own passwords. mwah 🫢✨

πŸ“¦ where this page comes from