X resources を設定することのメモ

リソースは1行単位で記す。各行は、いくつかのワード ― ここではコンポーネントと呼ぶ ― を . でつないで構成したリソース名と、そこへ格納したいリソース値を : で区切って記す。

instance.resource: value
class.resource: value

コンポーネントの大文字小文字は区別される。基本的には キャメルケース を用い、主にローワーキャメルケース（最初の文字は小文字）で表現する（例: xterm 、 geometry 、 scrollBar ）。

最初のコンポーネントは、リソースがどのアプリケーション設定かを示すための名前、つまりアプリケーション名である。アプリケーション名の表現はインスタンス（instance）か、あるいはクラス（class）で示すこととなる。

そしてドット区切りに続けてそのアプリケーションが持つリソース（resource）を記す。

リソースの持つ値、すなわちリソース値（value）として指定できるのは文字列、整数、ブーリアン（ true / false ）である。

インスタンスは、ほとんどの場合プログラム名（実行ファイル名）をもとにしたアプリケーション名である。

以下の例はインスタンス emacs というプログラムの cursorColor に dark green という値を適用したリソースを表している。Emacs のカーソル色をダークグリーンにするということだ。

emacs.cursorColor: dark green

インスタンスは前述のとおりプログラム名なので、これをリネームするならばインスタンスも同様に変わる。

このことを利用して以下のようなことができる。

例えば xterm の実行ファイル xterm を xtermgreen などと言う名前でコピーし、リソースには xtermgreen.background: #002540 と書いてロードしておき xtermgreen を起動すると、背景が #002540 （緑色）になる、というような使い方ができる。

もっとも、 xterm の場合には -name オプションでインスタンスを指定できるから、無駄にコピーなどせず xterm -name xtermgreen というように起動すれば同じことである。 urxvt なども然り。

前述のとおりインスタンスは固定的とはいい難いが、クラスを用いた定義では意図せずインスタンスが変わってしまったとしても、確実にアプリケーションを指定できる。ネットでよく見かける設定例では、以下のようにクラスを用いた記述が多い。

Emacs.background: #002540
Emacs.foreground: azure3

このクラス名の表現に限っては、 Emacs 、 Xmessage のようにアッパーキャメルケース（最初の文字も大文字）を用いるのが慣例とされている。が、歴史的経緯からちょっとややこしくなっている。

例えば XTerm のように X 関連のクラス名は最初の2文字までを大文字にしていることが多く、他にも XClock や XScreenSaver といったものがあるが、 Xfd などのように1文字目だけのものもある。また rxvt は Rxvt だが rxvt-unicode は URxvt である。さらに UXTerm というのもある。

URxvt.visualBell: true
URxvt.scrollBar: false

ともかく、クラスを使うには固有に決められているものを調べて正確に記述する配慮が必要だろう。

リソースの表現はワイルドカード（ ? * ）での置き換えが可能で、 ? は1つの、 * は複数のリソースとみなすことができる。

例えば urxvt と xterm の背景色定義はそれぞれ URxvt.background と XTerm.vt100.background などと記すが、両方のアプリケーションプログラムが取りうる値とすべく、以下のように記述を1つにまとめることができる。

*background: #282828

Xresources では ! を記すと以降をコメントとみなす。よく開発言語ではスクリプトを書いた行内の後ろにコメントを付与できるが、 Xresources ではそういうのはうけつけないようなのでコメントは1行ずつにしておいた方がよさそうだ。

また行末に \ を置くことで行を分割できる。

!! ~/.Xresources

! Colors
URxvt.colorIT: #8ec07c
URxvt.colorBD: #fe8019

! Fonts - DejaVu with IPAGothic
URxvt.font: xft:DejaVuSansMono Nerd Font-9,\
            xft:IPAGothic

#include で外部ファイルを差し込むことができる。例えばカラー定義だけを別のファイルにしたりできるから、テーマ切り替えを容易にする工夫ができそうだ。

#include "FILE"

パスはダブルクォーテーションで括って記すとカレントを基準にする。例えば以下のように ~/.Xresources に書いた場合、 ~/.Xresources.d ディレクトリの下にある theme_file というファイルを読み込むということになる。

