zsh-users
 help / color / mirror / code / Atom feed
From: Stephane Chazelas <stephane@chazelas.org>
To: Mikael Magnusson <mikachu@gmail.com>
Cc: Zach Riggle <zachriggle@gmail.com>, Zsh Users <zsh-users@zsh.org>
Subject: Re: Better Help Docs Searching?
Date: Sun, 1 Aug 2021 17:33:14 +0100	[thread overview]
Message-ID: <20210801163314.toawcsrtj6eqydxr@chazelas.org> (raw)
In-Reply-To: <CAHYJk3RSxeUAgmAGUgHa+TRnzm8Dnb9_a49iYOzi4BWsKfPQbw@mail.gmail.com>

2021-08-01 18:21:14 +0200, Mikael Magnusson:
[...]
> 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.
[...]

I only use "info" for reading the zsh manual (or any manual
larger than a few pages and that has an info manual, there's a
good reason we talk of man pages, and not man books, man is
really not adequate for a manual the size of zsh's).

In info, the "i" and "I" commands are your friends. They search
the index and have completion. There's also "g" to search the
nodes (the table of contents).

In zsh, the index is very good.

info zsh read

Will bring you to the section about the read builtin.

Within "info zsh", press "I" (Shift+i) and enter "read", and
you'll see all the index entries that contain "read".

IIRC, zsh completion also used to work properly with "info", but
as seen in the other thread I started in zsh-workers, it's
a bit broken currently. No big deal as info's own completion is
adequate.

Press "h" within "info" to get started with it.

It's really astonishing that so few people know about it after
so many decades it's been around.

-- 
Stephane


  reply	other threads:[~2021-08-01 16:34 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
2021-08-01 16:33   ` Stephane Chazelas [this message]
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

Reply instructions:

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:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210801163314.toawcsrtj6eqydxr@chazelas.org \
    --to=stephane@chazelas.org \
    --cc=mikachu@gmail.com \
    --cc=zachriggle@gmail.com \
    --cc=zsh-users@zsh.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* 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

	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).