File: installation.html

package info (click to toggle)
roxterm 2.6.5-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 2,420 kB
  • sloc: ansic: 16,345; python: 2,263; sh: 124; makefile: 44; xml: 14
file content (169 lines) | stat: -rw-r--r-- 7,688 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
	<meta name="author" content="Adrian Sampson" />
	<meta name="description" content="ROXTerm, a full-featured VTE terminal emulator" />
	<title>ROXTerm</title>
	<link rel="stylesheet" type="text/css" href="../lib/roxterm.css" />
	<!--[if lte IE 7]>
	<link rel="stylesheet" type="text/css" href="../lib/roxterm_ie.css" />
	<![endif]-->
	<link rel="shortcut icon" type="image/x-icon" href="../lib/favicon.ico" />
</head>
<body>
	<div id="Container">
		<div id="Header">
			<div>
				<a id="Logo" href="index.html">
					<img src="../lib/logo_text.png" alt="ROXTerm" />
				</a>

				<ul>
					<li><a id="MainNav_Home" href="index.html">Home</a></li>
					<li><a id="MainNav_News" href="news.html">News</a></li>
					<li><a id="MainNav_Installation" class="active" href="#">Installation</a></li>
					<li><a id="MainNav_UserGuide" href="guide.html">User Guide</a></li>
					<li><a id="MainNav_Forums" href="https://sourceforge.net/projects/roxterm/forums">Forums</a></li>
				</ul>
			</div>
			<!-- PHP PLACEHOLDER -->
		</div>
		
		<div id="Middle" class="clear">
			<ol id="SubNav">
				<li><a href="#Download">Download</a></li>
				<li><a href="#Requirements">Requirements</a></li>
				<li><a href="#Installing">Installing</a></li>
			</ol>

			<div id="Content" class="partialWidth">
				<h1>Installation</h1>

				
				<h2>Download <a class="pageAnchor" name="Download">:</a></h2>

				<p>Visit the <a href="http://sourceforge.net/projects/roxterm">SourceForge project page</a> to download release
				files or use other Sourceforge tools. If you want to get developmental versions ahead of releases, use git.
				For versions prior to 1.19.0 use svn (subversion). The actual command you will probably want to use to check out a
				snapshot is:</p>

				<p class="snippet">
					<span>git clone git://roxterm.git.sourceforge.net/gitroot/roxterm/roxterm</span>
				</p>

				<h2>Requirements <a class="pageAnchor" name="Requirements">:</a></h2>

				<p>You need the libraries for GTK+2 which is pretty much
				standard on all free Unix derivatives these days, and/or GTK+3.
				It needs at least version 2.16 of glib and GTK+ 2.18. You will
				also need vte/libvte (at least version 0.20), a Gnome component;
				most distros package separate versions for GTK+2 and GTK+3.
				D-BUS is also required (see below).</p>

				<p>To compile ROXTerm you will need the header files for the
				above libraries. In packaging systems they usually come in
				packages whose names end in "-dev" or "-devel".</p>

				<p>ROXTerm uses a new, bespoke build system called maitch. This
				requires python and the python 'lockfile' module.</p>

                <h3>D-Bus</h3>

				<p>D-Bus is a messaging system which ROXTerm uses to connect terminals with its configure tool. ROXTerm uses the
				"session" bus, which should be started along with your desktop environment. Current versions of ROX, GNOME and KDE
				session managers all launch D-Bus. If you use some other session/desktop/window manager which doesn't launch D-Bus
				you can start it by inserting something like this near the start of your .xinitrc or .xsession:</p>

				<p class="snippet">
					<span>if test -z "$DBUS_SESSION_BUS_ADDRESS" ; then</span>
					<span class="indented">eval `dbus-launch --sh-syntax --exit-with-session`</span>
					<span class="indented">export DBUS_SESSION_BUS_ADDRESS</span>
					<span>fi</span>
				</p>

				<p>The reason for using a bespoke configuration messaging system over D-Bus instead of gconf is because gconf
				doesn't provide a way to map an arbitrary number of profiles onto configuration filenames.</p>

				<h2>Installing <a class="pageAnchor" name="Installing">:</a></h2>

				<p>To install ROXTerm for ROX all you need to do is unpack the
				tarball in your Apps directory and run it from there, but you
				will probably want to rename the folder to ROXTerm. For other
				systems ROXTerm may be installed in a similar way to an
				autoconf-based source package, but using maitch's analogues:</p>

				<p class="snippet">
					<span>python ./mscript.py configure</span>
					<span>python ./mscript.py build</span>
					<span>python ./mscript.py install</span>
				</p>
				
				<p>Various options are available, run 
				<p class="snippet">
					<span>python ./mscript.py help</span>
				</p>
				for details.</p>

				<p>Autoconf builds are no longer supported.</p>

				<h3>Debian &amp; Ubuntu</h3>

				<p>Up-to-date official Debian packages are now available. See <a
				href="http://packages.debian.org/roxterm">http://packages.debian.org/roxterm</a>.</p>
				
				<p>Ubuntu also has official roxterm packages, but due to
				Ubuntu's release cycle these may lag behind the latest upstream
				releases. Therefore I have set up a
				<a href="https://launchpad.net/~h-realh/+archive/roxterm">PPA</a>
                to provide the most recent releases of ROXTerm for Ubuntu's
                current release when appropriate.</p>
				
				<p>For those that want to build their own debian packages, the debian packaging files are no
				longer included in release tarballs, but they are included in git's master branch.
				<a href="Download">See above</a> for details of how to fetch roxterm from git.</p>
				
				<p>If you want to build a particular version:</p>
				<p><code>git checkout</code> <i>version</i></p>
				
				<p>For older distros which do not include packages of GTK3 etc:</p>
				<p><code>git fetch origin lucid:lucid<br/>
				git checkout lucid</code></p>
				
				<p>You can use <code>sudo apt-get build-dep</code> at this point, but depending on the version
				already in your distro the set of packages may be out-of-date, so be prepared for dependency
				errors later and install the necessary packages at that point. You should install imagemagick
				and librsvg2-bin at this point, but these are bugged in Ubuntu Lucid (and earlier?), so before
				building you will have to copy these files from <code>Help/lib</code> in a tarball:
				<code>roxterm_logo.png favicon.ico logo_text.png</code>.</p>
				
			    <p>If not using a release snapshot it's a good idead to use <code>dch</code> to ensure the
			    newest version number in <code>debian/changelog</code> has an appropriate version number eg
			    what <code>./mscript.py configure</code> generates in the file <code>version</code>, based on
			    the output of <code>git describe</code>. Now you can build the packages eg with
			    <code>debuild -b -uc -us</code>. Note the <code>-b</code>:- only binary packages can be
			    built in the absence of an orig tarball.</p>

            </div>
        </div>

		<div id="Footer">
			<div id="FooterButtons">
				<a id="SourceforgeLink" href="http://sourceforge.net/projects/roxterm" title="RoxTerm Sourceforge">
					<img src="http://sflogo.sourceforge.net/sflogo.php?group_id=124080&amp;type=8" width="80" height="15" 
					alt="Get RoxTerm at SourceForge.net. Fast, secure and Free Open Source software downloads" />
				</a>
				
				<br />
				
				<a id="DonationLink" class="spriteLink"  href="http://sourceforge.net/donate/index.php?group_id=124080">Donate</a>
				<a id="ValidMarkupLink" class="spriteLink" href="http://validator.w3.org/check?uri=referer">Valid XHTML</a>
			</div>

			<p>ROXTerm is licensed under the <a href="http://www.gnu.org/licenses/gpl-3.0-standalone.html">GPL</a> |
			Site design by Adrian Sampson</p>
		</div>
	</div>
</body>
</html>