zsh-users
 help / color / mirror / code / Atom feed
* Better Help Docs Searching?
@ 2021-08-01 10:44 Zach Riggle
  2021-08-01 11:01 ` Roman Perepelitsa
                   ` (4 more replies)
  0 siblings, 5 replies; 26+ messages in thread
From: Zach Riggle @ 2021-08-01 10:44 UTC (permalink / raw)
  To: Zsh Users

Hello all!

The documentation for Zsh is awesome, when I can find the appropriate
part of the online pages / man pages.  Unfortunately, finding the
correct location in the docs is very hard -- e.g. when I'm trying to
find out what a given builtin / flag / option / etc. does.

A good example is the builtin 'read'.  Even knowing it's a builtin,
and searching the docs [1] / man pages for builtins, it's still not
very straightforward to find the docs on 'read'.  (There are 91
matches for "read" on the online docs and 82 in zshbuiltins).

I checked out the Zsh source, and can trivially find e.g.

$ git grep 'findex(read)'
Doc/Zsh/builtins.yo:1492:findex(read)

Which is neat, but not quite useful since reading the raw YODL text is
cumbersome.  YODL itself seems to be end-of-life / deprecated, so I
don't expect this situation to change, and it would be an immense
undertaking to rewrite Zsh docs in a different way.

All of that said, is there any way to easily find keywords / flags in
either the online docs OR the man pages -- rather than having way too
many matches for other things that mention the same word (e.g. "read"
as mentioned above).

[1]: https://zsh.sourceforge.io/Doc/Release/Shell-Builtin-Commands.html

Thanks for your time,
Zach Riggle


^ permalink raw reply	[flat|nested] 26+ messages in thread

end of thread, other threads:[~2021-08-14 15:42 UTC | newest]

Thread overview: 26+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-08-01 10:44 Better Help Docs Searching? Zach Riggle
2021-08-01 11:01 ` Roman Perepelitsa
2021-08-01 16:21 ` Mikael Magnusson
2021-08-01 16:33   ` Stephane Chazelas
2021-08-01 18:52     ` Bart Schaefer
2021-08-01 20:11       ` Ray Andrews
2021-08-03  5:45         ` Zach Riggle
2021-08-03  8:03           ` Zach Riggle
2021-08-03  8:09             ` Zach Riggle
2021-08-03  8:44               ` Peter Stephenson
2021-08-03  9:40                 ` Zach Riggle
2021-08-03  9:57                   ` Peter Stephenson
2021-08-03 16:47                   ` Bart Schaefer
2021-08-03 11:28             ` david rayner
2021-08-05 15:31             ` Vincent Lefevre
2021-08-03 16:52           ` Bart Schaefer
2021-08-01 16:25 ` Bart Schaefer
2021-08-05  9:56   ` Vincent Lefevre
2021-08-04  6:30 ` Roman Neuhauser
2021-08-04 14:56   ` Ray Andrews
2021-08-04 16:08     ` Bart Schaefer
2021-08-05 12:00       ` Ray Andrews
2021-08-04 16:38     ` Roman Neuhauser
2021-08-04 16:05   ` Bart Schaefer
2021-08-04 16:45     ` Roman Neuhauser
2021-08-14 15:41 ` Daniel Shahaf

Code repositories for project(s) associated with this public inbox

	https://git.vuxu.org/mirror/zsh/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).