summaryrefslogtreecommitdiff
path: root/support/autolatex/INSTALL
blob: 4f5618f31862b691a5df28440df4127afeabd2aa (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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
----------------
1. PREREQUISITES
----------------

To install AutoLaTeX, you need to have Perl installed on your operating system.
We recommend also to have GNU Make installed. If not, you could copy/paste the
installation commands from the inside of the generated file named 'Makefile'.
Indeed, we provide a 'Makefile' because it is a common tool for compilation and
installation on Unix systems. The file 'Makefile' contains all the commands that
must be executed to compile and install AutoLaTeX.

The installation script Makefile.PL use the following Perl modules.
They must be installed prior to any call to the installation script.
a) Already included in many perl distributions:
	Getopt::Long
	File::Basename
	File::Spec
	File::Copy
	Pod::Text
	Pod::Man
b) Need manual installation with several perl distributions:
	Compress::Zlib
	pp

-------------------------
2. PREPARING INSTALLATION
-------------------------

a) Installing all the modules
-----------------------------

If you want to install all the modules provided by AutoLaTeX, type on a command line:

$ ./Makefile.PL

or:

$ ./Makefile.PL --prefix=<usr_path>

where <usr_path> is the path to the 'usr' root directory, eg. '/usr' or '/usr/local'
on Unix platforms, where AutoLaTeX should be installed.

The previous command creates the file 'Makefile'.
From this point, you could compile and install AutoLateX.

b) Installing some of the modules
-----------------------------

If you want to install only a part of the modules provided by AutoLaTeX, you must use
the command line options '--enable' or '--disable' followed by the name of a module.

The complete list of the modules may be obtained by:

$ ./Makefile.PL --modules


Let say you do not want to install the module 'gedit'.
You should type:

$ ./Makefile.PL --disable gedit

------------
3. COMPILING
------------

To compile AutoLaTeX, i.e. to generate the manual files..., you must type:

$ make all

or simply:

$ make

-------------------------------------
4. GENERATING BINARY EXECUTABLE FILES
-------------------------------------

Sometimes, you may want to install a standalone binary
file of AutoLaTeX, in place of the perl scripts.
It may be useful when there is not Perl distribution
installed on your computer.

To generate the binary executable files for your
current operating system, you must type the following
command:

$ make par

CAUTION: only your current operating system/platform is
         considered by this action. You may encounter
         problems when you are trying to run the generated
         files on a different platform or on different
         a operating system than the ones you are currently
         running.

-------------
4. INSTALLING
-------------

a) Copying the files
--------------------

To install AutoLaTeX inside the directory given to 'Makefile.PL', you must type:

$ make install


b) Updating TeX database
------------------------

At this point, all the files where copied.
If you have installed the STY file provided by AutoLaTeX, you
must update the TeX database with the following commands:

$ mktexlsr
$ update-updmap --quiet


c) Updating Gsettings
---------------------

In order for GSettings to use the autolatex's schema, it was copied to the
'<usr_path>/share/glib-2.0/schemas/' directory and then that directory
should be compiled by glib-compile-schemas.
You must type the command:

$ glib-compile-schemas <usr_path>/share/glib-2.0/schemas/

where <usr_path> is the path to the 'usr' root directory, eg. '/usr' or '/usr/local'.


-----------
5. CLEANING
-----------

To remove the temprary files and the generated files, you must type:

$ make clean