doc/afterimage.txt

   1 *afterimage.txt*  Edit binary files by converting them to text
   2
   3 Author:  Tim Pope <vimNOSPAM@tpope.org>         *afterimage-author*
   4 License: Same terms as Vim itself (see |license|)
   5
   6 This plugin is only available if 'compatible' is not set.
   7
   8 BUILT-INS                                       *afterimage-built-ins*
   9
  10 PNGs and GIFs are converted to/from XPM with ImageMagick.  XPM is a plain text
  11 format that resembles a C header.  GUI versions of Vim will actually syntax
  12 highlight the image data to resemble the original.  While no replacement for a
  13 real image editor, this built-in can and has been used to tweak small icons.
  14
  15 PDFs are uncompressed/recompressed with pdftk.  Even when decompressed, PDFs
  16 are partially a binary format, so this is mostly a novelty.
  17
  18 Word documents have their text extracted (one way) with antiword.
  19
  20 OS X binary plists are converted to/from XML with plutil.
  21
  22 CUSTOMIZATION                                   *afterimage-customization*
  23
  24 The easiest way to provide custom handlers is to learn from the source to the
  25 built-ins.  Briefly:
  26
  27 AfterimageReadPost() should be called from a BufReadPost,FileReadPost autocmd,
  28 with the argument being a string containing the command to run.  The source
  29 and destination files should each be replaced by %s and must appear in that
  30 order.  If this function returns true, that means that an entire file was
  31 successfully converted, and that it is appropriate to issue commands like "set
  32 readonly" or "setf myfiletype".
  33
  34 AfterimageWriteCmd() should be called from a BufWriteCmd,FileWriteCmd autocmd.
  35 The argument is a command in the same format AfterimageReadPost() requires.
  36
  37 Don't forget to setlocal binary in a BufReadPre,FileReadPre autocmd if the
  38 file is in fact binary.
  39
  40 If you have a customization you think others could use, feel free to submit it
  41 to the author of this plugin.
  42
  43  vim:tw=78:et:ft=help:norl: