xmascot.0

XMASCOT(1)					       XMASCOT(1)


NNAAMMEE
       XMascot - A Pretty Mascot on X Window System

SSYYNNOOPPSSIISS
       xxmmaassccoott [filename] [-_t_o_o_l_k_i_t_o_p_t_i_o_n ...] [-_o_p_t_i_o_n ...]

DDEESSCCRRIIPPTTIIOONN
       _X_M_a_s_c_o_t	is  a  program	to show a pretty Mascot on your XX
       WWiinnddooww SSyysstteemm..  XMascot have these features:


       Swing	 Swing on display prettily.

       Stretch	 Chain's length become longer and shorter as  you
		 like.

       Speak	 Speeking  some	 sounds(needs  sound's	file  and
		 playing command)

       Alarm	 It can caused a action on specific time.

       BIFF	 It can work as BIFF (mail checker)


OOPPEERRAATTIIOONN
       Basic Operations are...

       on PIN window:	   Left button Drag: Move position.

			   Right button Click: Popup menu.

       on Mascot window:   Left Button Click:  accelerate  mascot
			   moving.

			   Left	  button   Drag:  Change  chain's
			   length.

			   Right button Click: Clicking Sound.

       on Mail arrived maek window:
			   Left Button	Click:	Popup  Mail  list
			   window.


AALLAARRMM SSEETTUUPP
       _X_M_a_s_c_o_t	has various Alarm facility.  These alarms can set
       from Alarm/Chime menu.

       Setup Display:

	---a--- --b-- ----------c----------- --d---
	(*^o^*) 00:00 sound(pipipipi.au)     [TEST]





X Version 11		   10 Aug 1997				1





XMASCOT(1)					       XMASCOT(1)


       a.  Trigger this switch ON(Black) to valid setup.

       b.  Time setup(24hour  display  hour:min	 ).   Only  timer
	   alarm, min:sec format.

       c.  Setting actions.  refer ACTIONS to know detail.

       d.  Alarm test switch.

	   The datas setted by this menu are save to $HOME/.xmas
	   cotrc.


       About alarms:


       DDaaiillyy AAllaarrmm	   Act on constant time on Everyday. Ther
			   are 3.

       TTiimmeerr AAllaarrmm	   Act some times after. Formats: min:sec

       IInntteerrvvaall TTiimmeerr	   Act periodic timer.

       HHoouurr CChhiimmee	   Chime on every hour's 0 min.

       HHaallff--HHoouurr CChhiimmee	   Chime on everu hour's 30 min.

       BBiiffff AAccttiioonn	   Not Alarm. for BIFF action setting.


BBIIFFFF FFEEAATTUURREE
       _X_M_a_s_c_o_t has a feature of BIFF (mail checker)  youbin  com
       mand is supported,

       Normaly,	 XMascot  check your mail spool.  It can setup to
       call extern command to chack mail by option --bbiiffffccmmdd .

       Return Values of extern command:


       1 or negative value:
		 Mail box is empty.

       Zero	 New mail comes.

       2	 no change state.


       when calling extern command, Mail  List	shows  that  com
       mand's standard output.


OOPPTTIIOONNSS
       _X_M_a_s_c_o_t has XX TToooollkkiitt standard options and belows:



X Version 11		   10 Aug 1997				2





