高速イメージビューア sxiv を使うことのメモ

sxiv のステータスバー（ウィンドウ下端）左寄りにはファイル名が表示されているだけだが、この表示内容は ~/.config/sxiv/exec/image-info にスクリプトを書くことでカスタマイズが可能である。

公式のサンプル sxiv/image-info (GitHub) が用意されており、このスクリプトを使うとステータスバーに ファイルサイズ、画像サイズ、タグ、ファイル名 が表示されるようになる。

なお ‘タグ’ は次項キーハンドラのサンプルスクリプトなどで IPTC 情報にタグを書き込んだ場合のもので、その表示には identify (ImageMagick) が必要である。

sxiv はキーイベントのハンドラを ~/.config/sxiv/exec/key-handler に置くことで、キーコマンドを定義できる。デフォルトのキーイベントは C-x だ。 Emacs みたいに C-x をプレフィクスキーとするキーバインディングが可能だ。

これも sxiv/key-handler (GitHub) にサンプルがあり、機能は以下の通り。

このスクリプトでの画像回転機能は、画像を回転してファイルを書き換えるものである。

また、タグ作成機能は画像ファイルにメタデータ（IPTC）として書き込むものである。これに必要な iptckwed というコマンドは IPTC keyword editor のこと。 AUR – iptckwed-git にも登録がある。書き込まれたタグは ‘メタデータ表示’ で表示できるが、前項のステータスバーのサンプルスクリプトでも表示されるようになる。

なお、これらのコマンドは全てマーク機能と組み合わせて使えるように配慮されている。例えば複数の画像にマークしてファイル名をコピーすると、スペース区切りのファイル名リストをコピーバッファに取り込む。画像回転も複数のファイルでいっぺんに行える（サムネールモードを使うとわかりやすい）し、Gimpも複数のファイルを開ける（開き過ぎに注意）し、タグもまとめてつけたり消したりできる。

TMSU の使い方は 公式ページ に書かれてあるものがわかりやすい。

TMSU のコマンドはサブコマンドとオプションを組みわせるタイプだ。ここでは簡単な例を示すが、さらなるオプションの組み合わせで色々とできる。詳しくは help や man を参照されたし。 tmsu help <sub_command> でサブコマンドごとに表示されるヘルプが、わかりやすい。

## タグをつける:  tmsu tag <file> <tag> ...
tmsu tag ~/Wallpapers/mt_fuji.jpg landscape
tmsu tag frog.jpg nature animal

## タグをはずす:  tmsu untag <file> <tag> ...
tmsu untag ~/Wallpapers/mt_fuji.jpg landscape
tmsu untag frog.jpg animal

## タグ一覧:  tmsu tags [ <file> ... ]
tmsu tags
tmsu tags ~/Wallpapers/mt_fuji.jpg
tmsu tags ~/Pictures/*

## タグづけしたファイルの一覧: tmsu files [ <tag> ... ]
tmsu files
tmsu files nature animal
tmsu files landscape or nature

## タグ削除: tmsu delete <tag> ...
tmsu delete landscape

## タグのリネーム:  tmsu rename <old> <new>
tmsu rename mountain mountains

まず、 TMSU のタグがステータスに表示されるよう、image-info を以下のように調整する。

#!/bin/bash
# ~/.config/sxiv/exec/image-info

s="  " # field separator

exec 2>/dev/null

filename=$(basename -- "$1")
filesize=$(du -Hh -- "$1" | cut -f 1)
geometry="${2}x${3}"
tmsu_tags=$(tmsu tags -1 "$1" | sed -e '1d' -e 's/\(^.*$\)/\[\1\]/')

echo "${filesize}${s}${geometry}${tmsu_tags:+$s}${tmsu_tags}${s}${filename}"

タグを [ ] で括って表示するようにしてみた。

キーハンドラに以下のスクリプトを書いて、 C-x t でタグづけ、 C-x T でタグ削除できるようにする。ともにサムネールモードではマーク機能を使って複数ファイルに対して行える。

#!/bin/bash
# ~/.config/sxiv/exec/key-handler

readonly KEY="$1";
readonly TMPFILE="/tmp/sxiv.$$"

tmsu_add_tag() {
  if tag="$(tmsu tags | dmenu -i -p "add tag>")"; then
    tr '\n' '\0' | xargs -0 tmsu tag --tags "\"$tag\""
  fi
}

tmsu_remove_tag() {
  cat >"$TMPFILE"
  if tag="$(tr '\n' '\0' <"$TMPFILE" | xargs -0 tmsu tags -1 | sed -e '/:$/d' -e '/^$/d' | sort | uniq | dmenu -i -p "rm tag>")"; then
    tr '\n' '\0' <"$TMPFILE" | xargs -0 tmsu untag --tags "\"$tag\""
  fi
}

case "$KEY" in
  "t") tmsu_add_tag ;;
  "T") tmsu_remove_tag ;;
esac

上記は前述のサンプル sxiv/key-handler (GitHub) を参考にしている。

既に壁紙のところで記したが、キーハンドラはプリフィクスに続くキーコンボを $1 で受け取り、標準入力にて改行区切りのファイルリストを受け取る。このような場合、受け取るリストは while read でまわしながら読めばトラブルが少ないと考えるが、ここでは xargs で同じ様な効果を得ている。特にヌル文字区切りで渡すところがポイントで、スペースを含むファイル名をうまく扱うためである。

xargs はデフォルトで \s を区切り文字とみなすが、正規表現の \s はいわゆる空白文字であり、スペースやタブ、改行などといったものを示す。だからファイル名にスペースが含まれていればそれも区切りとして捉えてしまう。そこであらかじめ区切り文字をヌル文字だけにしてから xargs に渡すのである。上記スクリプトを例に採れば、 tr で改行を '\0' にして xargs -0 で受け取るとスペースが含まれるファイル名も正常に受け取れるということだ。ちなみに find コマンドでは -print0 オプションでヌル文字区切りの結果を出力してくれる。