Date: Sat, 30 Dec 2017 20:49:25 +0000 (UTC) From: Adam Weinberger <adamw@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r51347 - head/en_US.ISO8859-1/books/porters-handbook/special Message-ID: <201712302049.vBUKnPfi024925@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: adamw (ports committer) Date: Sat Dec 30 20:49:24 2017 New Revision: 51347 URL: https://svnweb.freebsd.org/changeset/doc/51347 Log: 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 Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Fri Dec 29 16:37:22 2017 (r51346) +++ head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Sat Dec 30 20:49:24 2017 (r51347) @@ -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>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201712302049.vBUKnPfi024925>