XMASCOT(1)					       XMASCOT(1)


       Transparent color is normally setted automatically.


       --vveerrbboossee		   Verbose mode.

       --ggrraavviittyy _n	   Set Gravity. Unit: kg cm/s^2

       --cchhaaiinnlleennggtthh _n	   Set Chain length. Unit: mm

       --ddaammppiinngg _f	   Set	damping	 coefficient. from 0 to 1
			   real value.	0: never damp.	1:  never
			   swing.

       --ddeeggrreeee _n	   Set	starting  degree  (from	 0 to 180
			   degree)

       --mmeennuunnoo _n	   Set starting menu No.

       --nnoo _n		   Set starting Mascot No.

       --mmaaggnniiffyy _f	   Set Mascot's Magnify.

       --ppiinnppaatt _f_i_l_e_n_a_m_e	   Set Pin's graphics pattern.

       --rraannddoomm		   Select Mascoot random when startup.

       --cchhaannggeettiimmee _m_i_n	   Change   mascot    periodic.(UNIT:min)
			   Change random when using with -random.

       --aallllmmeennuu		   ChangeMascot changing effects  to  all
			   menu.

       --cchhaaiinnnnuumm _n	   Set chain's number.

       --ddrraawwttiimmiinngg _n	   Draw pattern once per n times.

       --sseeaarrcchhppaatthh _s_e_a_r_c_h_-_p_a_t_h
			   Set Mascot/Sounds data search path.

       --cchhaaiinnppaatt _f_i_l_e_n_a_m_e  Set chain's graphics pattern.

       --ssoouunnddccmmdd _c_m_d_l_i_n_e   Set	sounds	playing	 command. "%s" is
			   replaced  to	 sound's  filename.   For
			   Exam. "cat %s > /dev/audio"

       --ssoouunnddssttaarrtt _f_i_l_e	   Set stating sound file.

       --ssoouunnddcclliicckk _f_i_l_e	   Set clicking sound file.

       --ssoouunnddeenndd _f_i_l_e	   Set	ending	sound  file.   Set ending
			   sound file.

       --ssoouunnddmmaaiill _f_i_l_e	   Set mail arrived sound file.




X Version 11		   10 Aug 1997				3





XMASCOT(1)					       XMASCOT(1)


       --nnoobbiiffff		   Don't use BIFF feature.   --uuppddaattee  _s_e_c
			   Specifies   the   frequency	to  check
			   mail's arriving.  Unit: sec.	 (default
			   30sec)

       --nnoooonnccee		   Do action on every mail arriving.  (on
			   default, Only a action when first mail
			   comes.)

       --bbiiffffccmmdd _c_m_d	   Set mail checing command.

       --bbiiffffppaatt _f_n_a_m_e	   Set mail coming mark graphics pattern.

       --bbiiffffppooss _s_t_r	   Set which position mail mark	 display.
			   on Mascot's (left,center,right)

       --nnoobbiifffflliissttss	   Don't show arrived mail list.

       --bbiiffffggeeoommeettrryy _g_e_o_m  Set Mail List's geometry.

       --bbiiffffffiilltteerr _c_m_d	   Set Filter command that invoked before
			   disp Mail's List.

       --ppooppddoowwnnttiimmee _s_e_c	   Set	popuping  time	of  Mail's  list.
			   Negative  value:  never  popdown auto
			   matic.

       --nnooyyoouubbiinn	   Don't use YOUBIN command.

       --sseerrvveerr _h_o_s_t	   Set YOUBIN servername.

       --sshhaaddooww _n	   Set shadow width.

       --nnoosshhaaddooww	   Don't disp shadow.


AACCTTIIOONNSS
       _X_M_a_s_c_o_t has meny actions that  are  caused  by  alarm  and
       BIFF.

       This  is from .B X Toolkit 's actions feature.  So actions
       can bind to keyboard and mouse.


       translation name:


       on PIn's window
		      XMascot.translations: #override

       on Mascot's window
		      XMascot.mascot_base.translations: #override





X Version 11		   10 Aug 1997				4





