Cagebreakのソースを表示

[[Category:Wayland コンポジタ]]
[[en:Cagebreak]]
{{Related articles start}}
{{Related|Wayland#コンポジタ}}
{{Related|ウィンドウマネージャ}}
{{Related articles end}}

[https://github.com/project-repo/cagebreak Cagebreak] は [[Wayland]] 用のタイル型コンポジタです。{{Pkg|cage}} をベースとしており、キーボードや UNIX ドメインソケットで簡単に操作できる [[ratpoison]] の影響を受けています。

== インストール ==

{{AUR|cagebreak}} または {{AUR|cagebreak-bin}} を[[インストール]]してください。もしくは [https://github.com/project-repo/cagebreak/releases/latest リリース版 tarball] をダウンロードするか [https://github.com/project-repo/cagebreak リポジトリ] をクローンしてください。

=== 任意の依存パッケージ ===

* {{Pkg|wl-clipboard}} - コピー・ペースト機能
* {{Pkg|xorg-xwayland}} - cagebreak の元で [[Xorg]] アプリケーションを実行

== 設定 ==

cagebreak の全般設定は {{ic|$XDG_CONFIG_PATH/cagebreak/config}} に存在します。デフォルトは {{ic|~/.config/cagebreak/config}} です。

詳しくは [https://github.com/project-repo/cagebreak/tree/master/man/cagebreak-config.5.md 設定の man ページ] を見てください。[[#ソケットによる操作]]を使って設定を追加することも可能です。

設定ファイルの例は [https://github.com/project-repo/cagebreak/tree/master/examples/config Github] にあります。

== 使用方法 ==

他のバイナリと同じように cagebreak を実行してください。

=== はじめに ===

以下は [https://github.com/project-repo/cagebreak/tree/master/examples/config Github] にある設定ファイルを使って cagebreak をインストール・使用する例です。

# [[#インストール]]にあるように {{ic|cagebreak}} をインストール。特に理由がなければ {{AUR|cagebreak-bin}} を使うことを推奨します。
# [https://github.com/project-repo/cagebreak/tree/master/examples/config Github] から {{ic|$XDG_CONFIG_PATH/cagebreak/config}} にサンプル設定をコピー。ドキュメントは [https://github.com/project-repo/cagebreak/tree/master/man/cagebreak-config.5.md configuration man page] に存在します。
# {{ic|xterm}} をインストールするか設定ファイル内の {{ic|xterm}} を適当なターミナルエミュレータに置き換えてください。
# 以下のコマンドを実行するか {{ic|~/.bash_profile}} に追加してログイン時に cagebreak を起動するように設定:
#*  {{ic|MOZ_USE_WAYLAND&#61;1 GDK_BACKEND&#61;wayland XKB_DEFAULT_LAYOUT&#61;us cagebreak}}
# Cagebreak が起動すると上記で指定したターミナルエミュレータが表示されます。{{ic|C-t}} {{ic|t}} を押して新しいターミナルを開いたり {{ic|C-t}} {{ic|S}} で画面を分割できます。また、{{ic|Alt-<number>}} でワークスペースを {{ic|<number>}} に切り替えられます。利用可能なキーバインドについては設定ファイルや [https://github.com/project-repo/cagebreak/tree/master/man/cagebreak-config.5.md documentation] を参照してください。
# 必要に応じて、UNIX ドメインソケットを使用して Cagebreak と対話することもできます。詳細については、[[Cagebreak#ソケットによる操作|ソケットによる操作]] を参照してください。
# また、バグを見つけたら報告してください。
#* [https://github.com/project-repo/cagebreak/issues/ GitHub issue tracker] または [https://github.com/project-repo/cagebreak/blob/master/SECURITY.md#email-contact SECURITY.md]に従い、GitHub の issue tracker または電子メールで報告して下さい。
#* {{AUR|cagebreak-bin}} および {{AUR|cagebreak}} PKGBUILD の AUR コメント

=== キーボードレイアウト ===

環境変数 {{ic|XKB_DEFAULT_LAYOUT}} に希望のキーボードレイアウトを設定します。詳しくは、[https://github.com/project-repo/cagebreak/blob/master/man/cagebreak.1.md#environment man page] をご覧ください。

=== ソケットによる操作 ===

起動時に、cagebreak は unix ドメインソケットを開き、ランタイムにコンポジターとのインタラクションが可能になります。このソケットへのパスは {{ic|CAGEBREAK_SOCKET}} 環境変数に格納されます。例えば、{{Pkg|openbsd-netcat}} は次のように呼び出すことができます。

 $ nc -U $CAGEBREAK_SOCKET

実行中に cagebreak の設定を送信します。設定は、設定ファイルの構文と同じです。

ソケット経由でビューの名前を確認したい場合は、--bs (bad security) オプションを追加します (ローカルシステムでのセキュリティへの影響を考慮してください。)

== 参照 ==

# [https://github.com/project-repo/cagebreak github]
# [https://github.com/project-repo/cagebreak-pkgbuild pkgbuild on github]