Add a section on shell completion files. Basically, always install them,
and never register RUN_DEPENDS on the shells themselves. Approved by: mat (doc hat) Differential Revision: https://reviews.freebsd.org/D13696
This commit is contained in:
parent
4221c2a17d
commit
87cbed3f18
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=51347
1 changed files with 37 additions and 0 deletions
|
@ -5523,4 +5523,41 @@ GROUPS= pulse pulse-access pulse-rt</programlisting>
|
|||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect1>
|
||||
|
||||
<sect1 xml:id="shell-completion">
|
||||
<title>Shell Completion Files</title>
|
||||
|
||||
<para>Many modern shells (including bash, tcsh, and zsh) support
|
||||
parameter and/or option tab-completion. This support usually
|
||||
comes from completion files, which contain the definitions for
|
||||
how tab completion will work for a certain command. Ports
|
||||
sometimes ship with their own completion files, or porters may
|
||||
have created them themselves.</para>
|
||||
|
||||
<para>When available, completion files should always be
|
||||
installed. It is not necessary to make an option for it.
|
||||
If an option is used, though, always enable it in
|
||||
<varname>OPTIONS_DEFAULT</varname>.</para>
|
||||
|
||||
<table frame="none" xml:id="shell-completion-paths">
|
||||
<title>Shell completion file paths</title>
|
||||
|
||||
<tgroup cols="2">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry><command>bash</command></entry>
|
||||
<entry><filename>${PREFIX}/etc/bash_completion.d</filename></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><command>zsh</command></entry>
|
||||
<entry><filename>${PREFIX}/share/zsh/site-functions</filename></entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>Do not register any dependencies on the shells
|
||||
themselves.</para>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
|
Loading…
Reference in a new issue