aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKylie McClain <kylie@somas.is>2021-06-04 01:12:17 -0400
committerKylie McClain <kylie@somas.is>2021-06-05 19:38:06 -0400
commitdb37520e3cb56819391f0653a46dff7acc0a4744 (patch)
tree2751a126d99c8f872b334d780cd2a4d50b6a3a9a
parentc4fa8ca1c52282aa0a34fd6153f57ff7bb50177a (diff)
downloadxmascot-db37520e3cb56819391f0653a46dff7acc0a4744.tar.gz
xmascot-db37520e3cb56819391f0653a46dff7acc0a4744.tar.xz
xmascot-db37520e3cb56819391f0653a46dff7acc0a4744.zip
WIP Convert manpages to mdoc
-rw-r--r--xmascot.1 (renamed from xmascot.man)260
-rw-r--r--xmascot.1.jp (renamed from xmascot.jman)0
2 files changed, 146 insertions, 114 deletions
diff --git a/xmascot.man b/xmascot.1
index 87dfd71..3660000 100644
--- a/xmascot.man
+++ b/xmascot.1
@@ -1,115 +1,147 @@
-.TH XMASCOT 1 "10 Aug 1997" "X Version 11"
-.SH NAME
-XMascot \- A Pretty Mascot on X Window System
-.SH SYNOPSIS
-.B xmascot
-[filename] [-\fItoolkitoption\fP ...] [-\fIoption\fP ...]
-.SH DESCRIPTION
-.I XMascot
-is a program to show a pretty Mascot on your
-.B X Window System.
-XMascot have these features:
-
-.TP 10
-Swing
-Swing on display prettily.
-.TP 10
-Stretch
-Chain's length become longer and shorter as you like.
-.TP 10
-Alarm
-It can caused a action on specific time.
-
-.SH OPERATION
-Basic Operations are...
-.TP 20
-on PIN window:
-Left button Drag: Move position.
-
-Right button Click: Popup menu.
-.TP 20
-on Mascot window:
-Left Button Click: accelerate mascot moving.
-
-Left button Drag: Change chain's length.
-
-.SH OPTIONS
-.I XMascot
-has
-.B X Toolkit
-standard options and belows:
-
-.PP
-Transparent color is normally setted automatically.
-
-.TP 20
-.BI \-verbose
+.Dd June 05, 2021
+.Dt XMASCOT 1
+.Os X Version 11
+.
+.Sh NAME
+.Nm xmascot
+.Nd display a cute mascot on your X window system
+.
+.Sh SYNOPSIS
+.Nm xmascot
+.Op Fl toolkitoption...
+.Op Fl option...
+.
+.Sh DESCRIPTION
+.Nm XMascot
+displays a cute mascot on your X window system display.
+.
+.Bl -bullet
+.It
+It sways back and forth on the screen in a pretty way.
+.It
+The chain length can be made shorter or longer according to your
+preference.
+.El
+.
+.Pp
+.Nm Ap s
+settings can be changed while running using the mouse:
+.Pp
+Interacting with the pin:
+.Bl -bullet
+.It
+Left button drag: move the pin, chain, and mascot around.
+.
+.It
+Right button click: show a menu where you can select mascots and change
+.Nm Ap s
+chain movement physics.
+.El
+.
+.Pp
+Interacting with the mascot:
+.Bl -bullet
+.It
+Left button click: accelerate the mascot.
+.
+.It
+Left button drag: change the chain's length.
+.
+.El
+.
+.Pp
+The options are as follows:
+.
+.Bl -tag
+.It Fl Ar toolkitoption...
+Any of the options provided by libXt, the X Toolkit Intrinsics library.
+For a list of these options, see the
+.Sy OPTIONS
+section in
+.Xr X 7 .
+.
+.It Fl verbose
Verbose mode.
-.TP 20
-.BI \-gravity " n"
-Set Gravity. Unit: kg cm/s^2
-.TP 20
-.BI \-chainlength " n"
-Set Chain length. Unit: mm
-.TP 20
-.BI \-damping " f"
-Set damping coefficient. from 0 to 1 real value.
-0: never damp. 1: never swing.
-.TP 20
-.BI \-degree " n"
-Set starting degree (from 0 to 180 degree)
-.TP 20
-.BI \-menuno " n"
-Set starting menu No.
-.TP 20
-.BI \-no " n"
-Set starting Mascot No.
-.TP 20
-.BI \-magnify " f"
-Set Mascot's Magnify.
-.TP 20
-.BI \-pinpat " filename"
-Set Pin's graphics pattern.
-.TP 20
-.BI \-random
-Select Mascoot random when startup.
-.TP 20
-.BI \-changetime " min"
-Change mascot periodic.(UNIT:min)
-Change random when using with -random.
-.TP 20
-.BI \-allmenu
-ChangeMascot changing effects to all menu.
-.TP 20
-.BI \-chainnum " n"
-Set chain's number.
-.TP 20
-.BI \-drawtiming " n"
-Draw pattern once per n times.
-.TP 20
-.BI \-searchpath " search-path"
-Set Mascot/Sounds data search path.
-.TP 20
-.BI \-chainpat " filename"
-Set chain's graphics pattern.
-.TP 20
-.BI \-shadow " n"
-Set shadow width.
-.TP 20
-.BI \-noshadow
-Don't disp shadow.
-
-.SH ACTIONS
-
-.I XMascot
-has meny actions.
-
-This is from .B X Toolkit 's actions feature.
-So actions can bind to keyboard and mouse.
-
-.PP
-translation name:
-
+.
+.It Fl gravity Ar kg/cm^2
+Set the gravity constant to
+.Ar kg/cm^2
+kilograms per square centimeter.
+.
+.It Fl chainlength Ar mm
+Set the chain length to
+.Ar mm
+millimeters.
+.
+.It Fl damping Ar f
+Set damping coefficient to
+.Ar f ;
+can be any number between 0 and 1
+(0 being to never damp, 1 being to never swing).
+.
+.It Fl degree Ar d
+Set starting degree to
+.Ar d ;
+values can be between 0 and 180 degrees.
+.
+.It Fl menuno Ar n
+Set the starting menu number to
+.Ar n .
+.
+.It Fl no Ar n
+Set starting mascot number to
+.Ar n .
+.
+.It Fl magnify Ar f
+Set mascot's magnification factor to
+.Ar f .
+.
+.It Fl pinpat Ar file
+Set the pin's pattern to
+.Ar file .
+.
+.It Fl random
+Select a random mascot at startup.
+.
+.It Fl changetime Ar min
+Switch to the next mascot every
+.Ar min
+minutes(s).
+Change to a random msacot when using with
+.Fl random .
+.
+.It Fl allmenu
+FIXME Change mascot changing effects to all menu.
+.
+.It Fl chainnum Ar n
+Set the number of rings on the chain to
+.Ar n .
+.
+.It Fl drawtiming Ar n
+FIXME Draw pattern once per n times.
+.
+.It Fl searchpath Ar search-path
+Set mascot search path to
+.Ar search-path .
+.
+.It Fl chainpat Ar file
+Set the chain's graphics pattern.
+.
+.It Fl shadow Ar px
+Set shadow distance.
+.
+.It Fl noshadow
+Don't display a shadow.
+.
+.Ss Actions
+.Nm
+can have actions assigned to keyboard and mouse input;
+this is implemented by libXt, the X Toolkit Intrinsics library.
+.
+.Pp
+Translation name:
+TODO
+.
.TP 15
on PIn's window
XMascot.translations: #override
@@ -188,7 +220,7 @@ Beep Bell. This is XBell and no related USE_SOUND option
on compiling. \fIparam\fP 's range: from -100 to 100
refer manual of xset.
-.SH RESOURCES
+.Sh RESOURCES
.I XMascot
can use
.B X Toolkit
@@ -293,10 +325,10 @@ Set Mascot's transparent color.(RGB)
Set Mascot's magnify.
.TP 8
-.SH BUGS
+.Sh BUGS
Parameter's range isn't checked.
-.SH AUTHORS
+.Sh AUTHORS
.sp
Go Watanabe(Toyohashi Univ. of Tech. Computer Club) Main Programmer
diff --git a/xmascot.jman b/xmascot.1.jp
index 024748a..024748a 100644
--- a/xmascot.jman
+++ b/xmascot.1.jp