a few words about media types
[blorb-thumbnailer.git] / README
blob9231c02fec9e1da5fffbecacec13da5b0d19eabb
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.
10               -- Graham Nelson in "Writing with Inform" (Chapter 23.4)
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+).
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.
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").
26 INSTALLATION
28 For an ordinary system-wide installation on GNOME 3:
30     make && sudo make install
32 On GNOME 2:
34     make && sudo make install GNOME=2
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:
40     sudo make uninstall [GNOME=2]
42 It's also possible to install for a single user without administrative
43 privileges:
45     make install PREFIX=$HOME/.local [GNOME=2]
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.
51 ISSUES AND LIMITATIONS
53  * Installation may not take immediate effect. You can force Nautilus
54    to notice the update with the command "nautilus -q" but in the
55    process you'll lose any open file-manager windows.
57  * There's no generic "blorb" icon to represent files without covers.
59  * URIs aren't supported. In theory you could be browsing the IF
60    Archive, via FTP, in Nautilus, and it would attempt to provide
61    thumbnails. For now I'd say, browse IFDB instead.
63  * Only files with the media type "application/x-blorb" are picked up
64    by default. If certain extensions are being ignored, check the
65    media type: via "Properties" in Nautilus, or from the command line
66    with
68        gvfs-info <problematic blorb> | grep content
70    or, on older systems, with
72        gnomevfs-info <problematic blorb> | grep -i mime
74    If you see something like "application/x-extension-gblorb" -- as
75    might show up on GNOME 2 after associating the "gblorb" extension
76    with a program like Gargoyle -- you'll need to announce that those
77    files are also fair game. One way to do so:
79        gconftool-2 --type string --set \
80          /desktop/gnome/thumbnailers/application@x-extension-gblorb/command \
81          "blorb-thumbnailer %i %o %s"
82        gconftool-2 --type bool --set \
83          /desktop/gnome/thumbnailers/application@x-extension-gblorb/enable true
85    Another way to deal with non-standard types is to remove them:
87        xdg-mime uninstall ~/.local/share/mime/packages/user-extension-gblorb.xml
89    And redo "open with" associations for blorbs generally.
91 AUTHOR
93     Lewis Gentry <8uuuuu@gmail.com>
94     http://lg.vblank.net/blorb/
96 LICENSE
98 GPLv3+ (see COPYING or <http://www.gnu.org/licenses/gpl.html>).
100 With one exception: the xdg-mime utility, which is released under an
101 Expat-style license; see "mime/xdg-mime" for more information.