From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org X-Spam-Level: X-Spam-Status: No, score=-3.4 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED, UNPARSEABLE_RELAY autolearn=ham autolearn_force=no version=3.4.4 Received: (qmail 18648 invoked from network); 1 Aug 2021 16:21:56 -0000 Received: from zero.zsh.org (2a02:898:31:0:48:4558:7a:7368) by inbox.vuxu.org with ESMTPUTF8; 1 Aug 2021 16:21:56 -0000 ARC-Seal: i=1; cv=none; a=rsa-sha256; d=zsh.org; s=rsa-20200801; t=1627834916; b=sSKsrLl5nOY8Kw+cM/BMsRQzd+AeLGYIle8uyGhD79eBzMWF/DmAekRXietAc36d0pZMyqfaUW BAZLpBh/oiYzDlRsYpf+8ngazdaB0jum79CffbCnvLZ8n7cKq/jeAHV08OIpsWHQA8420nMe8Z VlqSj36Gjj1sHTgCoBYqk1VjgNlaR1i8kxE57K04kKXO36YD6pyLpj6zGfgY8z0CBx8tvebjsC z5upg6wlSNQp9ad8VCgHkj36lqi84ieoG0r2DcdXxTolsxuRyNFswKPXw44s5fg/cICep2NlVP AuFBTbc7nhC09shcgX+fgyPdI0h078XnDH1wNJ2a/Typ5w==; ARC-Authentication-Results: i=1; zsh.org; iprev=pass (mail-vs1-f47.google.com) smtp.remote-ip=209.85.217.47; dkim=pass header.d=gmail.com header.s=20161025 header.a=rsa-sha256; dmarc=pass header.from=gmail.com; arc=none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed; d=zsh.org; s=rsa-20200801; t=1627834916; bh=6leJAJekSZluTqfOf0SfbR3SpaI8pQI/05or70DTjag=; h=List-Archive:List-Owner:List-Post:List-Unsubscribe:List-Subscribe:List-Help: List-Id:Sender:Content-Type:Cc:To:Subject:Message-ID:Date:From:References: In-Reply-To:MIME-Version:DKIM-Signature:DKIM-Signature; b=JY1EwKlG/6quyJ8SkR89IgDhS5M/5/Es4IWci9AM1fqA2dXXuevMZc7iiqhAfVZcZ9PBSJ5CFO i+1VCfJa+PKdsGFhc8YZWyeQGbNJX3m/ocPs7R48M4Q/Ss938KBxgdzArWrMTFz+qJwCpLqYG/ nD3Q1XczJNaUcgKMLvQCn8g63H/iOV/R9NX9V27wpyUvl4WxWwZuwvX8K1kqXJAjFbWIklwaBo p5CU7oFuUVjzpGoghpSJl99KHEbOQkBweFfiWv45m+nh+lHkoNPmv1M+liAw1+d4fWjFes4KI+ OFc87/boKJQHvztu0iNMmgXCnYv9iysqg0Wh1XmkDe4DAg==; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=zsh.org; s=rsa-20200801; h=List-Archive:List-Owner:List-Post:List-Unsubscribe: List-Subscribe:List-Help:List-Id:Sender:Content-Type:Cc:To:Subject:Message-ID :Date:From:References:In-Reply-To:MIME-Version:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID; bh=U5KMfJgT3MfrxxuzDxk3BuXQFyD4ZZ9G8/cfQJGa1BA=; b=xCHsE6Wk8krqvGv0uQZdrpNLEo SOf/mCS4REw+ei9exuqR31N1eEL9NvmhRM4i9uk3ZM9Mnt8FbkNQyaUbdsR6uhv3NsGJerKVt/Rcs WwxrZDiPsZXOJKiDgFUY2+0//D18foGYHA/O1pcjUEe7+g89lgQbb7KKToqOYCLVenpAE2rp/Jl+T R1JB0EvAGggN+cLrtk3+ovjWqdh2hCuKtU4VkbrN8XbSuUJLKSG87xybNVbvwYpjfGKewuJF9P1BT oQcdjsk5a9Cj3OEh5YgQgIxBJzpW/ilODNNCTrS460n0TXdcBnUffMSvVM2FmnE/FkMt10FYVAng/ HX8+Ioxg==; Received: from authenticated user by zero.zsh.org with local id 1mAEDs-000HHK-Br; Sun, 01 Aug 2021 16:21:56 +0000 Authentication-Results: zsh.org; iprev=pass (mail-vs1-f47.google.com) smtp.remote-ip=209.85.217.47; dkim=pass header.d=gmail.com header.s=20161025 header.a=rsa-sha256; dmarc=pass header.from=gmail.com; arc=none Received: from mail-vs1-f47.google.com ([209.85.217.47]:45953) by zero.zsh.org with esmtps (TLS1.3:TLS_AES_128_GCM_SHA256:128) id 1mAEDD-000GYh-UJ; Sun, 01 Aug 2021 16:21:16 +0000 Received: by mail-vs1-f47.google.com with SMTP id u11so5809304vst.12 for ; Sun, 01 Aug 2021 09:21:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc; bh=U5KMfJgT3MfrxxuzDxk3BuXQFyD4ZZ9G8/cfQJGa1BA=; b=n3IwnlJWMByYQu7CkbYbQ1xaRbQiC2Qpnyza/+ZD4vr6UStKOeH2yG4gulw2/5jJSz qwC4W8mMQmc/LbqJ6MfrzKJMxlGcsaTVDMTUk3Qaq3tySpnfAcAtuG6cq2/Ue39FgSlK D902/TQ23ZK/GGvxeQIlvwJzLPMBzKAFAL0w5174YnT5hcW5WeDyzbJYuBdOEuSmhEiz ANInzuxcB/OQuhkqZXGhQil9aLuKQy3P7ape1IK3gXNNb2AthOITR6bC78wlgXsY9yyV NUrBBBA15FOLViyOWOOxaCEkZeobQ+4T/8DODapd1dea1Bg5aksk8PWAuREieZEfJg6T ar+Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc; bh=U5KMfJgT3MfrxxuzDxk3BuXQFyD4ZZ9G8/cfQJGa1BA=; b=bm9pokyUQhXGQgsSfniHsNAqPbMPGrfSSfQnxbZ/AiXZFCeods8d+f2eMJgaXhxY6b zxzvt21KvTda3EZS58nASYTRzZEtgzYLag/LrppFr0a1va4bmPR+UqZn0/x3+jgtFWCh qydSGB+55l5CPb1rR+Y0Ue9wBN4gHcwYeBomnQ641WF75HwSdSHVFwZNYNNmWaveq8Ur ZX0hxhzESmbWCEWAsud8JFacJHGS6kiwF7f43eh9XrdXJ4mgRtqHlOeaEO2wLXG7AxwT TO8G18HIKyR1XX9cd40j2u5HvG+q5XGhb8Xp3lbrMfFVKjl21NFndfz4JnjNO2vqv8f/ crrQ== X-Gm-Message-State: AOAM531xlNaL6HzApui7WA9riQiCPL0x/4VgUEmtDnIjcLkVHW5nJNmj zvwKGPL27vh5Yqu/90GdRpBCmrPrn+ct52/Uv6k= X-Google-Smtp-Source: ABdhPJyOINu12BgzXtcvcByNPVOCsA5EWwBBibrJJ20nrC2MYvkDV08P9W18Oja0MbYYi8Qq+NItNLn41fqT6KTQNgk= X-Received: by 2002:a05:6102:3cb:: with SMTP id n11mr7628370vsq.41.1627834874613; Sun, 01 Aug 2021 09:21:14 -0700 (PDT) MIME-Version: 1.0 Received: by 2002:ab0:1508:0:0:0:0:0 with HTTP; Sun, 1 Aug 2021 09:21:14 -0700 (PDT) In-Reply-To: References: From: Mikael Magnusson Date: Sun, 1 Aug 2021 18:21:14 +0200 Message-ID: Subject: Re: Better Help Docs Searching? To: Zach Riggle Cc: Zsh Users Content-Type: text/plain; charset="UTF-8" X-Seq: 26827 Archived-At: X-Loop: zsh-users@zsh.org Errors-To: zsh-users-owner@zsh.org Precedence: list Precedence: bulk Sender: zsh-users-request@zsh.org X-no-archive: yes List-Id: List-Help: List-Subscribe: List-Unsubscribe: List-Post: List-Owner: List-Archive: On 8/1/21, Zach Riggle 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 [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 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: https://zsh.sourceforge.io/Doc/Release/zsh_14.html#index_split-13_fn_letter-R 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. -- Mikael Magnusson