#include ".Xresources.d/theme_file"

#define はマクロ置き換え機能だが、シンボルの定義が便利で、よく使われることだろう。

#define IDENTIFIER [REPLACEMENT]

ワイルドカードによるプロパティ指定ができても、結局色や書体の指定を何度となく行うこともあるだろう。そういったものを #define でまとめておくと改変が楽になるかもしれない。

#if 〜 #endif で条件式が扱える。Cの式をまんま書くことができるが、 defined （否定は !defined ）で定義の有無を判断できるのが便利である。この #if defined 、 #if !defined は #ifdef 、 #ifndef という簡略文に置き換えられる。

#ifdef | #ifndef 〜 #elif 〜 #else 〜 #endif

xrdb コマンドは -D オプションでシンボル定義をプリプロセッサに渡せる（値も渡せる）ので、 #ifdef と組み合わせることでロード時に独自の値を渡して条件分岐させることも可能になる（記述例の項を参照）。

以下は xterm と urxvt でリソース名が同じで、よく使われるものを区切り子 * で指定したもの。ほかに termName や、色定義の color0 などもある。

urxvt が xterm よりも後の実装で同じリソース名を使っているのはこういう事を企図したものと思う。

!! ~/.Xresources

*geometry: 96x36
*saveLines: 1000
*visualBell: true
*scrollBar: true
*cursorBlink: true
*cursorUnderLine: true
*background: #FBF1C7
*foreground: #282828

以下の例は色定義を別のファイル ~/.Xresources.d/theme_file にしたうえで、定数 DARK_THEME が定義されてあれば背景を黒にしてそうでなければ白にするもの。

!! ~/.Xresources

#include ".Xresources.d/theme_file"

*background: BG
*foreground: FG

!! ~/.Xresources.d/theme_file

#define colBlack #282828
#define colWhite #ebdbb2

#ifdef DARK_THEME
#define BG colBlack
#define FG colWhite
#else
#define BG colWhite
#define FG colBlack
#endif

上記2ファイルの構成で、以下のようにロードすると白っぽい背景になる。

$ xrdb ~/.Xresources

そして -D オプションで DARK_THEME を定義した場合には黒っぽい背景となる。

$ xrdb -DDARK_THEME ~/.Xresources

#include〜 より前のとこに #define DARK_THEME と書き込んどいて、都度コメントアウトしたりアンコメントするっていうやりかたもありだろう。

GitHub や Dropbox などを介し、複数ホストでドットファイルを使い回す工夫はよく行われていることだろう。するとPCシステムの違いなどによってパラメータを変える工夫をしなければならないことも多いが、 X resources でもプリプロセッサの解釈を利用することでそれが可能である。

シンボルには #define や xrdb -Dsymbol[=value] などで自前定義するものだけでなく、PC環境に則った内容が標準的に渡されるものもある（ xrdb -symbols で一覧表示できる。詳細は XRDB(1) ）。 hostname を格納した定数（ HOST , SERVERHOST ）もあるが、ここで至便なのは SRVR_ホスト名 で、これは hostname から生成されるシンボルである。

以下はシステムによってインストールされているフォントが違うことを条件分岐で補うもの。ホスト alicia では DejaVu と IPAゴシックの9ポを 、ホスト abigail.foo-bar.com では Inconsolata と Nasuフォント の11ポを、そしてそれ以外では monospace の9ポを使うというように、 xterm と urxvt の両方に設定してある。

!! ~/.Xresources

#ifdef SRVR_alicia
  #define  FONT       DejaVu Sans Mono
  #define  FONTW      IPAGothic
  #define  FONT_SIZE  9
#elif defined SRVR_abigail_foo_bar_com
  #define  FONT       Inconsolata
  #define  FONTW      NasuM
  #define  FONT_SIZE  11
#else
  #define  FONT       monospace:lang=en
  #define  FONTW      monospace:lang=ja
  #define  FONT_SIZE  9
#endif

XTerm*faceName:           FONT
XTerm*faceNameDoublesize: FONTW
XTerm*faceSize:           FONT_SIZE
URxvt.font:               xft:FONT-FONT_SIZE, xft:FONTW