[JM:02851] manページ翻訳時の留意事項

Back to archive index
matsuand michi****@gmail*****
2021年 8月 12日 (木) 20:33:25 JST


matsuand です。
man ページ翻訳時の留意事項として、
備忘録的に示しておくことにします。

man ページを翻訳してこられた方には、
熟知されているところかもしれません。

まず、直近で nginx なるパッケージに関しての
man 翻訳校正依頼をあげました。この中で
根本的(致命的)な誤りを見つけました。
以下の箇所です。

[原文]
.It Pa /usr/logs/nginx.pid
Contains the process ID of .Nm . The contents of this file
are not sensitive, so it can be world-readable.
[訳文]
.It Pa /usr/logs/nginx.pid
.Nm のプロセス ID を保持します。
このファイルの内容は機密情報ではないため、
だれでも見ることができます (world-readable です)。

誤りがお分かりになるでしょうか?

"/usr/logs/nginx.pid" なるパスです。これは FHS 的に
言って、ありえないディレクトリです。なぜこうなったのか。
私のオリジナル man ページの準備ミスです。

一般的に言って、オリジナル man ページは、当該
パッケージの tarball に、出来合いのものが用意されて
いる場合もありますし、コンパイル処理を通じて動的に
生成される場合もあります。さらに後者の場合、その
manページ内に、各種のパス表現が含まれていて、
そのパスは、ソースビルドした際のローカルディレクトリを
そのまま含めるケースがあります。詳述省略。

当 nginx の場合、man ページは動的に生成しなければ
ならず、私は以下のようにして configure および make
を行って、man ページを得ていました。

./configure --prefix=/usr \
        --conf-path=/etc/nginx/nginx.conf \
        --error-log-path=/var/log/error.log
make -f objs/Makefile objs/nginx.8

configure にたくさんパラメーター指定を行っていますが、
じっくりと man ページ翻訳に取り掛かっていると、
この configure 指定が必要になることが分かってきます。
なぜなら、上で登場する prefix, conf-path,
error-log-path は、いずれも man ページ内に
%%PREFIX%%,
%%CONF_PATH%%,
%%ERROR_LOG_PATH%%
という記述が存在していて、これがコンパイルを通じて
動的に書き換わるようになっています。
そこで「FHS的」に標準的なパスを指定する必要
が出てきます。
このような man ページは他にもよくあります。

私はその際に、%%PID_PATH%% なる
ものが存在していたことを見落としていました。
それが "/usr/logs/nginx.pid" という、ありえない
パスが含まれてしまった原因です。

configure 処理は、
改めて以下のようにしなければなりません。
./configure --prefix=/usr \
        --conf-path=/etc/nginx/nginx.conf \
        --error-log-path=/var/log/error.log \
        --pid-path=/var/run/nginx.pid

この説明内容、お分かりいただけるでしょうか?

man ページ翻訳者は、翻訳対象とするオリジナル
man ページを特定する際に、このようなことに
気を配る必要がある、という話です。
不明であれば、当MLにて相談をあげるなどの
対処が必要になるかと思います。


linuxjm-discuss メーリングリストの案内
Back to archive index