XMASCOT(1)					       XMASCOT(1)


       Ex.:
	XMascot.translations: #override \
	  <Btn2Up>: chg_next() snd_click()\n\
	  Shift<Key>R: chg_random() snd_click()

       On this example,As click on PIN winndow, Mascot changes to
       next mascot on menu and play  starting-sound.   and  input
       Shift-R	caused	Changing  mascot random and play clicking
       sound.

       Please refer Xtoolkit's manual about actions.


       To use actions by Alarm, input actions in  Alarm	 dialogs.
       This setup are saved to $HOME/.xmascotrc .


       Action's List.


       qquuiitt    Terminate program.

       cchhaannggee((_n_u_m))
	       Change mascot to No _n_u_m .

       cchhgg__ffiillee((_f_n_a_m_e_[_,_t_i_t_l_e_]))
	       read file _f_n_a_m_e as Mascot.

       cchhgg__nneexxtt
	       Change mascot to next entry of menu.

       cchhgg__nneexxtt__aallll
	       Change mascot to netxt entry with all menus.

       cchhgg__rraannddoomm
	       Change mascot random.

       cchhgg__rraannddoomm__aallll
	       Change mascot random with all menus.

       ssttaarrtt__mmoovvee
	       Push  mascot  little. Start swinging if mascot was
	       stopping.

       ssoouunndd((_f_n_a_m_e_1_,_._._.))
	       Play sound file continue.

       ssnndd__ssttaarrtt
	       Play starting sound.

       ssnndd__cclliicckk
	       Play clicking sound.

       ssnndd__eenndd Play ending sound.



X Version 11		   10 Aug 1997				5





XMASCOT(1)					       XMASCOT(1)


       ssnndd__mmaaiill
	       Play mail arriving sound.

       ssyysstteemm((_c_m_d_l_i_n_e))
	       Execute extern command.

       cchhgg__ppaarraamm((_p_a_r_a_m_1_,_d_a_t_1_,_._.))
	       Change parameter.

	       grav Gravity

	       dump Damping coefficient.

	       mag  Magnify

	       clen Chain length

       bbeellll((_p_a_r_a_m))
	       Beep Bell. This is XBell and no related	USE_SOUND
	       option  on compiling. _p_a_r_a_m 's range: from -100 to
	       100 refer manual of xset.

       sshhoowwbbiiffff
	       Show arrived mail's list.


RREESSOOUURRCCEESS
       _X_M_a_s_c_o_t can use XX TToooollkkiitt standatrd resource and belows:


       vveerrbboossee ((class VVeerrbboossee))
	       Verbose mode.

       ggrraavviittyy ((class GGrraavviittyy))
	       Set Gravity.

       cchhaaiinnLLeenn ((class CChhaaiinnLLeenn))
	       Set Chain Length.

       ddaammppCCooeeffff ((class DDaammppCCooeeffff))
	       Set damping coefficient.

       ddeeggrreeee ((class DDeeggrreeee))
	       Set starting degree.

       mmaaggnniiffyyBBaassee ((class MMaaggnniiffyyBBaassee))
	       Set magnify for All mascots.

       aaccttiioonn ((class AAccttiioonn))
	       Set default actions.

       sseeaarrcchh ((class SSeeaarrcchh))
	       Set default search-path.




X Version 11		   10 Aug 1997				6





XMASCOT(1)					       XMASCOT(1)


       ppiinnPPaatttteerrnn ((class PPaatttteerrnn))
	       Set Pin's graphics pattern.

       ppccooll00 ((class CCooll00))
	       Set Pin's transparent color.(INDEX)

       pprrggbb00 ((class RRggbb00))
	       Set Pin's transparent color.(RGB)

       cchhaaiinnNNuumm ((class CChhaaiinnNNuumm))
	       Set chain's number.

       cchhaaiinnPPaatttteerrnn ((class PPaatttteerrnn))
	       Set chain's graphics pattern.

       ccccooll00 ((class CCooll00))
	       Set chain's transparent color.(INDEX)

       ccrrggbb00 ((class RRggbb00))
	       Set chain's transparent color.(RGB)

       rraannddoomm ((class RRaannddoomm))
	       Change mascot random.

       cchhaannggeeTTiimmee ((class IInntteerrvvaall))
	       Set a interval to change mascot.

       aallllMMeennuu ((class AAllllMMeennuu))
	       Mascot changing effects to all menu.

       mmaassccoottNNoo ((class MMaassccoottNNoo))
	       Set startup mascot No.

       mmeennuuNNoo ((class MMeennuuNNoo))
	       Set startup menu No.

       sshhaaddooww ((class SShhaaddooww))
	       Set shadow's width.  0 means no shadow.


       Biff RESOURCES


       bbiiffff ((class BBiiffff))
	       biff feature ON/OFF

       bbiiffffOOnnccee ((class BBiiffffOOnnccee))
	       biff actions only Mail first comes.

       uuppddaattee ((class  XXttCCIInntteerrvvaall))
	       Specifies the frequency to check mail's	arriving.

       bbiiffffCCmmdd ((class BBiiffffCCmmdd))
	       Set a command to check mail comes.



