3
<TITLE>Artistic Style - Install Information</TITLE>
4
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
5
<meta name="CREATED" content="19981123;1064600">
6
<meta name="CHANGEDBY" content="Jim Pattee">
7
<meta name="CHANGED" content="19981123;1091900">
8
<meta name="GENERATOR" content="Microsoft FrontPage 6.0">
9
<style> <!-- h1 {color:#0000A0; text-align:center; font-style:italic; font-size:200%;}
21
<h1>Artistic Style Install Information</h1>
23
<p align="center"><a href="#_Artistic_Style_Versions">Artistic Style Versions</a><br>
24
<a href="#_Linux_Version">Linux Version</a><br>
25
<a href="#_Mac_OS_X_Version">Mac OS X Version</a><br>
26
<a href="#_OpenVMS_Version">OpenVMS Version</a><br>
27
<a href="#_Windows_Version">Windows Version</a><br>
28
<a href="#_Compiler_Options">Compiler Options</a></p>
32
<h2><a name="_Artistic_Style_Versions"></a>Artistic Style Versions</h2>
34
<p>astyle_x.y_linux.tar.gz is the <b>Linux</b> version of Artistic Style. It
35
contains the source code, documentation, and makefiles. The Linux
36
Version compile instructions below give information compiling the source
37
code. The Linux shell will allow the use of
38
wildcards (such as *.cpp) during execution.</p>
39
<p>astyle_x.y_macosx.tar.gz is the <b>Mac OS X</b> version of Artistic Style. It
40
contains the source code, documentation, and a makefile. The Mac OS
41
X Version compile instructions below give information compiling
42
the source code. The Mac shell will allow the use of
43
wildcards (such as *.cpp) during execution.</p>
44
<p>astyle_x.y_openvms.zip is the <b>OpenVMS</b> version of Artistic
45
Style. It contains the source code, documentation, object files, build
46
files, and an executable. The OpenVMS Version compile instructions
47
below give information compiling the source code. Object code is included for people that don't
48
have the Hewlett-Packard C++ compiler.
49
Wildcards are not supported under Digital
50
Command Language (DCL). If the Bash shell has been installed on
51
VMS, wildcards (such as *.cpp) can be used if Artistic Style is run under Bash.</p>
52
<p>astyle_x.y_windows.zip is the <b>Windows</b> version of Artistic
53
Style. It contains the source code, documentation, a Visual C project
54
file, and an executable. The Windows Version compile instructions
55
below give information compiling the source code. The pre-compiled
56
executable has been compiled to allow the use
57
of wildcards (such as *.cpp) during execution.</p>
58
<p>Only one platform is supported in each distribution package. If you
59
use Artistic Style on more than one platform you
60
will need to download packages for each platform.
61
The main difference in platforms is the build directory and the
62
line endings. Most compilers and development packages will accept any
63
type of line ending.</p>
66
<h2><a name="_Linux_Version"></a>Linux Version</h2>
68
<h3><a name="_GCC_Compiler"></a>GCC Compiler</h3>
69
<p>To compile using the GCC compiler you must have GCC (3.1 or better) installed.
70
To build the Artistic Style configurations use the makefile located in the astyle/build
71
directory. The executables will be in the astyle/bin directory.
72
To build the command line configuration enter the following:</p>
75
<p>To build the other astyle configurations you can enter the file name or a
76
symbolic name. Entering "make astyle" or "make release" will build the command line configuration. Following are the symbolic
77
names and file names (in parens) of the various configurations:</p>
79
<li><b>release</b> builds the Artistic Style command line program
80
(astyle). This is the default option.</li>
81
<li><b>shared</b> builds the Artistic Style program as a
82
shared library (libastyle.so).</li>
83
<li><b>static</b> builds the Artistic Style program as a static
84
library (libastyle.a).</li>
85
<li><b>debug</b> builds the Artistic Style command line program with
86
debugging information (astyled).</li>
87
<li><b>shareddebug</b> builds the Artistic Style program as a shared
88
library with debugging information (libastyled.so).</li>
89
<li><b>staticdebug</b> builds the Artistic Style program as a static
90
library with debugging information (libastyled.a).</li>
91
<li><b>all</b> builds all of the above configurations.</li>
93
<p>More than one configuration can be built at the same time.
94
For example, to build all of the release configurations enter:</p>
96
make release shared static</pre>
97
<h3><a name="_Intel_Compiler"></a>Intel Compiler</h3>
98
<p>The Intel makefile is named <b>makeintel.</b>
99
To build astyle, use the makeintel file located in the astyle/build
100
directory. The executables will be in the astyle/bin directory.
101
To build the command line configuration enter the following:</p>
102
<pre> cd astyle/build
103
make -f makeintel</pre>
104
<p>Another way to compile with Intel is to rename "makeintel" as "makefile". Then the -f option is not needed.
105
If this is done the Intel makefile will always be used instead of the GCC makefile.
107
<p>The configuration names for Intel are the same as for the
108
<a href="#_GCC_Compiler">GCC compiler</a>.
109
More than one configuration can be built at the same time.
110
For example, to build all of the debug configurations enter:</p>
111
<pre> cd astyle/build
112
make -f makeintel debug shareddebug staticdebug</pre>
114
<h3><a name="_Other_Makefile_Options"></a>Other Makefile Options</h3>
115
<p>The following options are also available. If you are using the Intel
116
compiler, the make filename option must be included in the command (-f
119
<p>To remove the object files for all configurations:</p>
120
<pre> make clean</pre>
121
<p>The executables will not be removed.</p>
123
<p>You must have the appropriate permissions to use install. To install the
124
astyle executable to /usr/bin:</p>
125
<pre> make install</pre>
126
<p>To install the executable to a different directory set a value
127
for the macro $(prefix). For example to install the executable to a users
128
home directory (/home/<i>user</i>/bin):</p>
129
<pre> make prefix=$HOME/bin install</pre>
131
<p>You must have the appropriate permissions to use uninstall. To uninstall the
132
astyle executable from /usr/bin:</p>
133
<pre> make uninstall</pre>
134
<p>To uninstall the executable from a different directory set a
135
value for the macro $(prefix). For example to uninstall the executable
136
from a users home directory (/home/<i>user</i>/bin):</p>
137
<pre> make prefix=$HOME/bin uninstall</pre>
138
<p>NOTE: The uninstall option will NOT remove the .astylerc
139
files from the users home directories. The files must be
140
removed individually for each user.</p>
143
<h2><a name="_Mac_OS_X_Version"></a>Mac OS X Version</h2>
145
<p>Mac OS X uses the same makefile as Linux GCC. To build the Artistic
146
Style configurations use the makefile located in the astyle/build
147
directory. The executables will be in the astyle/bin directory.
148
To build the command line configuration enter the following:</p>
149
<pre> cd astyle/build
152
<p>The configurations for Mac are the same as for the
153
<a href="#_GCC_Compiler">Linux GCC compiler</a>.
154
More than one configuration can be built at the same time.
155
For example, to build all of the release configurations enter:</p>
156
<pre> cd astyle/build
157
make release shared static</pre>
161
<h2><a name="_OpenVMS_Version"></a>OpenVMS Version</h2>
163
<p>To build Artistic Style on an OpenVMS system, you will need
164
Hewlett-Packard 's C++
165
compiler installed. To build the code, use the OpenVMS
166
specific build file located in the astyle/build directory. The executables
167
will be in the astyle/bin directory. To build, enter the following:</p>
168
<pre> set def [.astyle.build]
170
<p>To run Artistic Style, you should move the executable to an appropriate
171
directory, and create a foreign symbol for it. For example:</p>
172
<pre> create/dir my_disk:[astyle.exe]
174
copy astyle_main.exe my_disk:[astyle.exe]
175
ast*yle :== $my_disk:[astyle.exe]astyle_main.exe</pre>
176
<p>If you use Artistic Style on ODS-2 disks, you will need to specify a
177
different suffix for file renaming, as the default is .orig, and multi-dot
178
filenames are not supported on ODS-2 disks. Add the --suffix=_orig switch
179
to either the command line or your Artistic Style initialization file.</p>
180
<p>To set up an initialization file on OpenVMS, create a file and define a
181
logical to point to it. For example:</p>
182
<pre> create my_disk:[astyle]astyle.ini
185
define artistic_style_options my_disk:[astyle]astyle.ini</pre>
188
<h2><a name="_Windows_Version"></a></a>Windows Version</h2>
190
<h3><a name="_Precompiled_Executable"></a>Precompiled Executable</h3>
192
<p>In addition to the source files, the Windows version contains an astyle executable (AStyle.exe).
193
The executable is compiled to allow wildcard use during execution.</p>
195
<h3><a name="_Visual_C++_Compiler"></a>Visual C++ Compiler</h3>
197
<p>There is a project file for Visual C++ 2003 (version 7) or higher.
198
Open the file AStyle.sln in the AStyle/build directory. Select the
199
Release configuration to compile the command line version. All
200
output files will be in the AStyle/bin directory. The
201
project has the following configurations.</p>
203
<li><b>Release</b> builds the Artistic Style command line program
204
(AStyle.exe). </li>
205
<li><b>Release Dll</b> builds the Artistic Style program as a Dynamic Link
206
Library (AStyle.dll). This will also produce the exports
207
library and the static library for linking the dll.</li>
208
<li><b>Release Lib</b> builds the Artistic Style program as a Static
209
Library (libAStyle.lib).</li>
210
<li><b>Debug</b> builds the Artistic Style command line program with
211
debugging information (AStyled.exe).</li>
212
<li><b>Debug Dll</b> builds the Artistic Style program as a Dynamic Link
213
Library (DLL) with debugging information (AStyled.dll). This
214
will also produce the exports library and the static library for
215
linking the dll.</li>
216
<li><b>Debug Lib</b> builds the Artistic Style program as a Static
217
Library with debugging information (libAStyled.lib).</li>
220
<h3><a name="_Other_Compilers"></a>Other Compilers</h3>
222
<p>To use other compilers a project file must be built using the
223
compiler's development environment.</p>
225
<li>Create a project using the compiler's development environment</li>
226
<li>Add to the project all the .cpp and .h files in the src directory.</li>
227
<li>In order to use wildcards (such as *.cpp) during execution:<br>
228
With Visual C++, insert "setargv.obj" to the list of linker additional dependencies.<br>
229
With the MinGW build of the GCC compiler, the use of wildcards is automatic.<br>
230
With Borland, add "wildargs.obj" to the list of linker object files.<br>
231
With other compilers I don't know of a way to allow wildcards. I would appreciate the information if
233
<li>The Compiler Options section discusses the compiler options to use.</li>
238
<h2><a name="_Compiler_Options"></a>Compiler Options</h2>
240
<p>To compile as a static or shared (dynamic) library define the macro ASTYLE_LIB.
241
Then use the appropriate compiler and linker options to compile the
242
static or shared library.</p>
243
<p> Artistic Style is a small program and it is best to optimize for
244
speed. The debug configuration is not usually optimized. To optimize for speed in the release configuration use the macro NDEBUG to remove asserts. Use an option that allows inline function
246
Runtime Type Information (RTTI) is NOT needed. Use whole program
247
speed optimization if your compiler supports it. There may be other options
248
you can use depending on the compiler.</p>
b'\\ No newline at end of file'
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml">
6
<title>Artistic Style - Install Information</title>
7
<meta http-equiv="Content-Language" content="en-us" />
8
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
9
<link href="styles.css" rel="stylesheet" type="text/css" />
13
<h1>Artistic Style Install Information</h1>
17
<h3 id="Contents">Contents</h3>
19
<p class="contents1"><a class="contents" href="#_Artistic_Style_Versions">Artistic Style Versions</a></p>
21
<p class="contents1"><a class="contents" href="#_Linux_Version">Linux Version</a></p>
23
<p class="contents2"><a class="contents" href="#_GCC_Compiler">GCC Compiler</a></p>
25
<p class="contents2"><a class="contents" href="#_Intel_Compiler">Intel Compiler</a></p>
27
<p class="contents2"><a class="contents" href="#_Other_Makefile_Options">Other Makefile Options</a></p>
29
<p class="contents1"><a class="contents" href="#_Mac_OS_X_Version">Mac OS X Version</a></p>
31
<p class="contents1"><a class="contents" href="#_OpenVMS_Version">OpenVMS Version</a></p>
33
<p class="contents1"><a class="contents" href="#_Windows_Version">Windows Version</a></p>
35
<p class="contents2"><a class="contents" href="#_Precompiled_Executable">Precompiled Executable</a></p>
37
<p class="contents2"><a class="contents" href="#_Visual_C++_Compiler">Visual C++ Compiler</a></p>
39
<p class="contents2"><a class="contents" href="#_Other_Compilers">Other Compilers</a></p>
41
<p class="contents1"><a class="contents" href="#_Compiler_Options">Compiler Options</a></p>
43
<h3 id="_Artistic_Style_Versions">Artistic Style Versions</h3>
45
<p>astyle_x.y_linux.tar.gz is the <b>Linux</b> version of Artistic Style. It
46
contains the source code, documentation, and makefiles. The Linux Version compile instructions
47
below give information for compiling the source code.</p>
49
<p>astyle_x.y_macosx.tar.gz is the <b>Mac OS X</b> version of Artistic Style.
50
It contains the source code, documentation, and a makefile. The Mac OS X Version compile
51
instructions below give information for compiling the source code.</p>
54
astyle_x_y_openvms.zip is the <b>OpenVMS</b> version of Artistic Style. It
55
contains the source code, documentation, object files, build files, and executables. The
56
OpenVMS Version compile instructions below give information for compiling the source code.
57
Object code is included for people that don't have the Hewlett-Packard C++ compiler.</p>
59
<p>astyle_x.y_windows.zip is the <b>Windows</b> version of Artistic Style. It
60
contains the source code, documentation, Visual C project files, and an executable. The Windows
61
Version compile instructions below give information for compiling the source code.</p>
63
<p>Only one platform is supported in each distribution package. If you use
64
Artistic Style on more than one platform you will need to download packages for each platform.
65
The main difference in platforms is the build directories and the line endings. Most compilers
66
and development packages will accept any type of line ending. The source code and documentation
67
are the same for all distributions.</p>
69
<h3 id="_Linux_Version">Linux Version</h3>
71
<h4 id="_GCC_Compiler">GCC Compiler</h4>
73
<p>To compile using the GCC compiler you must have GCC (3.1 or better) installed. To build the
74
Artistic Style configurations use the makefile located in the astyle/buildgcc directory. The
75
executables will be in the astyle/bin directory. To build the command line configuration enter
77
<pre> cd astyle/buildgcc<br /> make
80
<p>To build the other astyle configurations you can enter the file name or a symbolic name.
81
Entering "make astyle" or "make release" will build the command line configuration. Following
82
are the symbolic names and file names (in parens) of the various configurations:</p>
85
<li><b>release</b> builds the Artistic Style command line program (astyle). This is the
88
<li><b>shared</b> builds the Artistic Style program as a shared library
91
<li><b>static</b> builds the Artistic Style program as a static library (libastyle.a).</li>
93
<li><b>debug</b> builds the Artistic Style command line program with debugging information
96
<li><b>shareddebug</b> builds the Artistic Style program as a shared library with debugging
97
information (libastyled.so).</li>
99
<li><b>staticdebug</b> builds the Artistic Style program as a static library with debugging
100
information (libastyled.a).</li>
103
<b>all</b> builds all of the above configurations.
105
<p>The following Java shared library builds are separate from the above. They include
106
the Java Native Interface (JNI) and require that the Java Development Kit (JDK) be
107
installed. The environment variable JAVA_HOME should be defined. It defines the install
108
directory for the JDK. The makefile also has default install directories for Java 5 and
109
6. If the compile cannot find the file jni.h, either set the variable or change the
110
value in the makefile.</p>
113
<li><b>java</b> builds the Artistic Style program as a shared library which includes the
114
Java Native Interface (libastylej.so).</li>
116
<li><b>javadebug</b> builds the Artistic Style program as a shared library which includes
117
the Java Native Interface and debugging information (libastylejd.so).</li>
119
<li><span style="font-weight: bold;">javaall</span> builds all of the above java
123
<p>More than one configuration can be built at the same time. For example, to build all of the
124
release configurations enter:</p>
125
<pre> cd astyle/build<br /> make release shared static
128
<h4 id="_Intel_Compiler">Intel Compiler</h4>
130
<p>To build the Artistic Style configurations use the makefile located in the astyle/buildintel
131
directory. The executables will be in the astyle/bin directory. To build the command line
132
configuration enter the following:</p>
133
<pre> cd astyle/buildintel<br /> make
136
<p>To build the other astyle configurations you can enter the file name or a symbolic name. The
137
configuration names for Intel are the same as for the <a href="#_GCC_Compiler">GCC
138
compiler</a>. More than one configuration can be built at the same time. For example, to build
139
all of the debug configurations enter:</p>
140
<pre> cd astyle/buildintel<br /> make debug shareddebug staticdebug
143
<h4 id="_Other_Makefile_Options">Other Makefile Options</h4>
145
<p>The following makefile options are also available for GCC and Intel.</p>
149
<p>Removes the object and executable files for all configurations.</p>
151
<p>To remove the files for all configurations:</p>
157
<p>Removes the object files for all configurations. The executables will not be removed.</p>
159
<p>To remove only the object files for all configurations:</p>
165
<p>Installs the executable. The default is /usr/bin. You must have the appropriate permissions
168
<p>To install the astyle executable to /usr/bin:</p>
172
<p>To install the executable to a different bin directory set a value for the macro $(prefix).
173
For example to install the executable to a users home directory (/home/<i>user</i>/bin):</p>
174
<pre> make prefix=$HOME install
179
<p>Uninstalls the executable. The default is /usr/bin.</p>
181
<p>You must have the appropriate permissions to use uninstall. To uninstall the astyle
182
executable from /usr/bin:</p>
186
<p>To uninstall the executable from a different "bin" directory set a value for the macro
187
$(prefix). For example to uninstall the executable from a users home directory
188
(/home/<i>user</i>/bin):</p>
189
<pre> make prefix=$HOME uninstall
192
<p>NOTE: The uninstall option will NOT remove the .astylerc files from the users home
193
directories. The files must be removed individually for each user.</p>
195
<h3 id="_Mac_OS_X_Version">Mac OS X Version</h3>
197
<p>To build the Artistic Style configurations use the makefile located in the astyle/buildmac
198
directory. The executables will be in the astyle/bin directory. To build the command line
199
configuration enter the following:</p>
200
<pre> cd astyle/buildmac<br /> make
203
<p>To build the other astyle configurations you can enter the file name or a symbolic name. The
204
configurations for Mac are the same as for the <a href="#_GCC_Compiler">Linux GCC compiler</a>.
205
More than one configuration can be built at the same time. For example, to build all of the
206
release configurations enter:</p>
207
<pre> cd astyle/buildmac<br /> make release shared static
210
<p>The <a href="#_Other_Makefile_Options">Other Makefile Options</a> are the same as for the
213
<h3 id="_OpenVMS_Version">OpenVMS Version</h3>
215
<p>To build Artistic Style on an OpenVMS system, you will need Hewlett-Packard's C++ compiler
216
installed. To build the code, use the OpenVMS specific build file located in the
217
astyle/build/vms directory. The executables will be in the astyle/bin directory. To build the
218
standalone executable, enter the following:</p>
219
<pre> set def [.astyle.build.vms]<br /> @vmsbuild
222
<p>To run Artistic Style, you should move the standalone executable to an appropriate
223
directory, and create a foreign symbol for it. For example:</p>
224
<pre> create/dir my_disk:[astyle.exe]<br /> set def [--.bin]<br /> copy astyle_main.exe my_disk:[astyle.exe]<br /> ast*yle :== $my_disk:[astyle.exe]astyle_main.exe
227
<p>The build command procedure also includes a method to build a sharable image version of the
228
program, which can be linked and called from other executable modules.</p>
230
<p>Additionally, if you have a Java Development Kit installed, you can build a Java Native
231
Interface version of the program, which can be called from Java code.</p>
233
<p>To build either of these versions, please see the comments located at the end of the
234
VMSBUILD.COM command procedure.</p>
236
<p>If you use Artistic Style on ODS-2 disks, you will need to specify a different suffix for
237
file renaming, as the default is .orig, and multi-dot filenames are not supported on ODS-2
238
disks. Add the --suffix=_orig switch to either the command line or your Artistic Style
239
initialization file.</p>
241
<p>To set up an initialization file on OpenVMS, create a file and define a logical to point to
243
<pre> create my_disk:[astyle]astyle.ini<br /> --suffix=_orig<br /> ^Z<br /> define artistic_style_options my_disk:[astyle]astyle.ini
246
<h3 id="_Windows_Version">Windows Version</h3>
248
<h4 id="_Precompiled_Executable">Precompiled Executable</h4>
250
<p>In addition to the source files, the Windows version contains an astyle executable
253
<h4 id="_Visual_C++_Compiler">Visual C++ Compiler</h4>
255
<p>There is a project file for 3 versions of the Visual C compiler; build/vs2003 (Visual Studio
256
2003), build/vs2005 (Visual Studio 2005), and build/vs2008 (Visual Studio 2008). Open the AStyle project
257
file in the appropriate AStyle/build directory. Select the Release configuration to compile
258
the command line version. All output files will be in the AStyle/bin directory. The project has
259
the following configurations.</p>
262
<li><b>Release</b> builds the Artistic Style command line program (AStyle.exe).</li>
263
<li><strong>Release Static</strong> builds the Artistic Style command line program (AStyle.exe).
264
This is the same as the Release build except that it links wth the static run-time
265
library instead of the dll. This build must be used if the program is to execute
266
on a machine that does not have Visual Studio installed.</li>
268
<li><b>Release Dll</b> builds the Artistic Style program as a Dynamic Link Library
269
(AStyle.dll). This will also produce the exports library and the static library for linking
272
<li><b>Release Lib</b> builds the Artistic Style program as a Static Library (AStyleLib.lib).
275
<li><b>Debug</b> builds the Artistic Style command line program with debugging information
278
<li><b>Debug Dll</b> builds the Artistic Style program as a Dynamic Link Library with
279
debugging information (AStyled.dll). This will also produce the exports library and the
280
static library for linking the dll.</li>
283
<b>Debug Lib</b> builds the Artistic Style program as a Static Library with debugging
284
information (AStyleLibd.lib).
286
<p>The following Java shared library builds include the Java Native Interface (JNI) and
287
require that the Java Development Kit (JDK) be installed. The Project Properties must
288
have an include path to the JDK include and include\win32 directories. This is set in
289
Project > Properties > C/C++ > General >
290
Additional Include Directories. The default setting is for the JDK to be
291
installed in the default directory, but it may not be the most current release.</p>
294
<li><b>Release Java</b> builds the Artistic Style program as a Dynamic Link Library which
295
includes the Java Native Interface (AStylej.dll).</li>
297
<li><b>Debug Java</b> builds the Artistic Style program as a Dynamic Link Library which
298
includes the Java Native Interface and debugging information (AStylejd.dll).</li>
301
<h4 id="_Other_Compilers">Other Compilers</h4>
303
<p>To use other compilers a project file must be built using the compiler's development
307
<li>Create a project using the compiler's development environment</li>
309
<li>Add to the project all the .cpp and .h files in the src directory.</li>
311
<li>The Compiler Options section discusses the compiler options to use.</li>
316
<h3 id="_Compiler_Options">Compiler Options</h3>
318
<p>To compile as a static or shared (dynamic) library define the macro ASTYLE_LIB. To compile a
319
Java shared (dynamic) library define the macro ASTYLE_JNI. Then use the appropriate compiler
320
and linker options to compile the static or shared library.</p>
322
<p>Artistic Style is a small program and it is best to optimize for speed. The debug
323
configuration is not usually optimized. To optimize for speed in the release configurations use
324
the macro NDEBUG to remove asserts. Use an option that allows inline function expansion.
325
Runtime Type Information (RTTI) is NOT needed. Use whole program optimization if your compiler
326
supports it. There may be other options you can use depending on the compiler.</p>
330
<center style="margin-left:-0.4in;">
331
<a href="http://sourceforge.net/projects/astyle"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=2319&type=16"
332
width="150" height="40" alt="[SourceForge.net Logo]" /></a>
added
removed
src/plugins/astyle/astyle/install.html
