DASHT(1)

💅 DASHT(1) — the dasht girlie's manual 💅

okay so real talk: this is the manual page for dasht, from the General Commands Manual section, and it's genuinely the most useful lil thing ever. pull up a chair bestie 🫶

✨ NAME ✨

dasht — API documentation in your terminal, no cap. literally the whole point 💖

🌸 SYNOPSIS 🌸

dasht [PATTERN] [DOCSET]...

🎀 Examples 🎀

• dasht — hits you with Topics (A-Z) from each installed docset. iconic default behaviour ✨
• dasht 'c - x' — search for "c - x" in all installed docsets. go off 👑
• dasht 'c - x' bash — search for "c - x" only in the "bash" docset. narrowing it down, love that for us 💅
• dasht 'c - x' bash css — search for "c - x" only in the "bash" and "css" docsets. multi-docset moment 🌈

🦋 DESCRIPTION 🦋

So what it does: it searches for PATTERN in all your installed Dash <https://kapeli.com/dash> docsets — and if you want, it only searches in the ones whose names match the DOCSETS you gave it — by calling dasht-query-html(1). teamwork makes the dream work fr fr 🫶

The results, if there are any, get displayed in the w3m(1) terminal web browser. and here's the cute part: it terminates when you press the q key, just like typical UNIX pagers do. so chill. 😌 If no results were found, it says so on stderr and exits with a nonzero status — a gentle little "sorry bestie, nothing here" 💀

🔍 Searching 🔍

• Whitespace characters in PATTERN are treated as wildcards. slay.
• But the SQL LIKE wildcard characters % and _ are not wildcards — they're taken literally. important!! don't get caught out 🙈

Before searching, PATTERN gets surrounded by whitespace wildcards so it can match anywhere: beginning, middle, or end. main character energy, matching everywhere 💫

As a result, if PATTERN is undefined, it becomes a whitespace wildcard and thereby matches everything. so like, no pattern = full send. 🚀

💜 ENVIRONMENT 💜

• DASHT_DOCSETS_DIR — defines the filesystem location where your Dash <https://kapeli.com/dash> docsets are installed. If it's undefined, its value is assumed to be $XDG_DATA_HOME/dasht/docsets/ or, if XDG_DATA_HOME is undefined, $HOME/.local/share/dasht/docsets/. defaults doing their thing ✨

🌟 EXIT STATUS 🌟

• 44 — no results were found. 😭
• 45 — no docsets were searched. 💀

🌈 SEE ALSO 🌈

w3m(1), dasht-query-html(1), dasht-docsets(1), and Dash <https://kapeli.com/dash> — go read those too, iykyk 📚

👑 AUTHOR 👑

Written in 2016 by Suraj N. Kurapati <https://github.com/sunaku/dasht>. Distributed under the terms of the ISC license (see the LICENSE file). respect the legend 🫡

---

and that's the whole thing bestie — this page is version 2.4.0, dated 2020-05-16, and it's the DASHT(1) page, so now you know 💖✨🎀 go search something iconic 🦋