summaryrefslogtreecommitdiff
path: root/INSTALL
blob: 30507e74b0e91981bb9d2dfda320aa4a5c7d5ca1 (plain)
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
Here is the procedure for compiling and installing SKRIBE on a Unix system.

 
Requirements
************

   - GNU-MAKE is required.
   - BIGLOO 2.6b (or later) *or* SKTLOS 0.56 is required.

Summary of a SKRIBE compilation, test and installation
******************************************************

   $ ./configure --with-bigloo|--with-stklos
   $ make
   $ make install

   This procedure will self test SKRIBE because it will compile the various
   Skribe documents that implement the Skribe documentation.


Configuring SKRIBE
******************

   Configuring SKRIBE/BIGLOO
   *************************

   1.a Edit the `./etc/bigloo/configure' file and set the variables defined in the Use
       section (e.g. `bindir', `libdir', `mandir' and `docdir'). Note that
       if you leave these variable definitions blank the installation procedure
       will install Skribe at the same location as Bigloo.

   1.b Configure Skribe for your machine by invoking:
        `./configure --with-bigloo'
       or
        `./configure --with-bigloo --prefix <your-prefix>'
       or
        `./configure --with-bigloo --bigloo=<your-bigloo-compiler>'
       When the system is ready to be compiled, `configure' prints 
       the message `configuration done.'.

       The following command:
        `./configure --with-bigloo --help'
       displays the available options.
    
       The default configuration uses the C back-end. To produce a JVM version of
       SKRIBE, uses:

        `./configure --with-bigloo --jvm'

   Configuring SKRIBE/STKLOS
   *************************

   1.  Configure Skribe for your machine by invoking:
        `./configure --with-stklos' 
       or
        `./configure --with-stklos --prefix <your-prefix>'

Compiling SKRIBE
****************

   2.  Type:
          `make'

       This will compile:
         - the Skribe compiler: skribe
         - the Texinfo to Skribe translator: skribeinfo (*)
         - the BibTex to Skribe translator: skribebibtex (*)
         - the Skribe documentation (in manuals/man, manuals/user and
           manuals/expert).

       (*) this tools is compiled only when SKRIBE is compiled with BIGLOO.


Installing SKRIBE
*****************

   3.  Type:
          `make install'

       This install, the Skribe compiler, the Skribeinfo compiler, the
       various Skribe back-ends, the variable Skribe style files and
       the Skribe documentation. 

       This does not install the skribe.el emacs package.


Cleaning SKRIBE
***************

   4.  Once, installed, you can type:
          `make clean'
       to remove all the useless files.


Uninstalling SKRIBE
*******************

   5.  To uninstall Skribe:
          `make uninstall'


Unconfiguring SKRIBE
********************

   6.  If you plan to re-install Skribe on a new platform. Before performing
       the all installation process (step 1 to 5) you must first remove the
       current configuration. For this type:
          `make distclean'