README

   1     "Blorb" is a nonsense word from a popular early 1980s work of IF
   2     called Enchanter where it was the name of a magic spell whose
   3     purpose was to "safely protect a small object as though in a
   4     strong box." In the late 1990s, the name was borrowed for a
   5     standard format for what might be called the wrapping and
   6     packaging of IF. A typical Blorb archive produced by Inform
   7     contains the "story file" -- the actual program for the game --
   8     together with its library card and cover art.
   9
  10               -- Graham Nelson in "Writing with Inform" (Chapter 23.4)
  11
  12 This program uses that cover art to generate thumbnail previews for
  13 GNOME's file manager. It works with Nautilus (in GNOME 2 and GNOME 3)
  14 and Unity (in Ubuntu 10.10+).
  15
  16 The heart of the program is a command-line utility ("blorb-thumbnailer")
  17 that relies on the GDK-PixBuf library to load, scale, and save the cover
  18 in question. It's accompanied by helper scripts and format specifications
  19 that tell Nautilus (the file manager) how and when to invoke it.
  20
  21 To compile, you'll need the GDK-PixBuf development headers. Lately they've
  22 been given a package of their own -- something like "libgdk-pixbuf2.0-dev"
  23 or "gdk-pixbuf2-devel" -- but in the past they've been bundled with the
  24 rest of the GTK+ headers (e.g., in "libgtk2.0-dev").
  25
  26 INSTALLATION
  27
  28 For an ordinary system-wide installation on GNOME 3:
  29
  30     make && sudo make install
  31
  32 On GNOME 2:
  33
  34     make && sudo make install GNOME=2
  35
  36 This will install the program and the manual, register the Blorb MIME
  37 type, and check in the appropriate handlers. To remove, unregister,
  38 and delete:
  39
  40     sudo make uninstall [GNOME=2]
  41
  42 It's also possible to install for a single user without administrative
  43 privileges:
  44
  45     make install PREFIX=$HOME/.local [GNOME=2]
  46
  47 But you'll need to ensure that Nautilus can find the thumbnailer: perhaps
  48 by setting BINDIR to a directory in the path (e.g., "BINDIR=$HOME/bin");
  49 perhaps by adding the default directory ("$HOME/.local/bin") to the path.
  50
  51 ISSUES AND LIMITATIONS
  52
  53  * In GNOME 2, installation may not take immediate effect. You can
  54    force Nautilus to notice the update with the command "nautilus -q"
  55    but in the process you'll lose any open file-manager windows.
  56
  57  * There's no generic "blorb" icon to represent files without covers.
  58
  59  * URIs aren't supported. In theory you could be browsing, say, the IF
  60    Archive, via FTP, in Nautilus, and it would attempt to provide
  61    thumbnails. For now I'd say, use IFDB instead.
  62
  63 AUTHOR
  64
  65     Lewis Gentry <8uuuuu@gmail.com>
  66     http://lg.vblank.net/blorb/
  67
  68 LICENSE
  69
  70 GPLv3+ (see COPYING or <http://www.gnu.org/licenses/gpl.html>).
  71
  72 With one exception: the xdg-mime utility, which is released under an
  73 Expat-style license; see "mime/xdg-mime" for more information.