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 14772 invoked from network); 1 Aug 2021 10:46:13 -0000 Received: from zero.zsh.org (2a02:898:31:0:48:4558:7a:7368) by inbox.vuxu.org with ESMTPUTF8; 1 Aug 2021 10:46:13 -0000 ARC-Seal: i=1; cv=none; a=rsa-sha256; d=zsh.org; s=rsa-20200801; t=1627814773; b=DWrQK99m0y5PGn2rj+ET4+oFPe3sCoZFNBZ3a16NHtHZNGQ+zYfVFfQr1y/absYPLbG6Rf0/oT f8X/fX0dnYqjiEFXDRL5FOtt9HznLohCVuGPJdGEshx5Jp2ewT2e6OkYP2ZHoVVbZPDsopSm0z c69cWdYx/ttYdhyUOMOUr3gNkFARlQSI30z+LC6JEfbNkOvrk55wS2Ub3eaLWNjWy0kmrbEDLe OVGeaTmB7vWKfKYN5veTGgetqE0KV941lbeTerPa0Qdds71KB8eu2+ybSKobsivEMUIsXeAGQx 9oCvoe2URib4FWrLiR8q/V/lBSL4FbFJx3jYHDwcCquF8A==; ARC-Authentication-Results: i=1; zsh.org; iprev=pass (mail-wm1-f51.google.com) smtp.remote-ip=209.85.128.51; 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=1627814773; bh=nE8juIs3LT+bpLu0Dei+PVokvxscOWJBzWPHAujZtLI=; h=List-Archive:List-Owner:List-Post:List-Unsubscribe:List-Subscribe:List-Help: List-Id:Sender:Content-Type:To:Subject:Message-ID:Date:From:MIME-Version: DKIM-Signature:DKIM-Signature; b=0fKYbsBQJh3MQTmx92jahQUiL1SfmQotKsPw8Bqg/LkbsZUzTLM79BxLiLWkqqnG3yEafUZ1dt AXw0un5lBYd5RsNOUBMZcCajz2DTrf7G58b/WxbkR/3N73cxnMeGrAmUzl6pVKxBUJ0heODEhJ yYggjSorQqoN3l1Wnn5KKX+xVNOS4LozJIEu1n8BhQyevch1W/Y4Ej+floryoh5g+srJnDzB/V eyiktPi9YiS4GwGBr+thXtDEmFmyqfPSVt5VwmlC6fxP9k0m+WuJUFJsSkYVh+LCYhEV6aaGSd WshEapoU+5UkpFbqM4vY1nstwuzdwCMDo620UnZGCOaoNA==; 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:To:Subject:Message-ID: Date:From:MIME-Version:Reply-To:Cc:Content-Transfer-Encoding:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:In-Reply-To:References; bh=xVRINx5X8XhIcAqBmV5GlwD0W81ui4FKwNt/oRuEy1M=; b=BYRlIgy6wjD0qGoC5LUGnDFK/m oNX0TNETDJgcz5cX6vBHYsLIU4dWMo7/2C1w8zsOufxGkxYQ/DrYhjcUHadI+Ck8flVLukqSh73IF uPftP3Hq+Eoc/s1UqpMFkZ8mfw4Q35GuPG23NCDRJtsn2rWWW29SUCUmv8V8fO6SYNQMIfjAGyN8C VsF1B2q3umqAtRESnE05QOP7WRsbQq2D6jpkZxnPMtRCntoDIdTh89Qhsm80VUh3jUvOwRubb74Zg U/OCquQCNOAnuXrKazGyxk5z9qQOPE6fsZGnXna3XQawZB9g0H4U3Op5kohimlEQfeP4eej7GsGiR HxlB29kg==; Received: from authenticated user by zero.zsh.org with local id 1mA8yw-0000km-4c; Sun, 01 Aug 2021 10:46:10 +0000 Authentication-Results: zsh.org; iprev=pass (mail-wm1-f51.google.com) smtp.remote-ip=209.85.128.51; dkim=pass header.d=gmail.com header.s=20161025 header.a=rsa-sha256; dmarc=pass header.from=gmail.com; arc=none Received: from mail-wm1-f51.google.com ([209.85.128.51]:35685) by zero.zsh.org with esmtps (TLS1.3:TLS_AES_128_GCM_SHA256:128) id 1mA8xs-000Q0c-DK; Sun, 01 Aug 2021 10:45:05 +0000 Received: by mail-wm1-f51.google.com with SMTP id n12-20020a05600c3b8cb029025a67bbd40aso1799843wms.0 for ; Sun, 01 Aug 2021 03:45:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:from:date:message-id:subject:to; bh=xVRINx5X8XhIcAqBmV5GlwD0W81ui4FKwNt/oRuEy1M=; b=t5y/NWkAdPxl74g5Ss9SW6ahFzkDtJybV3SMjJ49Ok4cHGVAI1Uopk7xbKwCyP0nsp uTEaHg0d87ZXBwNYRENIX6sCjXbgsJuCKiPoUhfsuQ32fhxjfA/5eAk8yR7xkrxAU5B0 XJr1Wdj9Brmfk9MfgzRBLah8TwyuzWZZ+Rqv3oNcao0Xd0qhBVLRJEH3iBX+9SS3zNSA 5G2nYZ4OYck249YgfJ+/RISdZceVBrpSDG4vFfpMUZQ7Ws1PTnehPs9thL46K+9PbFpn ml+tIYCuYxFX0ADBVpJVJ55gS3UckvU3kdhI7LlpIaec3WIyrazAhMme2ufC5ChlOPj4 d1dg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=xVRINx5X8XhIcAqBmV5GlwD0W81ui4FKwNt/oRuEy1M=; b=memFLA4Bp0jeV5bP8aHtwut8eG9WZ6ZwRuRUlD4Prp6KTMowXtwb2OkiHpHlzUGpXk E5lgR8XvP5T1boXp7pQqjgkxM75Ho4UYJkgUXA6SLiTl1HEzgyVeu0RI5qdCiKToJORL +RPPGOc3UIE+CgYGPxUdn2p3pCwqyFGKovkf06tZ3b2qatOa677ge+zqk8whB40VNRUK GsoWYJEQnHQhg51YA1FYnuBWsdjtTruIxoomtg6vCLvf226qAAlpyq/Xfn7roEjOUpn2 Ri4Yx2OgQXh+yDCqvcm8r+vfSbYlprFIBZvLdTqobwtqAfEoToo+qJXXgdtl4OEtUD9Y v2RA== X-Gm-Message-State: AOAM530Wkj8An+l6cwenYJLNNpeqqcBORwknF0aL9a0xU+EtwQB6um8u VLH8RH/WbhLFloxnFMLZZRDuRtmXwCKM7nhIB3rjc2OT X-Google-Smtp-Source: ABdhPJyRJOYzEol9595iYyDWdfrlA2UKXbY7fcmTq5N2rLzX1/O5avpO5doNY/8ExzLAjzIZjEDr/jbyrJ6PQsZ8M18= X-Received: by 2002:a05:600c:cc:: with SMTP id u12mr11620822wmm.63.1627814703248; Sun, 01 Aug 2021 03:45:03 -0700 (PDT) MIME-Version: 1.0 From: Zach Riggle Date: Sun, 1 Aug 2021 05:44:52 -0500 Message-ID: Subject: Better Help Docs Searching? To: Zsh Users Content-Type: text/plain; charset="UTF-8" X-Seq: 26825 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: 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