$Id: README,v 1.1 1991/11/01 07:59:41 proj Exp $

This is multilingual version of xman, modified from the original X11R5 MIT's
xman(version: 1.21 91/09/03). If you want to restore the original xman, just
take out the compile directive -DXI18N from Imakefile/Makefile, or go to the
origin source directory mit/clients/xman.

Besides holding all same facilities as the original xman, the i18n xman can
show the manual page written in various languages, such Japanese, Chinese,
Korean and so on.  The usage of i18n xman is same as the original xman.

Before running this xman, please make sure your roff commands can handle
the manual written in your local language.  For example, you want to use
xman to browse the manual in Japanese,  you should check whether the roff
commands can process the manual correctly or not. If the roff cann't, you
should choose another commands, say jtbl/jneqn/jnroff, then specify them in
the command options or resouces files(See Differentiation 3.).  

A. Directory Structure

   This directory contains the source of i18n xman, Imakefile, .c, .h,
   resource files .ad, and manual xman.man.  Othere source files not
   existing here are denotated from xman of MIT core distribusion.
   they are not necessary to be changed.  So far we provide only the
   following resource files in several encodings(languages).  You can
   edit them to an encoding(language) supported at your platform site.

	Xman.ad			in Latin-1 encoding(English)
	Xman-ujis.ad		in UJIS encoding(Japanese)
	Xman-mscode.ad		in MS-code(SJIS) encoding(Japanese)
	Xman-ugb.ad		in UGB encoding(Chinese in mainland)
	Xman-big5.ad		in BIG-5 encoding(Chinese in H.K., Taiwan)
	Xman-ct.ad		in CT encoding(Multilingual), if you want
				to get it, please copy Xman.ad to it.

B. Differentiation from MIT's xman

1.  Widgets

    The widgets involving with strings is changed to multilingual widgets
    in the i18n version Xaw which resides in X11R5 contribution directory
    contrib/lib/Xaw, and can be ftp'ed from MIT.
    These widgets are:
                             changed to
                             ==========
        commandWidgetClass      -->     commandLocaleWidgetClass
        dialogWidgetClass       -->     dialogLocaleWidgetClass
        labelWidgetClass        -->     labelLocaleWidgetClass
        listWidgetClass         -->     listLocaleWidgetClass
        menuButtonWidgetClass   -->     menuButtonLocaleWidgetClass
        smeBSBObjectClass       -->     smeBSBLocaleObjectClass


2.  Font Set

    The font is changed to fontSet used in the manual browser. All fonts
    are allowed to free size as well as you like.

    The 3 styles of fonts, normal, bold and italic are used often in English
    manual, however some eastern languages such Japanese and Chinese have no
    italic style.  So when you browse the manual written in mixed of English
    and other language, say Japanese, it is strongly recommended that you
    should choose apporopriate fonts whose sizes are consistent in the English
    and Kanji characters, for example, choosing Latin-1 font with CharCell
    spacing for English as can as possible.  Otherwise the vertical line on
    the manual page would not be looks nice, specially in the case of Latin-1
    font with proportional spacing(variable pitch). For example the widths of
    blank " " and the letter "M" are different, they cause some indents are
    different.
    

3.  New Command Options

    The roff commands, used internally in program before, now are opened to
    user who can switch xman into his favourite commands with the options

	-tbl	for tbl command, default is tbl.
	-eqn	for eqn command, default is eqn.
	-roff	for roff command, default is nroff.

    Their corresponding resources are:

	commandTbl(class CommandTbl)
	commandEqn(class CommandEqn)
	commandRoff(class CommandRoff)

4.  Tab Stop

    The tab, defined in the original xman, is concerned with the column.
    However the column is not clear in multilingual codeset, so the tap
    stop is defined as:

          0w       8w      16w      24w...

    where the w is the bitmap width of a base character in the first font,
    which is choosed internally by xman, one example is the character "$"
    in Latin-1 font.

5.  Environment Variable

    XNLSPATH	specifies the full path of locale database, the default
		is "/usr/lib/X11/nls".

    LANG	specifies the language name, e.g.,

			% setenv LANG ja_JP.ujis

    		tells xman to be run in Japanese UJIS encoding.
		The default is "C" in English.

6.  Compile

    Run the following commands to compile xman.

	% xmkmf <TopDir> [<CurDir>] (set your top dir, default of CurDir is .)
	% make includes
	% make



Enjoy it.



						Li Yuhong
						Oct. 9, 1991
