aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKylie McClain <kylie@somas.is>2021-06-05 19:01:58 -0400
committerKylie McClain <kylie@somas.is>2021-06-28 14:20:19 -0400
commit2bd84ebe27f81620472c0a4280d31766cb95ba64 (patch)
treefc1653c6db45726ea6a7cb623698c61633a13240
parentdb37520e3cb56819391f0653a46dff7acc0a4744 (diff)
downloadxmascot-2bd84ebe27f81620472c0a4280d31766cb95ba64.tar.gz
xmascot-2bd84ebe27f81620472c0a4280d31766cb95ba64.tar.xz
xmascot-2bd84ebe27f81620472c0a4280d31766cb95ba64.zip
New readme featuring translations from Japanese README
-rw-r--r--README.adoc297
-rw-r--r--README.orig (renamed from README)0
2 files changed, 297 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..267c1e5
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,297 @@
+= XMascot version 2.6
+
+[literal]
+....
+TUT Computer Club "Project XMascot"
+Copyright(c) 1996,1997 Go Watanabe <go@cclub.tutcc.tut.ac.jp.
+ Tsuyoshi Iida <iida@cclub.tutcc.tut.ac.jp>
+All Rights Reserved.
+....
+
+== Introduction
+
+[quote]
+____
+「おお、えんでぃんぐだ... いやーおもろかった。つぎはだれにしやう...
+ ぬ、なにか“ますこっと”ってのがあるぞ...
+ おぉ ゆれている、 おぉ のびるのびる、つつくとしゃべるし。
+ ぬぬぬ、これって えっくす でほしいよなぁ。」
+____
+
+== What is XMascot?
+
+XMascot is a program that displays a cute mascot on the X Window System display.
+
+It has the following functions:
+
+* It sways back and forth on the screen in a pretty way.
+
+* The chain length can be made shorter or longer according to your preference.
+
+When running, you can also configure it dynamically:
+
+* Switch between multiple mascots depending on your mood;
+ you can also create additional mascot selection menus.
+
+* Set the gravity and damping coefficient;
+ Xmascot emulates the motion of a pendulum faithfully.
+
+=== Image formats
+
+The following image formats are supported as mascot data:
+
+* GIF (*.gif): up to 256 colors, transparent/interlace supported
+* BMP (*.bmp): all formats (however, Xmascot currently malfunctions with 8bpp for 256 colors or more)
+* MAG (*.mag): 16 colors or 256 colors
+
+Not supported in 2.6 (as in, not processed by imagelib):
+
+* TIFF (*.tif): 16 or 256 colors, in RAW or LZW compressed format
+
+These work with true color:
+* PPM (*.ppm): 256 color shades in raw format
+* PGM (*.pgm): 256 grayscale raw format
+* PBM (*.pbm): binary monochrome raw format
+* FIXME * PNM (*.pnm): any of PPM, PGM, PBM
+
+The image format is determined by the file data, not the extension.
+
+FIXME この機能は 2.6 alpha では TrueColor 以外で動作しない。(imagelib の不備による)
+
+If any commands with the extensions *topnm, *toppm, *topgm, *topbm exist, they'll be called and
+loaded on unfamiliar files. (for example: attempting to load `aaa.gif` will call `giftopnm` or
+`giftoppm`)
+
+FIXME 透明色は自動的に判定されます。
+
+=== Mascots
+
+This version comes bundled with mascots.
+
+TODO add list of mascots with explanations
+
+
+ です。適宜御利用下さい。
+
+ contrib 以下に怪しいおまけソフトが入っています。
+ これらについてはそれぞれの README を参照して下さい。
+
+== Installation
+
+To compile XMascot, you'll need a C toolchain, complete with the standard math library, `libm`.
+
+Additionally, you'll need:
+* libICE
+* libSM
+* libX11
+* libXau
+* libXext
+* libXmu
+* libXpm
+* libXt
+* libXaw
+ ** libXaw3d is also supported;
+ put `-DUSE_XAW3D` in your `$CFLAGS` and `-lXaw3d` in your `LDLIBS` when building Xmascot.
+
+Building and installation is uncomplicated:
+
+1. `make`.
+2. `make install`.
+
+Standard variables like `DESTDIR`, `prefix`, `datadir`, `mandir`, etc. are supported.
+Change `xmascotdir` if you wish to install the mascot images in a different location.
+
+This edition has been updated some to compile on new machines cleanly, free of 90s-era legacy
+code. Patches for portability are welcome.
+
+== Usage
+
+See xmascot(1).
+
+== Changes in this version
+
+All customization from the original XMascot 2.6 has been removed since it seemed unnecessary,
+consisting of minor things that reduced dependencies; this seems like it was necessary when
+it was written, but no longer necessary these days.
+
+== About this repository
+
+There's some questionable software under `contrib`.
+
+FIXME ****** Notice ******
+FIXME XMascot は非常にマシンに対する負荷が高く、Pentiumクラス以上でないと、
+FIXME 快適な動作は期待できません。
+FIXME
+ XMascot の最新版、および関連物は
+
+ http://cclub.tutcc.tut.ac.jp/xmascot/
+ ftp://cclub.tutcc.tut.ac.jp/pub/xmascot/
+
+ で公開されています。
+
+2.インストール方法
+
+ コンパイルには、gcc 等 ansi 式の記述に対応したコンパイラが必要です。
+
+ (a) config.tmpl の変更
+
+ XMASDIR
+
+ 標準のマスコットデータが格納されるディレクトリを設定します。
+ ここに付属のマスコットや音声が格納されます。また、このディレクトリは
+ 標準でサーチパスの最後に追加されます。
+ デフォルトは $(LIBDIR)/xmascot です。
+
+ 以下に示す項目を環境、要望にあわせて適宜 #define/#undef して下さい
+
+ PERSONAL 個人のホームディレクトリにインストールします。
+
+ PERSONAL を define すると、XMASCOT を個人のホームディレクトリに
+ インストールします。
+ $HOME/bin/xmascot, $HOME/xmascot/* $HOME/XMascot
+ ($HOME/$LANG/XMascot USE_I18Nの場合) としてインストールされます。
+ $HOME/bin にパスを切って使用して下さい。
+
+ NEED_DIFFTIME difftime(3)が無い時に指定します。(SunOS4.1.Xなど)
+
+ USE_BIFF メールの着信お知らせ機能を使用します
+
+ これを利用する場合は、自分の環境のディレクトリ構成に
+ 合わせて、MAILBOX_DIR が正しくメールのスプールを指すように
+ 設定して下さい。XMascot が想定するメールボックスは
+ MAILBOX_DIR/ユーザ名 です。
+
+ POPなどを利用している場合には、リソース *biffCmd: 、または
+ 起動時オプション -biffcmd にメールのチェック用のコマンドを
+ 指定して下さい。(mh の msgchk など)
+
+ コマンドの返り値が 0:メールがある、1:ない、それ以外:状態変わらず
+ と判定します。
+
+ USE_BIFFLIST 着信お知らせ一覧を使います
+
+ これを #undef すると、着信お知らせ From: Subject: 一覧の
+ 機能がなくなります。
+
+ USE_YOUBIN youbin 対応
+
+ youbin コマンドを利用して youbin protocol でメールの確認
+ を行ないます。path の通った場所に youbin コマンドが必要です。
+
+ USE_SOUND 音声を使用します
+
+ USE_SOUND を define すると、音声再生機能を組み込みます。
+ XMascot の音声機能は、外部コマンドを呼び出す他力本願です。
+ 何らかの音声再生コマンドを準備して、その呼びだしコマンドを、
+ SOUND_COMMAND に設定して下さい。%s に音声のファイル名が入ります。
+
+ デフォルトは、SunOS や NetBSD で使用できる、cat %s > /dev/audio
+ になっています。
+
+ USE_I18N 国際化対応版にします
+
+ USE_I18N を define すると、国際化対応版としてコンパイルします。
+ 国際化は X11R6 の Athene-widget によるものです。
+ デフォルトで準備された設定ファイルは、日本語 euc になっています。
+ 使用しているコードが異なる場合は、japanese/XMascot.ad.sed のコードを
+ nkf などで変換してください。
+
+ DUMMY_SETLOCALE
+
+ OS の setlocale が日本語の locale をサポートしておらず、また X が
+ -DX_LOCALE をつけずにコンパイルしてあって、国際化機能が利用できない
+ 場合に、むりやり国際化機能を有効にしたいときに指定します。
+
+ USE_DOUBLE 倍精度演算
+
+ 位置計算回りを double を使用します。揺れがとまりそうなときに、
+ 「カクッ」と動くことがなくなります。あと、とまったと見せかけて実は
+ 整数演算の誤差のため揺れ続けているということもなくなるはずです。(たぶん)
+ 数値演算プロセッサ(みんなあるよね^^)のある場合はこっちのがたぶん幸せです。
+
+ USE_CHAINPAT 鎖に絵をはる
+
+ 鎖に絵を貼れるようにします。
+
+ USE_SHADOW 影をつける
+
+ マスコットに影をつけます。
+
+ USE_XAW3D
+
+ Xaw3D や Xaw95 を使用する際に指定します。
+
+ (b)コンパイル/インストール
+
+ % xmkmf -a
+ % make
+ % su
+ # make install
+
+ でインストールが完了します。
+
+ (c) 動作確認
+
+ 以下の組合せでの動作を確認しています。
+
+ GATEWAY2000 Pentium 120 OpenBSD 1.2/i386 gcc 2.7.2 XFree86 3.3
+ DEC 3000 Alpha ? DEC OSF/1 V3.0 gcc 2.6.0 X11R5
+ SparcStation IPC Sparc ? SunOS 4.1.3 gcc 2.7.2 X11R6
+ HP 9000/715 ? HP-UX A.09.07 gcc 2.7.2 X11R6
+
+3.起動方法
+
+ XMascot の起動方法は次の通りです。
+
+ xmascot [option] [filename]
+
+ ファイル名を指定した場合、そのファイルをマスコットとして
+ 読み込み表示します。ファイルはサポートされている形式の画像データです。
+ このマスコットは切替えメニュー0番の一番最後に登録されます。
+ ファイル名を指定しない場合は、メニューに登録されたマスコットで起動します。
+
+4.起動時オプション
+
+ -geometry, fg, bg などの 通常のXToolkit のオプションに加えて、
+ 以下のような起動時オプションがあります。
+
+ ★透明色指定オプション Ver2.6 からは削除しました。どうしても
+ 指定したい場合はリソースを利用して下さい。
+
+ -verbose デバッグ用の冗長表示モード
+ -gravity n 重力加速度の指定 単位は cm/sec^2 です。
+ -chainlength n 鎖の長さを指定します。単位は mm
+ -damping n 減衰係数を指定します。0 で揺れが止まらなくなります。
+ -degree n 振り始めの角度を指定します。
+ -menuno n 起動時のメニューの番号を指定します。
+ -no n 起動時のマスコットの番号を指定します。
+ -magnify n マスコットの画像の拡大率を指定します。
+ -pinpat fname ピンの部分の画像を変更します。
+ -random 起動時のマスコットをランダムに指定します。
+ -changetime min 一定時間ごとにマスコットを切替えます。
+ 通常は、1つのメニューセットの中で次々かわります。
+ -random 併用時は random に切替わります。
+ -allmenu 上記の切替えが全メニューに及びます
+ -searchpath マスコットおよび音声データのサーチパスを指定します。
+ パスは : で区切ります。
+ -chainnum 鎖の個数を指定します。
+ -drawtiming n 描画をコマ落ちさせます。n 回に一回の描画になります。
+
+USE_CHAINPAT 指定時のみ有効
+
+ -chainpat fname 鎖の部分の画像を変更します。
+
+USE_SOUND 指定時のみ有効
+
+ -soundcmd 音声再生用のコマンドを指定します。
+ -soundstart 起動時の音声ファイルを指定します。
+ -soundclick クリック時の音声ファイルを指定します。
+ -soundend 終了時の音声ファイルを指定します。
+ -soundmail メール着信時の音声ファイルを指定します。
+ *これは USE_BIFF も必要
+
+USE_BIFF 指定時のみ有効
+
+ -nobiff BIFF 機能を無効にします。
+ -update sec 到着調査の時間間隔を秒単位で指定します。(デフォルト30秒)
+ -noonce
diff --git a/README b/README.orig
index 6b20fd8..6b20fd8 100644
--- a/README
+++ b/README.orig