From: Mikael Magnusson <email@example.com>
To: Zach Riggle <firstname.lastname@example.org>
Cc: Zsh Users <email@example.com>
Subject: Re: Better Help Docs Searching?
Date: Sun, 1 Aug 2021 18:21:14 +0200 [thread overview]
Message-ID: <CAHYJk3RSxeUAgmAGUgHa+TRnzm8Dnb9_a49iYOzi4BWsKfPQbw@mail.gmail.com> (raw)
On 8/1/21, Zach Riggle <firstname.lastname@example.org> wrote:
> 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  / 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)'
> 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).
> : https://zsh.sourceforge.io/Doc/Release/Shell-Builtin-Commands.html
I'm sure you tried the Index link at the top already, but if you click
Contents and scroll down, you'll see that there are multiple indices,
one of which is what you want:
You can also find these in the pdf version of the documentation (not
sure if we provide this anywhere but you can build it yourself). The
info version also probably has them, but I'm not sure if anyone knows
how to navigate an info document.
next prev parent reply other threads:[~2021-08-01 16:21 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-01 10:44 Zach Riggle
2021-08-01 11:01 ` Roman Perepelitsa
2021-08-01 16:21 ` Mikael Magnusson [this message]
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
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
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).