summaryrefslogtreecommitdiff
path: root/Master/tlpkg/texworks/texworks-help/TeXworks-manual/en/Installation.html
blob: 7ceb2fbc9abb1a8258803bda67d18b86f11d6780 (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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"  
  "http://www.w3.org/TR/html4/loose.dtd">  
<html > 
<head><title>2 Installation</title> 
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> 
<meta name="generator" content="TeX4ht (http://www.tug.org/tex4ht/)"> 
<meta name="originator" content="TeX4ht (http://www.tug.org/tex4ht/)"> 
<!-- info,2,imgdir:images/,sec-filename,next,index=2,url-enc,html --> 
<meta name="src" content="index.tex"> 
<link rel="stylesheet" type="text/css" href="index.css"> 
</head><body 
>
<!--l. 5--><p class="noindent" ><div id="container"> <!--l. 5--><div class="crosslinks"><p class="noindent">[<a 
href="Firststeps.html" >next</a>] [<a 
href="Introduction.html" >prev</a>] [<a 
href="Introduction.html#tailIntroduction.html" >prev-tail</a>] [<a 
href="#tailInstallation.html">tail</a>] [<a 
href="index.html#Installation.html" >up</a>] </p></div>
<!--l. 5--><p class="indent" >   <div class="chapternumber">2</div><h1><a 
 id="x7-40002"></a>Installation</h1> <a 
 id="dx7-4001"></a>
<!--l. 9--><p class="indent" >   T<sub>E</sub>Xworks is only a text editor; to be able to create documents with (L<sup>A</sup>)T<sub>E</sub>X and to typeset
them to PDF, we also need what is called a <em>T<sub>E</sub>X distribution</em><a 
 id="dx7-4002"></a><a 
 id="dx7-4003"></a>. This is a collection of
programs and other files which will be automatically called by T<sub>E</sub>Xworks during its
work. Thus, you need to install a distribution: we will do that <em>before</em>
starting T<sub>E</sub>Xworks for the first time, as this way, T<sub>E</sub>Xworks will automatically find what it
needs.
<!--l. 11--><p class="indent" >   <b>TeX&#x00A0;Live</b><a 
 id="dx7-4004"></a> (<a 
href="http://www.tug.org/texlive/" class="url" >http://www.tug.org/texlive/</a>), a combination of teTeX,
MacTeX and XEmTeX, is available for all three operating systems (Linux,
Mac OS X, Windows). Note that you need a reasonably recent version
of TeX&#x00A0;Live (2012 or later at the time of writing) to use all features of
T<sub>E</sub>Xworks.
<!--l. 13--><p class="indent" >   <div class="OSspecific"><div class="OSspecificLogo OSLinux"></div> For Linux<a 
 id="dx7-4005"></a>: most Linux distributions include a T<sub>E</sub>X distribution, but it may not be
installed by default and you will have to use the Linux package management tools
to do that. Alternatively, you can also download and install TeX&#x00A0;Live directly
from <a 
href="http://www.tug.org/texlive/" class="url" >http://www.tug.org/texlive/</a>. </div>
<!--l. 17--><p class="indent" >   <div class="OSspecific"><div class="OSspecificLogo OSMac"></div> For the Mac<a 
 id="dx7-4006"></a>: <b>MacTeX</b><a 
 id="dx7-4007"></a>, a new distribution based on gwTeX and XeTeX, is
available; see <a 
href="http://www.tug.org/mactex/" class="url" >http://www.tug.org/mactex/</a>. </div>
<!--l. 21--><p class="indent" >   <div class="OSspecific"><div class="OSspecificLogo OSWindows"></div> For Windows<a 
 id="dx7-4008"></a>: a very popular distribution is <b>MiKTeX</b><a 
 id="dx7-4009"></a> (<a 
href="http://www.miktex.org/" class="url" >http://www.miktex.org/</a>).
MikTeX has an update programme, which has also been ported to Linux.
You can also use the XEmTeX distribution (<a 
href="http://www.xemtex.org/" class="url" >http://www.xemtex.org/</a>). </div>
   <h3 class="sectionHead"><span class="titlemark">2.1   </span> <a 
 id="x7-50002.1"></a>Under Windows</h3>
<a 
 id="dx7-5001"></a>
<!--l. 27--><p class="noindent" >Most of the larger T<sub>E</sub>X distributions already contain T<sub>E</sub>Xworks as a package. Sometimes, these
versions even have some distribution-specific enhancements. So, the preferred way
of installing T<sub>E</sub>Xworks on Windows is to use the package manager of your distribution. In
this case, you can skip the next few paragraphs. Be sure to read the end of this
section, though, as it provides important information about customizing T<sub>E</sub>Xworks to your
needs.
<!--l. 29--><p class="indent" >   If you want to obtain an &#8220;official&#8221; version, obtain T<sub>E</sub>Xworks by downloading the setup
from the T<sub>E</sub>Xworks web site <a 
href="http://tug.org/texworks/" class="url" >http://tug.org/texworks/</a> after the installation of the T<sub>E</sub>X
distribution.
<!--l. 31--><p class="indent" >   Simply install T<sub>E</sub>Xworks by running the setup file. During the installation, you will be
                                                                          

                                                                          
asked where to install the program, if you want to create shortcuts, and if you
want to always open <span class="path">.tex</span> files with T<sub>E</sub>Xworks. There are reasonable default values that
should work well for most users.
<!--l. 33--><p class="indent" >   If you want full control over how and where T<sub>E</sub>Xworks is put, you can also download the
<span class="path">.zip</span> archive from the website and unpack it wherever you like. Note that in this
case, shortcuts and file associations must be created manually.
<!--l. 37--><p class="indent" >   When you start T<sub>E</sub>Xworks for the first time, it creates a folder named <span class="path">TeXworks</span><a 
 id="dx7-5002"></a><a 
 id="dx7-5003"></a> in your home
folder<span class="footnote-mark"><a 
href="index8.html#fn1x3"><sup class="textsuperscript">1</sup></a></span><a 
 id="x7-5004f1"></a>. This
folder will contain some sub-folders for auto-completion<a 
 id="dx7-5005"></a>, configuration<a 
 id="dx7-5006"></a>, dictionaries<a 
 id="dx7-5007"></a>,
templates<a 
 id="dx7-5008"></a>, and interface translation/localisation<a 
 id="dx7-5009"></a> files&#8212;we will see these in more detail
later.<span class="footnote-mark"><a 
href="index9.html#fn2x3"><sup class="textsuperscript">2</sup></a></span><a 
 id="x7-5010f2"></a>
<!--l. 40--><p class="indent" >   NB. At the time of writing, if <span class="path">&#x003C;your&#x00A0;name&#x003E;</span> contains any non-ASCII
characters (for example accented characters), some functions of T<sub>E</sub>Xworks may not work
correctly. For example, the spell-checker and forward/reverse synchronization
between the source and <span class="path">.pdf</span> will be impaired.
   <h3 class="sectionHead"><span class="titlemark">2.2   </span> <a 
 id="x7-60002.2"></a>Under Linux</h3>
<a 
 id="dx7-6001"></a>
<!--l. 44--><p class="noindent" >Several common Linux distributions already have packages for T<sub>E</sub>Xworks. They are
adequate for most users and facilitate installing T<sub>E</sub>Xworks considerably.
<!--l. 46--><p class="indent" >   If your Linux distribution does not provide recent, adequate packages, you need
to build T<sub>E</sub>Xworks from source yourself, which is fairly easy on Linux. After the installation
of the T<sub>E</sub>X distribution, go to <a 
href="https://github.com/TeXworks/texworks/wiki/Building" class="url" >https://github.com/TeXworks/texworks/wiki/Building</a>
and follow the instructions suitable for your Linux distributions. Also see section
<a 
href="CompilingTw.html#x50-57000C">C<!--tex4ht:ref: sec.compiling --></a>.
<!--l. 48--><p class="indent" >   Once the program is installed, start T<sub>E</sub>Xworks. The folders <span class="path">.TeXworks</span><a 
 id="dx7-6002"></a> and <span class="path">.config/TUG</span><a 
 id="dx7-6003"></a>
will be created in your home directory.
                                                                          

                                                                          
<!--l. 50--><p class="noindent" >
   <h3 class="sectionHead"><span class="titlemark">2.3   </span> <a 
 id="x7-70002.3"></a>Under Mac OS X</h3>
<a 
 id="dx7-7001"></a>
<!--l. 52--><p class="noindent" >If you want to obtain an &#8220;official&#8221; version, obtain T<sub>E</sub>Xworks by downloading the archive
from the T<sub>E</sub>Xworks web site <a 
href="http://tug.org/texworks/" class="url" >http://tug.org/texworks/</a> after the installation of the T<sub>E</sub>X
distribution.
<!--l. 54--><p class="indent" >   It comes as a standalone <tt>.app</tt> package that does not require any Qt files
installed into <span class="path">/Library/Frameworks</span>, or other libraries into <span class="path">/usr/local/lib</span>. Just
copy the <span class="path">.app</span> anywhere you like and run it.
<!--l. 56--><p class="indent" >   On Mac OS X, the T<sub>E</sub>Xworks resource<a 
 id="dx7-7002"></a> folder will be created in your <span class="path">Library</span> folder
(<span class="path">~/Library/TeXworks/</span>), inside your home directory. Preferences are stored in
<span class="path">~/Library/Preferences/org.tug.TeXworks.plist</span> which you can delete if you ever
suspect it is causing problems.
<!--l. 59--><p class="noindent" >
   <h3 class="sectionHead"><span class="titlemark">2.4   </span> <a 
 id="x7-80002.4"></a>Ready!</h3>
<!--l. 61--><p class="noindent" >Finally, some files may need to be added to the &#8220;personal&#8221; files that T<sub>E</sub>Xworks
creates. As the exact location of these depends on your platform, this
will be referred to as <span class="path">&#x003C;resources&#x003E;</span><a 
 id="dx7-8001"></a> or the <b>T<sub>E</sub>Xworks resource folder</b> throughout
this manual. On Linux, this is <span class="path">~/.TeXworks</span>, on Windows&#x00A0;XP it is
<span class="path">C:\Documents&#x00A0;and&#x00A0;Settings\&#x003C;your&#x00A0;name&#x003E;\TeXworks</span>, on Windows
Vista/7 it is <span class="path">C:\Users\&#x003C;your&#x00A0;name&#x003E;\TeXworks</span>, and on Mac OS X it is
<span class="path">~/Library/TeXworks/</span> by default. The easiest way to locate this folder in recent
versions of T<sub>E</sub>Xworks is to use the <em><b>Help</b></em><span 
class="lmsy-10x-x-120">&#x2192;</span><em><b>Settings and Resources&#x2026;</b></em> menu item. It opens a
dialog which shows you where T<sub>E</sub>Xworks saves its settings and where it looks for
resources.
<!--l. 63--><p class="indent" >   After installation and first run, have a look in the sub-folders of the T<sub>E</sub>Xworks resource
folder and delete any <span class="path">qt_temp.xxxx</span> files; they are temporary files left behind and
could interfere with the normal ones, which are installed in the same folder, later
on.
                                                                          

                                                                          
                                                                          

                                                                          
                                                                          

                                                                          
   <!--l. 5--><div class="crosslinks"><p class="noindent">[<a 
href="Firststeps.html" >next</a>] [<a 
href="Introduction.html" >prev</a>] [<a 
href="Introduction.html#tailIntroduction.html" >prev-tail</a>] [<a 
href="Installation.html" >front</a>] [<a 
href="index.html#Installation.html" >up</a>] </p></div>
<!--l. 5--><p class="indent" >   <a 
 id="tailInstallation.html"></a>  </div> 
</body></html>