w3m-0.5.2-Standout_PRE.txt

   1 AUTHOR: Alexander Haley <ahaley AT alum DOT wpi DOT edu>
   2 DATE: 2009-12-01
   3 LICENSE: GNU Free Documentation License Version 1.2
   4
   5 SYNOPSIS:
   6 Improve w3m's rendering of PRE text blocks so as to improve readability of the
   7 LFS/BLFS/+ instruction book in w3m.
   8
   9 DESCRIPTION:
  10 Using w3m to read the [B]LFS book is hindered by w3m's lack of sufficient
  11 "standout" for PRE text blocks. Since the [B]LFS books deliberately enclose
  12 all build instructions inside of PRE tags, improving such content's readability
  13 will improve the [B]LFS build process.
  14
  15 ATTACHMENTS:
  16 * http://www.linuxfromscratch.org/hints/downloads/files/ATTACHMENTS/w3m-Standout-PRE/w3m-0.5.2-Standout_PRE-1.0.patch
  17
  18 PREREQUISITES:
  19 This hint expects that you are familiar with the build process of LFS, since
  20 that effort requires similiar actions, mainly: acquiring source, unpacking and
  21 patching that source, configuring, building and installing that source.
  22
  23 HINT:
  24
  25 Background: When reading the instruction books for [B]LFS via w3m, one must pay
  26 careful attention to distinguish the "DO THIS" command instructions from the
  27 surrounding text. This extra effort is due to w3m's lack of suitable 'jumpout'
  28 rendering for PRE text blocks. Here is an example: From LFS 6.5, Chapter 4.3
  29
  30 * SAMPLE **********************************************************************
  31         Grant lfs full access to $LFS/tools by making lfs the directory owner:
  32
  33         chown -v lfs $LFS/tools
  34
  35         If a separate working directory was created as suggested, give user lfs
  36         ownership of this directory:
  37
  38         chown -v lfs $LFS/sources
  39
  40         Next, login as user lfs. This can be done via a virtual console, through
  41         a display manager, or with the following substitute user command:
  42 *******************************************************************************
  43
  44 Looking at this quickly, one can imagine situations where a builder might miss
  45 "seeing" these commands due to their relative similarity to the surrounding
  46 text and to each other.
  47
  48 This hint will suggest an alteration to the w3m source such that the preceeding
  49 example would then be rendered as follows: (Again from LFS 6.5, Chapter 4.3)
  50
  51 * SAMPLE **********************************************************************
  52         Grant lfs full access to $LFS/tools by making lfs the directory owner:
  53
  54         ------------------------------------------------------------------------
  55         chown -v lfs $LFS/tools
  56         ------------------------------------------------------------------------
  57
  58         If a separate working directory was created as suggested, give user lfs
  59         ownership of this directory:
  60
  61         ------------------------------------------------------------------------
  62         chown -v lfs $LFS/sources
  63         ------------------------------------------------------------------------
  64
  65         Next, login as user lfs. This can be done via a virtual console, through
  66         a display manager, or with the following substitute user command:
  67 *******************************************************************************
  68
  69 Now, at least the commands to be executed are made more visually striking in
  70 the hope that a building will not skip any necessary steps.
  71
  72 Method:
  73         Download the source (at of this writing, version 0.5.2) of w3m.
  74                 Currently this source can be found at:
  75                         http://www.sourceforge.net/projects/w3m
  76         Unpack this source: tar -zxf w3m-0.5.2.tar.gz
  77         Enter the source directory: cd w3m-0.5.2
  78         Apply the attached "PRE STANDOUT" patch:
  79                 patch -Np1 -i ../w3m-0.5.2-Standout_PRE-1.0.patch
  80
  81         Configure, Build and Install: ./configure && make && make install
  82
  83 Thats it. The newly installed w3m will alter the PRE text blocks as described
  84 above.
  85
  86 ACKNOWLEDGEMENTS:
  87   * Bruce Dubs <bruce.dubbs AT gmail DOT com> for suggesting I write this hint.
  88
  89 CHANGELOG:
  90 [2009-12-01]
  91   * Initial Hint.