「Cagebreak」の版間の差分

提供: ArchWiki
ナビゲーションに移動 検索に移動
 
(3人の利用者による、間の6版が非表示)
1行目: 1行目:
−
[[Category:Wayland compositors]]
 +
[[Category:Wayland コンポジタ]]
 
[[en:Cagebreak]]
  
[[en:Cagebreak]]
 
{{Related articles start}}
  
{{Related articles start}}
6行目: 6行目:
 
{{Related articles end}}
  
{{Related articles end}}
   
−
[https://github.com/project-repo/cagebreak Cagebreak] is a tiling compositor for [[wayland]], based on {{Pkg|cage}} and inspired by [[ratpoison]], which is easily
 +
[https://github.com/project-repo/cagebreak Cagebreak] は [[Wayland]] 用のタイル型コンポジタです。{{Pkg|cage}} をベースとしており、キーボードや UNIX ドメインソケットで簡単に操作できる [[ratpoison]] の影響を受けています。
−
controlled through the keyboard and a unix domain socket.
  
   
−
== Installation ==
 +
== インストール ==
   
  +
{{AUR|cagebreak}} または {{AUR|cagebreak-bin}} を[[インストール]]してください。もしくは [https://github.com/project-repo/cagebreak/releases/latest リリース版 tarball] をダウンロードするか [https://github.com/project-repo/cagebreak リポジトリ] をクローンしてください。
−
[[Install]] {{AUR|cagebreak}} or
  
−
{{AUR|cagebreak-bin}}. Alternatively, download a
  
−
[https://github.com/project-repo/cagebreak/releases/latest release tarball] or
  
−
clone the [https://github.com/project-repo/cagebreak repository].
  
   
−
=== Optional dependencies ===
 +
=== 任意の依存パッケージ ===
   
−
* {{Pkg|wl-clipboard}} for copy/paste capabilities
 +
* {{Pkg|wl-clipboard}} - コピー・ペースト機能
−
* {{Pkg|xorg-xwayland}} for allowing [[Xorg]] applications to run under cagebreak
 +
* {{Pkg|xorg-xwayland}} - cagebreak の元で [[Xorg]] アプリケーションを実行
   
−
== Configuration ==
 +
== 設定 ==
   
−
The general configuration for cagebreak is located in {{ic|$XDG_CONFIG_PATH/cagebreak/config}}. This defaults to {{ic|~/.config/cagebreak/config}}.
+
cagebreak の全般設定は {{ic|$XDG_CONFIG_PATH/cagebreak/config}} に存在します。デフォルトは {{ic|~/.config/cagebreak/config}} です。
   
−
Read the [https://github.com/project-repo/cagebreak/tree/master/man/cagebreak-config.5.md configuration man page] for detailed information. Note that you can also add configuration by using [[#Interaction through socket]].
 +
詳しくは [https://github.com/project-repo/cagebreak/tree/master/man/cagebreak-config.5.md 設定の man ページ] を見てください。[[#ソケットによる操作]]を使って設定を追加することも可能です。
   
−
An example configuration file may be found on [https://github.com/project-repo/cagebreak/tree/master/examples/config Github].
 +
設定ファイルの例は [https://github.com/project-repo/cagebreak/tree/master/examples/config Github] にあります。
   
−
== Usage ==
 +
== 使用方法 ==
   
  +
他のバイナリと同じように cagebreak を実行してください。
−
Start cagebreak like any other binary.
  
   
−
=== Getting started ===
 +
=== はじめに ===
   
−
The following is an example of how to install and use cagebreak with the configuration file provided on [https://github.com/project-repo/cagebreak/tree/master/examples/config Github].
 +
以下は [https://github.com/project-repo/cagebreak/tree/master/examples/config Github] にある設定ファイルを使って cagebreak をインストール・使用する例です。
   
−
# Install {{ic|cagebreak}} as per [[#Installation]]. You should use {{AUR|cagebreak-bin}} unless you have reasons to do otherwise.
 +
# [[#インストール]]にあるように {{ic|cagebreak}} をインストール。特に理由がなければ {{AUR|cagebreak-bin}} を使うことを推奨します。
−
# Copy the example configuration from [https://github.com/project-repo/cagebreak/tree/master/examples/config Github] to {{ic|$XDG_CONFIG_PATH/cagebreak/config}}. Documentation is provided in the [https://github.com/project-repo/cagebreak/tree/master/man/cagebreak-config.5.md configuration man page].
 +
# [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}} を適当なターミナルエミュレータに置き換えてください。
−
# Install {{ic|xterm}} or replace {{ic|xterm}} with your preferred terminal emulator in the configuration file.
  
−
# Run the following command or add it to {{ic|~/.bash_profile}} to run cagebreak on login (see [[#Keyboard layout]] and [[#Firefox]] for explanation):
 +
# 以下のコマンドを実行するか {{ic|~/.bash_profile}} に追加してログイン時に cagebreak を起動するように設定:
 
#* {{ic|MOZ_USE_WAYLAND=1 GDK_BACKEND=wayland XKB_DEFAULT_LAYOUT=us cagebreak}}
  
#* {{ic|MOZ_USE_WAYLAND=1 GDK_BACKEND=wayland XKB_DEFAULT_LAYOUT=us cagebreak}}
−
# Cagebreak should start up and display the terminal emulator you specified above. Press {{ic|C-t}} {{ic|t}} to open a new terminal or {{ic|C-t}} {{ic|S}} to split the screen. You can also use {{ic|Alt-<number>}} to switch to the workspace {{ic|<number>}}. For a full list of available keybindings, read the configuration file and the [https://github.com/project-repo/cagebreak/tree/master/man/cagebreak-config.5.md documentation].
 +
# 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#ソケットによる操作|ソケットによる操作]] を参照してください。
−
# If you wish, you may also interact with cagebreak using the unix domain socket. See [[#Interaction through socket]] for further information.
  
  +
# また、バグを見つけたら報告してください。
−
# Also, please file any bugs you may find:
  
−
#* [https://github.com/project-repo/cagebreak/issues/ Github issue tracker] or via email as per [https://github.com/project-repo/cagebreak/blob/master/README.md the readme] for 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 comments for the {{AUR|cagebreak-bin}} and {{AUR|cagebreak}} PKGBUILDs
 +
#* {{AUR|cagebreak-bin}} および {{AUR|cagebreak}} PKGBUILD の AUR コメント
   
−
=== Keyboard layout ===
 +
=== キーボードレイアウト ===
   
−
Set the environment variable {{ic|XKB_DEFAULT_LAYOUT}} to the desired keyboard layout. See the [https://github.com/project-repo/cagebreak/blob/master/man/cagebreak.1.md#environment man page] for further information.
 +
環境変数 {{ic|XKB_DEFAULT_LAYOUT}} に希望のキーボードレイアウトを設定します。詳しくは、[https://github.com/project-repo/cagebreak/blob/master/man/cagebreak.1.md#environment man page] をご覧ください。
   
−
=== Interaction through socket ===
 +
=== ソケットによる操作 ===
   
  +
起動時に、cagebreak は unix ドメインソケットを開き、ランタイムにコンポジターとのインタラクションが可能になります。このソケットへのパスは {{ic|CAGEBREAK_SOCKET}} 環境変数に格納されます。例えば、{{Pkg|openbsd-netcat}} は次のように呼び出すことができます。
−
On startup, cagebreak opens a unix domain socket through which interaction with the compositor is possible
  
−
at run-time. The path to this socket is stored in the {{ic|CAGEBREAK_SOCKET}} environment variable.
  
−
For example, {{Pkg|openbsd-netcat}} may be invoked with:
  
   
 
$ nc -U $CAGEBREAK_SOCKET
  
$ nc -U $CAGEBREAK_SOCKET
   
  +
実行中に cagebreak の設定を送信します。設定は、設定ファイルの構文と同じです。
−
to send cagebreak any configuration while it is running. The syntax is identical to the syntax of the configuration file.
  
   
  +
ソケット経由でビューの名前を確認したい場合は、--bs (bad security) オプションを追加します (ローカルシステムでのセキュリティへの影響を考慮してください。)
−
== See also ==
  
  +
  +
== 参照 ==
   
 
# [https://github.com/project-repo/cagebreak github]
  
# [https://github.com/project-repo/cagebreak github]
−
# [https://github.com/project-repo/cagebreak/wiki github wiki]
  
 
# [https://github.com/project-repo/cagebreak-pkgbuild pkgbuild on github]
  
# [https://github.com/project-repo/cagebreak-pkgbuild pkgbuild on github]

2024年8月16日 (金) 17:09時点における最新版

関連記事

Cagebreak は Wayland 用のタイル型コンポジタです。cage をベースとしており、キーボードや UNIX ドメインソケットで簡単に操作できる ratpoison の影響を受けています。

インストール

cagebreakAUR または cagebreak-binAUR をインストールしてください。もしくは リリース版 tarball をダウンロードするか リポジトリ をクローンしてください。

任意の依存パッケージ

設定

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

詳しくは 設定の man ページ を見てください。#ソケットによる操作を使って設定を追加することも可能です。

設定ファイルの例は Github にあります。

使用方法

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

はじめに

以下は Github にある設定ファイルを使って cagebreak をインストール・使用する例です。

  1. #インストールにあるように cagebreak をインストール。特に理由がなければ cagebreak-binAUR を使うことを推奨します。
  2. Github から $XDG_CONFIG_PATH/cagebreak/config にサンプル設定をコピー。ドキュメントは configuration man page に存在します。
  3. xterm をインストールするか設定ファイル内の xterm を適当なターミナルエミュレータに置き換えてください。
  4. 以下のコマンドを実行するか ~/.bash_profile に追加してログイン時に cagebreak を起動するように設定:
    • MOZ_USE_WAYLAND=1 GDK_BACKEND=wayland XKB_DEFAULT_LAYOUT=us cagebreak
  5. Cagebreak が起動すると上記で指定したターミナルエミュレータが表示されます。C-t t を押して新しいターミナルを開いたり C-t S で画面を分割できます。また、Alt-<number> でワークスペースを <number> に切り替えられます。利用可能なキーバインドについては設定ファイルや documentation を参照してください。
  6. 必要に応じて、UNIX ドメインソケットを使用して Cagebreak と対話することもできます。詳細については、ソケットによる操作 を参照してください。
  7. また、バグを見つけたら報告してください。

キーボードレイアウト

環境変数 XKB_DEFAULT_LAYOUT に希望のキーボードレイアウトを設定します。詳しくは、man page をご覧ください。

ソケットによる操作

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

$ nc -U $CAGEBREAK_SOCKET

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

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

参照

  1. github
  2. pkgbuild on github
「https://wiki.archlinux.jp/index.php?title=Cagebreak&oldid=38497」から取得