File: README.en

package info (click to toggle)
mu-cite 8.1%2B0.20120227-4
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 188 kB
  • ctags: 69
  • sloc: lisp: 766; sh: 162; makefile: 87
file content (132 lines) | stat: -rw-r--r-- 3,550 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
[README for MU (English Version)]
by MORIOKA Tomohiko <morioka@jaist.ac.jp>

What's MU
=========

  MU stands for "Message Utilities".  It consists of following
  modules:

	mu-cite: a citation utility
	  mu-cite.el     --- main module of mu-cite
	  mu-bbdb.el     --- mu-cite submodule for BBDB
	  mu-register.el --- mu-cite submodule for registration

	latex-math-symbol.el --- translate mathematical symbols of
			     	 LaTeX into MULE characters

  It requires two packages APEL 10.7 or later and FLIM 1.12.2 or later.
  Please install them.


Installation
============

(a) run in expanded place

  If you don't want to install other directories, please do only
  following:

	% make

  You can specify the emacs command name, for example

	% make install EMACS=xemacs

  If `EMACS=...' is omitted, EMACS=emacs is used.

(b) make install

  If you want to install other directories, please do following:

	% make install

  You can specify the emacs command name, for example

	% make install EMACS=xemacs

  If `EMACS=...' is omitted, EMACS=emacs is used.

  You can specify the prefix of the directory tree for Emacs Lisp
  programs and shell scripts, for example:

	% make install PREFIX=~/

  If `PREFIX=...' is omitted, the prefix of the directory tree of the
  specified emacs command is used (perhaps /usr/local).

  For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
  will create the following directory tree:

	/usr/local/share/emacs/site-lisp/mu/   --- MU

  You can specify site-lisp directory, for example:

	% make install LISPDIR=~/share/emacs/lisp

  If `LISPDIR=...' is omitted, site-lisp directory of the specified
  emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
  /usr/local/lib/xemacs/site-lisp).

  If the emu modules (included in APEL package) have been installed in
  the non-standard directory, you should specify where they will be
  found, for example:

	% make install VERSION_SPECIFIC_LISPDIR=~/elisp

  You can specify other optional settings by editing the file
  MU-CFG.  Please read comments in it.

(c) install as a XEmacs package

  If you want to install to XEmacs package directory, please do
  following:

	% make install-package

  You can specify the XEmacs command name, for example

	% make install-package XEMACS=xemacs-21

  If `XEMACS=...' is omitted, XEMACS=xemacs is used.

  You can specify the package directory, for example:

	% make install PACKAGEDIR=~/.xemacs

  If `PACKAGEDIR=...' is omitted, the first existing package
  directory is used.

  Notice that XEmacs package system requires XEmacs 21.0 or later.


load-path (for Emacs or MULE)
=============================

  If you are using Emacs or Mule, please add directory of mu to
  load-path.  If you install by default setting, you can write
  subdirs.el for example:

  --------------------------------------------------------------------
  (normal-top-level-add-to-load-path '("apel" "flim" "mu"))
  --------------------------------------------------------------------

  If you are using XEmacs, there are no need of setting about
  load-path.


CVS based development
=====================

  If you would like to join CVS based development, please send mail to

	cvs@cvs.m17n.org

  with your account name and your public key for ssh.  cvsroot is
  :ext:cvs@cvs.m17n.org:/cvs/root.

  If you cannot use ssh, please send UNIX /etc/passwd style crypted
  password.  you can commit with the cvsroot
  :pserver:<accountname>@cvs.m17n.org:/cvs/root.

  We hope you will join the open development.