docs/INSTALL

   1 htag-0.0.23
   2 18th June 2003
   3
   4 1. Plugins
   5 ==========
   6
   7 Htag.pl works on a plugin system.  All the plugins are in the (originally
   8 named) plugins directory.  They should be moved somewhere sensible and the
   9 path to them should be put in the $cfg{'plugindir'} variable in your ~/.htrc
  10
  11 If you're installing for the whole box put them in
  12 /usr/local/share/huggietag/plugins or some such.
  13 A system tagfile could live in /usr/local/share/huggietag too for instance.
  14
  15 If you're installing for yourself you can just leave them in the htag-x.y.z
  16 directory.
  17
  18 2. Module
  19 =========
  20
  21 htag.pl requires a perl module so I suggest:
  22 cp HtagPlugin/HtagPlugin.pm /usr/local/lib/site_perl
  23
  24 or somewhere sensible that looks like a site_perl dir and is in the list
  25 given by: perl -e 'print join "\n", @INC;'
  26
  27 If you want to make your own local perl directory (or you have no choice
  28 because you are not root on the machine you're installing it on), then make
  29 a directory, copy the module there, and add a line like:
  30 use lib '/home/huggie/.perllibs/';
  31 to the top of htag.pl which is the only file which uses this module since
  32 the advent of eval of plugins (Hooray!).
  33
  34 NOTE:  This must be an absolute path if you're going to call it from random
  35 locations.
  36
  37 If I write an install script it will do this for you.
  38
  39 3. Config file
  40 ==============
  41
  42 Copy the sample.htrc to ~/.htrc and edit it lots.
  43 See http://the.earth.li/~huggie/cgi-bin/moin/HtagHowto for more information.
  44
  45 4. Signatures
  46 =============
  47
  48 Create your own sigs.  You can use some of the sigs I provide as templates.
  49 See http://the.earth.li/~huggie/cgi-bin/moin/HtagHowto for more information.
  50
  51 5. Using it
  52 ===========
  53
  54 To call htag from mutt and tin I use a script which I've called msg which
  55 contains:
  56 #!/bin/sh
  57 ~/perl/huggietag/current/htag.pl -m $1 2>&1 # |tee ~/.htaglog
  58 # Uncomment the pipe to tee for debugging
  59 vim $1
  60
  61 It assumes your mail/newsreader will pass the message file in as the first
  62 argument.  If you wanted to you could modify it to do clever things based on
  63 the contents of the arguments passed (e.g. if tin passes <message file>
  64 <+line number> then you could detect that and pass it on to your editor).
  65
  66 I don't do that because I have vim macros that do some elementary cleaning
  67 up and cursor positioning before I actually type anything in mail/news but
  68 you might want to.  If you create anything you think others might find
  69 useful then mail it to me.
  70 (a version of my current vimrc might be at http://www.earth.li/~huggie/mutt/
  71 but it might well not be when you read this :))
  72
  73 Enjoy.  I hope you find this useful and if you do mail me and let me know
  74 what didn't work right, what you use it for, what plugins you wrote or how
  75 it Just Works :)