win/X11/Install.X11

   1 $NHDT-Date: 1524689294 2018/04/25 20:48:14 $  $NHDT-Branch: NetHack-3.6.0 $:$NHDT-Revision: 1.11 $
   2 # Copyright (c) 2003 by David Cohrs
   3 # NetHack may be freely redistributed.  See license for details.
   4
   5 This document describes the installation of NetHack with an X11 interface.
   6
   7 There are no explicit UNIX dependencies in this code, but we have only
   8 tested it under UNIX, using X11R4, X11R5, or X11R6.  We have two reports
   9 that the code also works under DesqView/X on MS-DOS with djgpp, but you
  10 will have to add dependencies for the X code to that makefile before you
  11 can use it.  Other X11R4+ platforms may work as well, with some tweaking
  12 likely.  Follow WIN* in sys/unix/Makefile.src for compilation hints.
  13
  14 (If you try to compile it with X11R3 or earlier, you will get many errors,
  15 starting with complaints about XtPointer not being declared.  If you get
  16 around the compilation problems, you will still need a recent library of
  17 Athena Widgets to link against.  Once compiled, you can probably run it
  18 under an R3 X server, though.)
  19
  20 The reason this uses the Athena widget set is that the Athena widgets come
  21 free from MIT (like X11).  Unfortunately, the companies that resell X11
  22 (value subtracted er, added software; yea, yea, that's the ticket) usually
  23 discourage its use by either omitting the set or putting it on the
  24 "unsupported" portion of their tape.  If you do not have the Athena
  25 widgets, you may obtain them via anonymous ftp from ftp.x.org.
  26
  27
  28 To use this code, define X11_GRAPHICS in include/config.h.  (You can comment
  29 out TTY_GRAPHICS or change DEFAULT_WINDOW_SYS if you want to, but there's
  30 little reason to do so.  The X11 version almost requires a config file
  31 for full effect, so you can just as well set windowtype there; also, you
  32 or someone else might just possibly be stuck in a situation where you can't
  33 use the X version -- over a non-blindingly-fast modem, say.)  You may also
  34 want to define USE_XPM or GRAPHIC_TOMBSTONE as discussed below.
  35
  36 In src/Makefile, add $(WINX11SRC), $(WINX11OBJ), and $(WINX11LIB) to
  37 WINSRC, WINOBJ, and WINLIB respectively, and compile.  This will give you
  38 an executable supporting both X11 and tty windowing.
  39
  40
  41 If you want to use the optional tiles (multicolored pictures instead of a
  42 replacement font), you will need to have the win/share files and change
  43 the VARDATND setting in the top Makefile to contain the tile files before
  44 you do your 'make all'.
  45
  46 If you get a linker error referring to `substitute_tiles' then most
  47 likely you have overlooked the WINSRC, WINOBJ, WINLIB step above.
  48 Alternatively, you are building with more than one non-tty interface
  49 specified but haven't followed the direction in src/Makefile to remove
  50 all but one instance of tile.o from the WINxxxOBJ values used for WINOBJ.
  51
  52 When using tiles, you have the option of defining USE_XPM in config.h.
  53 This causes NetHack to use the XPM file format for the "x11tiles" file
  54 rather than a custom format.  Since the XPM format can be processed by
  55 existing tools such as PBMPlus and XV, you can modify the tiles to suit
  56 your environment.  However, you need to make sure the number of tiles
  57 in each row of the image remains the same (currently 40), as the code
  58 depends on this to calculate the size of each tile. For example, you may
  59 magnify them for display on high-resolution screens using the following
  60 command:
  61     xpmtoppm x11tiles | pnmscale -xscale 1 -yscale 1.6875 |
  62         pnmdepth 255 | ppmquant 100 | ppmtoxpm >x11tiles_big.xpm
  63 To use XPM, you must have the free XPM libraries installed in your system.
  64 Official xpm releases can be found by ftp on:
  65     ftp.x.org       (198.4.202.8)  contrib/libraries     (Boston, USA)
  66     avahi.inria.fr  (138.96.12.1)  pub/xpm     (Sophia Antipolis, France)
  67 If you do choose to define USE_XPM, be sure to add "-lXpm" to WINX11LIB
  68 in src/Makefile.
  69
  70 If you define USE_XPM in config.h, you may also define GRAPHIC_TOMBSTONE
  71 which causes the closing tombstone to be displayed from the image file
  72 specified by the "tombstone" X resource (rip.xpm by default).  In this
  73 case, make sure the top Makefile VARDATND also contains rip.xpm.
  74
  75
  76 Whether or not you install tile support, you can provide support for
  77 special graphics symbols via alternate fonts.  (The fonts and tiles
  78 cannot be used at the same time, but the same executable handles both.)
  79 The two included X11 fonts use the general NetHack map area remapping
  80 to represent object/dungeon/trap/effect characters (see win/X11/nethack.rc
  81 and the Guidebook) as monocolored symbols and monsters as monocolored
  82 letters.  For instance, a ruby potion will show up as a potion symbol in
  83 red.  It's easier to see the difference between fonts and tiles than to
  84 describe it. :-)  Unless you are the only one using your executable and
  85 you already know which you prefer, we suggest installing the optional files
  86 for both possibilities and letting each person decide for themselves.
  87
  88 To use the included fonts, you will need to install one or both of them
  89 and then use the symbol mappings found in nethack.rc.  The fonts are found
  90 in nh10.bdf and ibm.bdf.  You first need to convert the bdf files to whatever
  91 form your X11 server recognizes (usually using a command called bdftosnf
  92 for R4 servers or bdftopcf for R5 servers).  Then run mkfontdir on the
  93 directory containing your font files (you might want to copy them to HACKDIR,
  94 from the top Makefile, after you've done "make install").  If these commands
  95 aren't familiar, talk to your local X11 guru and read the man pages.
  96
  97 nethack.sh automatically adds HACKDIR to your font search path.  If
  98 you (assuming you are a system administrator) can install the fonts in your
  99 standard X11 font directory the relevant lines in nethack.sh can be removed.
 100 Alternatively, all persons playing nethack must add that "xset fp+"
 101 command to their .xinitrc file, or whatever file they execute when starting
 102 X11.  See the note below for the alternative installation procedure
 103 for Sun's OpenWindows.
 104
 105
 106 If your X11 include files and libraries are not installed in a standard
 107 place (i.e. /usr/include/X11 and /usr/lib respectively) you will need to
 108 prepend an appropriate -I<idirectory> parameter to CFLAGS and a
 109 -L<ldirectory> parameter to LFLAGS, setting <?directory> to the place to
 110 find the include and library files for X11.
 111
 112
 113 Finally, to ensure NetHack's windows look the way they were intended to
 114 look, make sure the top Makefile VARDATND also contains NetHack.ad.  If it
 115 does, running nethack will automatically take the appropriate steps to
 116 cause this file to be used to initialize NetHack's X11 resources.
 117
 118
 119 Three icon suggestions to the window manager are supported:  nh72, nh56,
 120 and nh32.  Data for them comes from the source files nh72icon, nh56icon,
 121 and nh32icon; they are compiled into the program via #includes in winX.c.
 122 Selection between them is controlled by the "icon" resource in NetHack.ad;
 123 the default is nh72.
 124
 125
 126 Sorry, an Imakefile is not included.  Unlike many X11 programs, X11
 127 support is only a small, optional, part of nethack, and the Makefile is
 128 needed for systems that don't use X11.
 129
 130
 131 Notes for AIX 3.2:
 132     1.  AIX 3.2 includes the Athena Widget Toolkit library (and other things)
 133         under the /usr/lpp/X11/Xamples tree, so you will have to add
 134         -L/usr/lpp/X11/Xamples/lib to LFLAGS.  If you can't find libXaw.a on
 135         your first build, go into /usr/lib/X11/Xamples, read the README file,
 136         and build the library.
 137
 138 Notes for XFree86 - (on linux and BSD386 platforms)
 139
 140     1.  Edit src/Makefile for linux/BSD386. Use the
 141         standard X11 object and library options.
 142
 143     2.  Follow the standard installation directions defined above.
 144
 145
 146 File                            Description
 147 ---------       ---------------------------------------------------------------
 148 nethack.rc      - A sample configuration file for fonts nh10 and ibm.
 149 nh10.bdf        - A modified version of the 10x20 standard font.
 150 ibm.bdf         - A modified version of one of the ibm (8x14) nethack font.
 151                   Must be used in conjunction with NetHack.ad or nethack.rc.
 152 nh32icon        - A 32x32 icon bitmap for use with window managers.
 153 nh56icon        - A 56x56 icon bitmap for use with window managers.
 154 nh72icon        - A 72x72 icon bitmap for use with window managers.
 155 nh_icon.xpm     - A color icon for use with window managers.
 156 NetHack.ad      - A sample .Xdefaults for a color screen.
 157 ../../include/Window.h
 158 ../../include/WindowP.h
 159 Window.c        - A bare-bones widget that has 16 colors and a drawing canvas.
 160 ../../include/winX.h
 161                 - Defines for the X window-port.
 162 win*.c          - Code for the X window-port
 163 dialogs.c       - A better dialog widget.  Original code (modified slightly
 164                   by Dean Luick) distributed under the X copyright by Tim
 165                   Theisen.  This is from his Ghostview program (which is under
 166                   the GNU public license, v2 or higher).
 167 pet_mark.xbm    - A pet indicator bitmap for tiles.
 168 pilemark.xbm    - Item pile indicator for tiles.
 169 rip.xpm         - A graphical tombstone.
 170 tile2x11.c      - Converts win/share tiles for X11 use.