home *** CD-ROM | disk | FTP | other *** search
/ ST-Computer Leser 2002 January / STC_CD_01_2002.iso / SYSTEM / XG_0142.TAR / xg / README < prev    next >
Text File  |  2001-09-05  |  11KB  |  273 lines
  1.  
  2.                         \\   /
  3.                          \\ / Version 11 Rel. 6.4
  4.                          / \\
  5.                         /   \\  Server for MiNT/GEM
  6.                       ===============================
  7.                                Sep 05, 2001
  8.  
  9.  
  10. Contents
  11. ========
  12.  
  13.     1. Requirements
  14.     
  15.     2. Installation
  16.        2.1. Preparing Environment
  17.        2.2. Preparing Directories
  18.     
  19.     3. Fonts
  20.        3.1. Handling of GEM-Fonts
  21.        3.2. Font-Aliasing
  22.     
  23.     4. Using The X Server
  24.        4.1. Menu Bar Items
  25.        4.2. Keyboard Input
  26.        4.3. Mouse Actions
  27.  
  28.  
  29. 1. Requirements
  30. ===============
  31.  
  32. To get the server running with a useable speed, a machine with a 68030 and
  33. 10 MByte of Ram is needed at least.  Absolutely vital installed and working
  34. system programs are: FreeMiNT >= 1.15.6, NVDI >= 4.1, N.AES or XaAES or
  35. AES 4.1.
  36.  
  37. If you haven't MiNTnet installed you need a very small package (I call it
  38. 'tiny-sock') from X11.freemint.de installed instead.
  39.     
  40. Screen size (width*height) isn't restricted, but ST-High (640*400) is the
  41. minimum to get it useable.  Nearly all color depths are supported, expect
  42. of 2 planes (4 colors) and 15 bit PC format.
  43.  
  44. The latest binary version can be downloaded from the homepage at
  45.    http://X11.freemint.de ,
  46. there is also a source snapshot.  The very latest sources are accessible
  47. from the FreeMiNT CVS Repository at
  48.    http://wh58-508.st.uni-magdeburg.de/cgi-bin/cvsweb/xg/
  49. Bug reports should be mailed to <AltF4@freemint.de>.
  50.  
  51.  
  52. 2. Installation
  53. ===============
  54.  
  55. Copy the server's files to some location on your filesystem; there is no
  56. requirement of a fixed path for the server.  A usefull place might be
  57. /usr/X11R6/bin/ but everything else works as well.
  58.  
  59. The next step is to make a directory /var/lib/Xapp/ for the server.  If the
  60. server is startet by root at the first time, or the directory is writeable
  61. by the server, it will do the following steps by itself.  Else do the
  62. following (as root user):
  63.     cd /var/lib ; mkdir Xapp ; chmod 777 Xapp
  64.  
  65. 2.1. Preparing Environment
  66. --------------------------
  67.  
  68. There are a few things necessary for X-clients to be able to work.
  69.  
  70. If a client starts, it first parses the environment variable DISPLAY to
  71. find out at which IP number the server should be connected.  So it's
  72. possible to start clients from connected machines, having their X-Windows
  73. opend on your local machine.  The value of DISPLAY has to be of the form
  74. "<server-IP>:0.0".  For clients running at a local machine, DISPLAY
  75. contains simply the value "0:0.0", where the first "0" is simply a shortcut
  76. for the local IP or even "localhost".  For clients started on a remote
  77. machine connected to an Atari with e.g. the IP 123.234.34.56, DISPLAY at
  78. the remote machine must be then "123.234.34.56:0.0".
  79.  
  80. Most comfortable for the user is, to have somewhere in mint.cnf the line
  81.     setenv DISPLAY 0:0.0
  82. so the setting it can't be forgotten.  Otherway it would be necessary to
  83. set it by hand in a shell window and start every client from that shell.
  84.  
  85. 2.2. Preparing Directories
  86. --------------------------
  87.  
  88. The following isn't necessary for the server itself but should be done for
  89. client programs to have a common directory hirachy.
  90.  
  91. First there should be a directory /etc/X11/app-defaults/ which will later
  92. contain default configuration files for several client programs.  These
  93. configuration files are such with the suffix ".ad" in packages and needs to
  94. be renamed without the suffix while copying to the app-defaults e.g.
  95. "Xcalc.ad" to only "Xcalc".  Also the X server will search for optional
  96. configuration fileas at /etc/X11/.
  97.  
  98. Next, a directory /usr/X11R6/ should be created as being the "XTOPDIR" and
  99. a link /usr/X11 pointing to this directory as well, for historical reasons:
  100.    cd /usr ; ln -s X11R6 X11
  101. Furthermore, some clients are looking for their configuration files not at
  102. /etc/X11/app-defaults/, but at /usr/X11R6/lib/X11/app-defaults/ (or at
  103. /usr/X11/lib/X11/app-defaults/, therefor the link) instead, so there should
  104. be placed a link pointing to /etc/X11/app-defaults/:
  105.    cd /usr/X11R6/lib/X11 ; ln -s /etc/X11/app-defaults
  106.  
  107. After carrying out all the previous steps, the system should have these
  108. directories and links:
  109.    /var/lib/Xapp/
  110.    /etc/X11/app-defaults/
  111.    /usr/X11R6/lib/X11/app-defaults -> /etc/X11/app-defaults/
  112.    /usr/X11                        -> X11R6/
  113.  
  114.  
  115. 3. Fonts
  116. ========
  117.  
  118. In X, fonts are named following the XLFD ('X Logical Font Description').
  119. These font names are in fact a set of descriptive fields with '-' as
  120. delimiters.  The format is as following:
  121.  
  122.    -fndry-fmly-wght-slnt-sWd-adStl-pxSz-ptSz-resx-resy-spc-avgWd-rgstry-enc
  123.  
  124. with the field meanings:
  125.  
  126. fndry:     Foundry is the name of the organization that supplied or last
  127.            modified the font, e.g. Adobe, Bitstream.
  128. fmly:      FamilyName of the font, e.g. Courier, Gothic, Helvetica
  129. wght:      WeightName, e.g. Bold, Medim, Black
  130. slnt:      Slant, a code-string with tha encoding: "R"=Roman, "I"=Italic,
  131.            "O"=Oblique, aso.
  132. sWd:       SetWidth, e.g. Normal, Condensed, Narrow
  133. adStl:     AddStyle, e.g. Sans, Serif,
  134. pxSz:      PixelSize of the body of the font, similar to the character cell
  135.            in VDI
  136. ptSz:      PointSize in decipoint, that is 1/10th point
  137. resx,resy:   horizontal/vertical resolution for which the font was designed
  138. spc:       Spacing, code-string to indicate the escapement, that is "P" for
  139.            proportional and "M" or "C" for monospaced
  140. avgWd:     AverageWidth of all characters in 1/20th pixels
  141. rgstry,enc:   CharsetRegistry/Encoding, e.g. ISO8859-1
  142.  
  143. All of these fields my contain wildcards (a '*').  For example, often
  144. clients requests a font named '-*-*-*-*-*-*-*-120-*-*-*-*-ISO8859-1' which
  145. means some font of 12 point height and that charset encoding is needed, no
  146. matter of which family or style and so on.  The server will than take the
  147. first font where both criteria matches.
  148.  
  149. 3.1. Handling of GEM-Fonts
  150. --------------------------
  151.  
  152. At startup, the server parses all fonts provided by the VDI and translates
  153. the available information to XLFD strings.  These are stored in the hash
  154. file /var/lib/Xapp/fonts.db to accelerate further startups.
  155.  
  156. 3.2. Font-Aliasing
  157. ------------------
  158.  
  159. If there exists a file /etc/X11/fonts.alias it will be read at server
  160. startup and later be used to substitute font names from client requests to
  161. fonts the server provides.  Have a look at the server's font hash file at
  162. /var/lib/Xapp/fonts.db to see which fonts are provided by your system.
  163. There is also an example configuration 'fonts.alias.EXMPL' coming along
  164. with this file.
  165.  
  166. The format of the fonts.alias file is very simple, lines starting with a
  167. '!' are comment lines and will be ignored.  The relevant lines are formed
  168. the way "foo: bar" and "foo bar" and means in both cases: "find 'foo' and
  169. replace it with 'bar'", but in different ways.  The first form (with the
  170. colon) is used to substitute a _part_ of the font name and the second form
  171. (without colon) is used to substitute the _whole_ font name.
  172.  
  173. The "foo: bar" form is usefull to replace particular fields of the font
  174. name, for example the lines
  175.    -adobe-:   -*-
  176.    -courier-: -Courier10Pitch-
  177. would cause that a request for '-adobe-courier-*-*-*-*-*-*-*-*-*-*-*-*'
  178. would be translated to '-*-Courier10Pitch-*-*-*-*-*-*-*-*-*-*-*-*' which
  179. matches the speedo font from the NVDI package.  The field delimeters '-'
  180. should always be used (even if not forced) to avoid wrong results.
  181.  
  182. The "foo: bar" form is to substitute the whole font name and will be done
  183. _AFTER_ the part substitution.
  184.  
  185. There are two often requested pseudo-fonts which should always be aliased:
  186.  
  187. fixed: A monospaced font that fits best the system capabilities, e.g. the
  188.        font used the AES, or some other monospaced font of your choice.
  189.  
  190. variable: Some proportional font which should be of the same height as the
  191.           font used for fixed.
  192.  
  193. To use the fonts from the NVDI package, it could looks like
  194.  
  195. fixed   -Bitstream-Courier10Pitch-Medium-I-Normal-Serif-16-90-0-0-C-70-ISO8859-1
  196. variable -Bitstream-Life-Medium-R-Normal-Serif-16-90-0-0-P-68-ISO8859-1
  197.  
  198. The font to be substituted can also be a pattern, like
  199.  
  200. -adobe-times-*-*-*-*-*-*-*-*-*-*-iso8859-1 \
  201.                                      -*-times*-medium-*-*-*-*-*-*-*-*-*-*-*
  202. -*-Helvetica-Medium-R-Normal--*-120-*-*-*-*-*-*    \
  203.                                   -*-gothic*-medium-r-*-*-*-120-*-*-*-*-*-*
  204.  
  205. Please pay attention that the '\' isn't allowed in the font.alias file;
  206. it's only used here for better readability!  Instead both parts have to be
  207. in one line, with spaces or tabs between.
  208.  
  209. There are other oftern used font names of the form '9x15', '6x13' and so
  210. on, which means monospaced fonts of <width> * <height> pixel size.  If an
  211. request of such a font name appeares and the server can't find it in its
  212. XLFD list nor in the alias list, it takes a scalable font which can scaled
  213. best to that geometry and creates a generic XLFD entry.
  214.  
  215.  
  216. 4. Using The X Server
  217. =====================
  218.  
  219. After been started the X server checks if  /dev/xconout2  isn't locked by
  220. some other program and if  /usr/X11/bin/xconsole  exists.  In this case the
  221. latter on is started acts as a replacement for TosWin2's console window.
  222. TosWin2 mustn't be terminated for having xconsole started, only closing its
  223. console window is enough.  Note that also for xconsole the xconout2.xdd
  224. must be installed.
  225.  
  226. The next step after this is checking if either  /etc/X11/Xmodmap  and 
  227. /usr/X11/bin/xmodmap are existing.  In this case it will be started to
  228. apply user defined keyboard and/or mouse button mappings.  For more
  229. information see the example file 'Xmodmap.EXMPL' and the xmodmap manpage.
  230.  
  231. 4.1. Menu Bar Items
  232. -------------------
  233.  
  234. X11-Server:
  235.     About:   Views version information.
  236.  
  237. File:
  238.     gwm:   Enables/disables the built-in window manager.  In fact, this
  239.         option controls if X windows have GEM windgets and decor, or not.
  240.     Quit:   Quits the X server.  If some clients are connected, a
  241.         confirmation dialog will apear first.
  242.  
  243. Clients:   Views a list of all client connections.  Selecting one of the
  244.     entries while the Control key is held down, closes down immediately the
  245.     corresponding connection.
  246.  
  247. 4.2. Keyboard Input
  248. -------------------
  249.  
  250. In opposite to GEM apllications, every X window gets keyboard events always
  251. and only if it contains the mouse pointer, independent of the fact which is
  252. the top window.  This means that even if some GEM application has some of
  253. its wimdows the top window but the mouse pointer is over an X window, all
  254. keyboard inout will be sent to the latter.  On the other hand, if the
  255. X server has one of its windows the top window but the mouse pointer is
  256. somewhere else than over an X window, all keyboard inputs will be
  257. discarded.
  258.  
  259. Normaly the X server does no interpretition of any kyeboard input.  There
  260. is one exception:  The combination Control-Alt-Backspace causes an
  261. immediate server shutdown and is meant as a "Panic Key".
  262.  
  263. 4.3. Mouse Actions
  264. ------------------
  265.  
  266. X windows can be resized by clicking on the frame around and dragging to
  267. the new size.  Some windows may be set to be not resizeable, this can be
  268. overridden by holding down the Control key.  A short mouseclick onto the
  269. frame tops/bottoms the window.
  270.  
  271. Holding down the Alt key while clicking somewhere inside a window allows to
  272. move it around.
  273.