From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on inbox.vuxu.org X-Spam-Level: X-Spam-Status: No, score=-1.0 required=5.0 tests=MAILING_LIST_MULTI, RCVD_IN_DNSWL_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.2 Received: (qmail 10119 invoked from network); 15 Apr 2020 02:11:11 -0000 Received-SPF: pass (primenet.com.au: domain of zsh.org designates 203.24.36.2 as permitted sender) receiver=inbox.vuxu.org; client-ip=203.24.36.2 envelope-from= Received: from ns1.primenet.com.au (HELO primenet.com.au) (203.24.36.2) by inbox.vuxu.org with UTF8ESMTPZ; 15 Apr 2020 02:11:11 -0000 Received: (qmail 22160 invoked by alias); 15 Apr 2020 02:11:05 -0000 Mailing-List: contact zsh-workers-help@zsh.org; run by ezmlm Precedence: bulk X-No-Archive: yes List-Id: Zsh Workers List List-Post: List-Help: List-Unsubscribe: X-Seq: 45702 Received: (qmail 20639 invoked by uid 1010); 15 Apr 2020 02:11:05 -0000 X-Qmail-Scanner-Diagnostics: from mail-qt1-f177.google.com by f.primenet.com.au (envelope-from , uid 7791) with qmail-scanner-2.11 (clamdscan: 0.102.2/25779. spamassassin: 3.4.4. Clear:RC:0(209.85.160.177):SA:0(-1.9/5.0):. Processed in 0.733981 secs); 15 Apr 2020 02:11:05 -0000 X-Envelope-From: dana@dana.is X-Qmail-Scanner-Mime-Attachments: | X-Qmail-Scanner-Zip-Files: | Received-SPF: pass (ns1.primenet.com.au: SPF record at _netblocks.google.com designates 209.85.160.177 as permitted sender) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=lkc65EysXu/Xi+mqed8Y9trj5gD/WNBdfybxSvhlJWc=; b=OWMr0F86Woehv/oTg4DkyPAvvg27qlQ4jUxpyhK1XIXRmFtN7DH8Galsbfy1v3oQ7w pKZDfw3WwLPTT7f7d8eOv4Ba8+5YP5v5PTNo7Pfw+j2yJqVniumIRr2jUMSEta7ucHaR 7uRyCIpaAdFuuxqgZrdghIQRWorrg5PGWGVh0G16DZT1SrDdb8lxQEDV9FqcyQ8v8pz/ 3pkN0x3zRBu4EMqOhAaZr5w7ekWAdGdlVZpXmUfWOCCeK7+qdH93SKBXHWFdQpUn7ux6 JmSp1Tu0/GnoLY7qsv6jv+ZzC9RiYnkmatZJVBKpByX2FTdMrM5a1RTtFP1kuQXZWHJu 4Fgg== X-Gm-Message-State: AGi0PuYZp5nf8G/EXs1vsWVYL2WXbvd+pieW5qkEuaRCUMSqy9VJzfAn YitqTAfMQQNmgiGk2pdJCS06TGVf9cM= X-Google-Smtp-Source: APiQypJqOBvJTH4vLpjTEKfc99rtCmYQpvGOx0y7gnaO+my3sWV1TfBnJVT/8m94jI6PD/JllwmNOg== X-Received: by 2002:ac8:c84:: with SMTP id n4mr19330641qti.24.1586916631251; Tue, 14 Apr 2020 19:10:31 -0700 (PDT) Content-Type: text/plain; charset=us-ascii Mime-Version: 1.0 (Mac OS X Mail 13.0 \(3608.60.0.2.5\)) Subject: [PATCH] Improve documentation of {insert,separate}-sections From: dana In-Reply-To: Date: Tue, 14 Apr 2020 21:10:29 -0500 Cc: Dave Woodfall Content-Transfer-Encoding: quoted-printable Message-Id: <057B75B5-4B9B-4694-B500-54038FF8CA42@dana.is> References: <20200406002612.GE9554@blackswan.r0t.uk> To: Zsh hackers list X-Mailer: Apple Mail (2.3608.60.0.2.5) Here's the insert-sections documentation i promised in users/24756. Also = fixed some inconsistent formatting and a typo dana diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo index c2d20ca40..cbee305b6 100644 --- a/Doc/Zsh/compsys.yo +++ b/Doc/Zsh/compsys.yo @@ -1826,6 +1826,24 @@ be unsuccessful until that point. If the value = is any other string, menu completion will be started when the string typed by the user is longer than the common prefix to the corresponding IDs. ) +kindex(insert-sections, completion style) +item(tt(insert-sections))( +This style is used with tags of the form `tt(manuals.)var(X)' when +completing names of manual pages. If set to `true' and the var(X) in = the +tag name matches the section number of the page being completed, the +section number is inserted along with the page name. For example, given + +example(zstyle ':completion:*:manuals.*' insert-sections true) + +tt(man ssh_) may be completed to tt(man 5 ssh_config). + +This is especially useful in conjunction with tt(separate-sections), as +it ensures that the page requested of tt(man) corresponds to the one +displayed in the completion listing when there are multiple pages with = the +same name (e.g., tt(printf(1)) and tt(printf(3))). + +The default for this style is `false'. +) kindex(insert-tab, completion style) item(tt(insert-tab))( If this is set to `true', the completion system will @@ -2445,7 +2463,7 @@ For example, example(zstyle ':completion:*' recursive-files '*/zsh/*') =20 If the current directory is tt(/home/pws/zsh/Src), then -tt(zle_tr)em(TAB) can be completed to tt(Zle/zle_tricky.c). +tt(zle_tr) can be completed to tt(Zle/zle_tricky.c). ) kindex(regular, completion style) item(tt(regular))( @@ -2502,12 +2520,13 @@ kindex(separate-sections, completion style) item(tt(separate-sections))( This style is used with the tt(manuals) tag when completing names of manual pages. If it is `true', entries for different sections are -added separately using tag names of the form `tt(manual.)var(X)', +added separately using tag names of the form `tt(manuals.)var(X)', where var(X) is the section number. When the tt(group-name) style is also in effect, pages from different sections will appear separately. This style is also used similarly with the tt(words) style when completing words for the dict command. It allows words from different -dictionary databases to be added separately. +dictionary databases to be added separately. See also = tt(insert-sections). + The default for this style is `false'. ) kindex(show-ambiguity, completion style)