シェルパッケージガイドライン - 版の履歴

Kgx: /* シェルの補完機能 */ 同期

2025-02-09T16:57:34Z

シェルの補完機能: 同期

← 古い版		2025年2月10日 (月) 01:57時点における版
27行目:		27行目:
	== シェルの補完機能 ==		== シェルの補完機能 ==

	ほとんどのシェルは、いくつかの一般的なコマンドの補完~~セット~~を内蔵しており、~~同時に他のパッケージによって提供~~さ~~れるかもしれない関数のため~~に少なくとも1つのシステムディレクトリをスキャンします。次の表は、パッケージが補完ファイルを置く場所と、そのファイル名~~をまとめたも~~のです。		ほとんどのシェルは、いくつかの一般的なコマンドに対してビルトインの補完機能を提供しており、さらに少なくとも1つのシステムディレクトリをスキャンして、他のパッケージが提供する可能性のある関数を検出します。以下の表は、パッケージが補完ファイルを配置できる場所と、ファイル名についての概要です。

	{\| class="wikitable"		{\| class="wikitable"
33行目:		33行目:
	\|-		\|-
	\| [[Bash]] \|\| {{ic\|/usr/share/bash-completion/completions}} \|\| {{ic\|''binary_name''}}		\| [[Bash]] \|\| {{ic\|/usr/share/bash-completion/completions}} \|\| {{ic\|''binary_name''}}
			\|-
			\| [[Elvish]] \|\| {{ic\|/usr/share/elvish/lib/}} \|\| {{ic\|''binary_name''.elv}}
	\|-		\|-
	\| [[fish]] \|\| {{ic\|/usr/share/fish/vendor_completions.d}} \|\| {{ic\|''binary_name''.fish}}		\| [[fish]] \|\| {{ic\|/usr/share/fish/vendor_completions.d}} \|\| {{ic\|''binary_name''.fish}}
39行目:		41行目:
	\|}		\|}

	その他のシェル		その他のシェル:

	* [[~~コマンドラインシェル#代替シェル\|Elvish~~]] は~~いくつかの~~デフォルトの補完を提供しますが、補完を提供するシステム全体のディレクトリはまだ [[https://github.com/~~elves~~/~~elvish~~/issues/~~1004~~] ~~ありません。Elvish~~ ~~シェル~~補完関数を生成するパッケージの場合、一つの解決策は {{ic\|/usr/share/~~elvish~~/~~completions~~/''binary_name''.~~elv~~}} をパッケージ化して {{ic\|post_install()}} 関数を使用して、ユーザーが {{ic\|~~$XDG_CONFIG_HOME~~/~~elvish~~/~~lib~~/}} ~~ディレク~~トリに~~シンボリックリンクでき~~るように ~~tip を表~~示する~~ことでしょう~~。		[[Nushell]] はデフォルトの補完機能をいくつか提供していますが、まだ補完ファイルを提供するためのシステム全体のディレクトリはありません [https://github.com/nushell/nushell/issues/11337] Nushell の補完関数を生成するパッケージの場合、1つの解決策として、{{ic\|/usr/share/nushell/autoload/''binary_name''.nu}} にパッケージ化し、{{ic\|post_install()}} 関数を使用して、ユーザーに {{ic\|use /path/to/file}} ステートメントを設定ファイルに追加するように指示する方法があります。

	{{Tip\|一般的なルールとして、パッケージはシェルに ''depend'' や ''optdepends'' を持つべきではありません。たまたまそのための補完を提供したからといって、パッケージの依存関係を示唆するものではありません。補完機能はデフォルトのシェルパッケージには存在しませんが、補足の収集パッケージ {{Pkg\|bash-completion}} や {{Pkg\|zsh-completions}} によって ''提供'' されます。これらのパッケージに補完ファイルが存在する場合、それらを {{ic\|optdepends}} に追加してください。}}		{{Tip\|一般的なルールとして、パッケージはシェルに ''depend'' や ''optdepends'' を持つべきではありません。たまたまそのための補完を提供したからといって、パッケージの依存関係を示唆するものではありません。補完機能はデフォルトのシェルパッケージには存在しませんが、補足の収集パッケージ {{Pkg\|bash-completion}} や {{Pkg\|zsh-completions}} によって ''提供'' されます。これらのパッケージに補完ファイルが存在する場合、それらを {{ic\|optdepends}} に追加してください。}}

Kgx: リンクを修正

2022-02-22T13:45:57Z

リンクを修正

← 古い版		2022年2月22日 (火) 22:45時点における版
2行目:		2行目:
	[[en:Shell package guidelines]]		[[en:Shell package guidelines]]
	{{Related articles start}}		{{Related articles start}}
	{{Related\|~~Command-line shell~~}}		{{Related\|コマンドラインシェル}}
	{{Related articles end}}		{{Related articles end}}
	{{Package Guidelines}}		{{Package Guidelines}}

Kgx: /* Shell completions */ 翻訳

2022-02-22T13:44:56Z

Shell completions: 翻訳

← 古い版		2022年2月22日 (火) 22:44時点における版
25行目:		25行目:
	}}		}}

			== シェルの補完機能 ==
	== Shell completions ==

			ほとんどのシェルは、いくつかの一般的なコマンドの補完セットを内蔵しており、同時に他のパッケージによって提供されるかもしれない関数のために少なくとも1つのシステムディレクトリをスキャンします。次の表は、パッケージが補完ファイルを置く場所と、そのファイル名をまとめたものです。
	Most shells provide a built in set of completions for a few common commands while also scanning at least one system directory for functions that may be supplied by other packages. The following table is a summary of where packages may place completion files and what the files should be named.

	{\| class="wikitable"		{\| class="wikitable"
	! ~~Shell~~ !! ~~Directory~~ !! ~~File~~		! シェル !! ディレクトリ !! ファイル
	\|-		\|-
	\| [[Bash]] \|\| {{ic\|/usr/share/bash-completion/completions}} \|\| {{ic\|''binary_name''}}		\| [[Bash]] \|\| {{ic\|/usr/share/bash-completion/completions}} \|\| {{ic\|''binary_name''}}
39行目:		39行目:
	\|}		\|}

			その他のシェル
	Other shells:

	* [[Elvish]] ~~provides~~ ~~some default completions, but does ''not'' have a system-wide directory where completions can be provided yet~~[https://github.com/elves/elvish/issues/1004]~~. For packages that generate~~ Elvish ~~shell completion functions, one solution would be to package them~~ {{ic\|/usr/share/elvish/completions/''binary_name''.elv}} ~~and use a~~ {{ic\|post_install()}} ~~function to print a tip for users to symlink it to their~~ {{ic\|$XDG_CONFIG_HOME/elvish/lib/}} ~~directory.~~		* [[コマンドラインシェル#代替シェル\|Elvish]] はいくつかのデフォルトの補完を提供しますが、補完を提供するシステム全体のディレクトリはまだ [[https://github.com/elves/elvish/issues/1004] ありません。Elvish シェル補完関数を生成するパッケージの場合、一つの解決策は {{ic\|/usr/share/elvish/completions/''binary_name''.elv}} をパッケージ化して {{ic\|post_install()}} 関数を使用して、ユーザーが {{ic\|$XDG_CONFIG_HOME/elvish/lib/}} ディレクトリにシンボリックリンクできるように tip を表示することでしょう。

			{{Tip\|一般的なルールとして、パッケージはシェルに ''depend'' や ''optdepends'' を持つべきではありません。たまたまそのための補完を提供したからといって、パッケージの依存関係を示唆するものではありません。補完機能はデフォルトのシェルパッケージには存在しませんが、補足の収集パッケージ {{Pkg\|bash-completion}} や {{Pkg\|zsh-completions}} によって ''提供'' されます。これらのパッケージに補完ファイルが存在する場合、それらを {{ic\|optdepends}} に追加してください。}}
	{{Tip\|As a general rule, packages should have neither ''depends'' nor ''optdepends'' on shells. Just because they happen to supply completions for them does not imply a package dependency relationship any way. The exception is packages that do not supply their own completions; the completions do not exist in the default shell package, but they ''are provided'' by the supplemental collection packages {{Pkg\|bash-completion}} or {{Pkg\|zsh-completions}}. When completion files exist in these packages, add them to {{ic\|optdepends}}.}}

Kgx: /* Install */ 翻訳

2022-02-22T13:40:21Z

Install: 翻訳

← 古い版		2022年2月22日 (火) 22:40時点における版
6行目:		6行目:
	{{Package Guidelines}}		{{Package Guidelines}}

			== インストール方法 ==
	== Install ==

			ユーザが [[コマンドラインシェル#デフォルトシェルの変更\|シェルの変更]] を行うには、シェルを {{ic\|/etc/shells}} に記述する必要があります。ほとんどのシェルパッケージには以下のようなインストールスクリプトがあります。
	For users to [[Command-line shell#Changing your default shell\|change shells]], the shell must appear in {{ic\|/etc/shells}}. Most shell packages have install scripts like below:

	{{hc\|''shellname''.install\|		{{hc\|''shellname''.install\|

Kgx: 英語版から転載

2022-02-22T13:39:20Z

英語版から転載

新規ページ

[[Category:Arch パッケージガイドライン]]
[[en:Shell package guidelines]]
{{Related articles start}}
{{Related|Command-line shell}}
{{Related articles end}}
{{Package Guidelines}}

== Install ==

For users to [[Command-line shell#Changing your default shell|change shells]], the shell must appear in {{ic|/etc/shells}}. Most shell packages have install scripts like below:

{{hc|''shellname''.install|
post_install() {
grep -Fqx /bin/''shellname'' /etc/shells {{!}}{{!}} echo /bin/''shellname'' >>/etc/shells
grep -Fqx /usr/bin/''shellname'' /etc/shells {{!}}{{!}} echo /usr/bin/''shellname'' >>/etc/shells
}

post_upgrade() {
post_install
}

post_remove() {
sed -i -r '/^(\/usr)?\/bin\/''shellname''$/d' etc/shells
}
}}

== Shell completions ==

Most shells provide a built in set of completions for a few common commands while also scanning at least one system directory for functions that may be supplied by other packages. The following table is a summary of where packages may place completion files and what the files should be named.

{| class="wikitable"
! Shell !! Directory !! File
|-
| [[Bash]] || {{ic|/usr/share/bash-completion/completions}} || {{ic|''binary_name''}}
|-
| [[fish]] || {{ic|/usr/share/fish/vendor_completions.d}} || {{ic|''binary_name''.fish}}
|-
| [[Zsh]] || {{ic|/usr/share/zsh/site-functions}} || {{ic|_''binary_name''}}
|}

Other shells:

* [[Elvish]] provides some default completions, but does ''not'' have a system-wide directory where completions can be provided yet[https://github.com/elves/elvish/issues/1004]. For packages that generate Elvish shell completion functions, one solution would be to package them {{ic|/usr/share/elvish/completions/''binary_name''.elv}} and use a {{ic|post_install()}} function to print a tip for users to symlink it to their {{ic|$XDG_CONFIG_HOME/elvish/lib/}} directory.

{{Tip|As a general rule, packages should have neither ''depends'' nor ''optdepends'' on shells. Just because they happen to supply completions for them does not imply a package dependency relationship any way. The exception is packages that do not supply their own completions; the completions do not exist in the default shell package, but they ''are provided'' by the supplemental collection packages {{Pkg|bash-completion}} or {{Pkg|zsh-completions}}. When completion files exist in these packages, add them to {{ic|optdepends}}.}}