X Version 11		   10 Aug 1997				7





XMASCOT(1)					       XMASCOT(1)


       bbiiffffAAccttiioonn ((class BBiiffffAAccttiioonn))
	       Set default biff actions.

       bbiiffffPPaatttteerrnn ((class PPaatttteerrnn))
	       Set graphics pattern of Mail coming mark.

       bbccooll00 ((class CCooll00))
	       Set transparent color of biff mark.(INDEX)

       bbrrggbb00 ((class RRggbb00))
	       Set transparent color of biff mark.(RGB)

       bbiiffffFFiilltteerr ((class BBiiffffFFiilltteerr))
	       Set fillter command for Coming mail's list.

       bbiiffffPPooppddoowwnn ((class  XXttCCIInntteerrvvaall))
	       Set  auto-popdown  time of Mail's list.	(Negative
	       Value:Don't popdown automatic. 0:Never Popup)

       yyoouubbiinn ((class  YYoouubbiinn))
	       Set if use YOUBIN command or not.

       sseerrvveerr ((class  SSeerrvveerr))
	       Set YOUBIN servername


       SOUNDs RESOURCES


       ssoouunnddCCoommmmaanndd ((class SSoouunnddCCoommmmaanndd))
	       Set SOUND's play command.


       Menu's RESOURCES

       Menu's resource start after mmeennuu??..mmaassDDaatt??......  Fill ?, Menu
       NUMBER and Mascot NUMBER.


       like this: menu0.masDat0.title: My Mascot


       mmeennuussNNuumm ((class MMeennuussNNuumm))
	       Set menu set's number.

       nnuummssOOffMMeennuu ((class NNuummssOOffMMeennuu))
	       Set Mascot No on a menu.

       mmaassDDaatt??..ttiittllee ((class TTiittllee))
	       Set Mascot's name.

       mmaassDDaatt??..ffiilleennaammee ((class PPaatttteerrnnee))
	       Set Mascot pattern's filename.




X Version 11		   10 Aug 1997				8





XMASCOT(1)					       XMASCOT(1)


       mmaassDDaatt??..ccooll00 ((class CCooll00))
	       Set Mascot's transparent color.(INDEX)

       mmaassDDaatt??..rrggbb00 ((class RRggbb00))
	       Set Mascot's transparent color.(RGB)

       mmaassDDaatt??..mmaaggnniiffyy ((class MMaaggnniiffyy))
	       Set Mascot's magnify.

       mmaassDDaatt??..ssttaarrttSSnndd ((class SSttaarrttSSnndd))
	       Set Mascot's starting sound.

       mmaassDDaatt??..cclliicckkSSnndd ((class CClliicckkSSnndd))
	       Set Mascot's clicking sound.

       mmaassDDaatt??..eennddSSnndd ((class EEnnddSSnndd))
	       Set Mascot's ending sound.

       mmaassDDaatt??..mmaaiillSSnndd ((class MMaaiillSSnndd))
	       Set Mascot's mail arriving sound.

       mmaassDDaatt??..bbiiffffPPooss ((class BBiiffffPPooss))
	       Set Mail mark's position.


FFIILLEESS
       $HOME/.xmascotrc	   Save alarm time etc.


BBUUGGSS
       Parameter's range isn't checked.


AAUUTTHHOORRSS
       Go  Watanabe(Toyohashi  Univ. of Tech. Computer Club) Main
       Programmer

       Tsuyoshi Iida(TUT Computer  Club)  Graphics  Loader  Unit,
       etc.

       Yasuhito Makino(TUT Computer Club) Mascot design.

       HomePage http://cclub.tutcc.tut.ac.jp/xmascot/














X Version 11		   10 Aug 1997				9