docs/INSTALL

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