cgit.sxemacs.org Git - emchat/blob - INSTALL

   1
   2 ========================================================================
   3 EMchat is now written entirely in emacs-lisp, so theoretically it should
   4 run on anything that can run (S)XEmacs and can connect to the ICQ servers.
   5
   6 You will need at least XEmacs 21.4 or any version of SXEmacs.
   7 ========================================================================
   8
   9 This installation is definitely a 'no-brainer'
  10
  11 1) Check the Makefile, and edit anything as required.
  12
  13    On Windows, you must have set your HOME variable (e.g. on Windows 98
  14    in your autoexec.bat, add 'set HOME=C:\' before installation. You
  15    should have set HOME for Cygwin anyway). Reboot if necessary before
  16    installing EMchat!
  17
  18    For Cygwin, search for '# Cygwin #' in the Makefile and to see what
  19    you need to change to build on Cygwin.
  20
  21    For Solaris, search for '# Solaris #' in the Makefile to see what
  22    you need to change to build on Solaris.
  23
  24 2) 'make'
  25
  26 3) become 'root' and then 'make install'. On Windows just type
  27    'make install'
  28
  29 Hold it, you're not finished yet...
  30
  31 Add the following to your `user-init-file' (XEmacs -- ~/.xemacs/init.el
  32                                             SXEmacs -- ~/.sxemacs/init.el)
  33 ---------- cut ----------
  34
  35 (require 'emchat)
  36 (setq emchat-user-alias "me")
  37
  38
  39 ---------- cut ----------
  40
  41 As the user that will be using EMchat, fire up (S)XEmacs and...
  42
  43 M-x emchat-setup RET
  44
  45 That will set up the needed stuff in your home directory.
  46
  47 Adding your own UIN:
  48 -------------------
  49 ~/.emchat/world is the file that stores not only the UIN's of your
  50 friends but also your own UIN.
  51
  52 Just edit ~/.emchat/world and change the UIN beside 'me' to reflect your
  53 own UIN.
  54
  55 Of course you can change the alias ('me') of your own UIN to be whatever
  56 you want.  But you'll have to change the (setq emchat-user-alias "...")
  57 line in your `user-init-file' to match.
  58
  59
  60 Ok, now you're done.
  61
  62 'M-x emchat-login'.  There you go!
  63
  64 Don't hesitate to message me a success report or mail me your
  65 screenshots!
  66
  67
  68 Example world file:
  69 ------------------
  70 Literally you can put anything you like in this resource file, such as
  71 this introduction.  EMchat will only consider a line to be a valid buddy
  72 if...
  73
  74     -- `:icq' starts at column zero (there's no leading whitespace or
  75        characters).
  76
  77     -- There is one space between `:icq' and a UIN.
  78
  79     -- There is one space between a UIN and a buddy name.
  80
  81     -- The buddy name does NOT contain any colon `:' characters.
  82        Buddy names can contain whitespace anywhere except as the
  83        first character.
  84
  85     -- There is one space between the buddy name and any group names.
  86        Group names begin with a colon `:'.
  87
  88 So, for example...
  89
  90 :icq 34307457 emchat
  91 :icq 12345678 me
  92 :icq 88888888 the queen :royalty
  93
  94 This way, it defines three buddies: \"emchat\", \"me\", and \"the
  95 queen\". It reads alias name until the end of the line, or until the
  96 first group name.  In that example, the buddy \"the queen\" is in
  97 the group `:royalty'.
  98
  99 Adding your own UIN:
 100
 101 Just change \"12345678 me\" above to your UIN/alias.  And don't
 102 forget to change the (setq emchat-user-alias \"me\") line in your
 103 `user-init-file' to match.
 104
 105 BTW, that 1st buddy up there, 34307457 emchat, is a valid UIN, it's
 106 mine. :-)
 107
 108 Remember to M-x emchat-world-update after changing this rc file.
 109