Keyur Hariya / Mbed OS MAX_IOT_KIT

Maxim Integrated's IoT development kit

Dependencies:   MAX30101 MAX30003 MAX113XX_Pixi MAX30205 max32630fthr USBDevice

tools/AStyle_3.0.1_windows/doc/install.html@1:efe9cad8942f, 2018-03-13 (annotated)

Committer:
Mahir Ozturk
Date:
Tue Mar 13 14:52:59 2018 +0300
Revision:
1:efe9cad8942f
Commit project files



Change-Id: I2188228f2a27e9a13e2407846e48b38c2596caa0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mahir Ozturk 1:efe9cad8942f 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
Mahir Ozturk 1:efe9cad8942f 2
Mahir Ozturk 1:efe9cad8942f 3 <html lang="en" xmlns="http://www.w3.org/1999/xhtml">
Mahir Ozturk 1:efe9cad8942f 4
Mahir Ozturk 1:efe9cad8942f 5 <head>
Mahir Ozturk 1:efe9cad8942f 6 <title>Artistic Style - Install Information</title>
Mahir Ozturk 1:efe9cad8942f 7 <meta http-equiv="Content-Language" content="en-us" />
Mahir Ozturk 1:efe9cad8942f 8 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
Mahir Ozturk 1:efe9cad8942f 9 <link href="favicon.ico" rel="shortcut icon" type="image/x-icon" />
Mahir Ozturk 1:efe9cad8942f 10 <link href="styles.css" rel="stylesheet" type="text/css" />
Mahir Ozturk 1:efe9cad8942f 11 </head>
Mahir Ozturk 1:efe9cad8942f 12
Mahir Ozturk 1:efe9cad8942f 13 <body>
Mahir Ozturk 1:efe9cad8942f 14
Mahir Ozturk 1:efe9cad8942f 15 <h1>Artistic Style Install Information</h1>
Mahir Ozturk 1:efe9cad8942f 16
Mahir Ozturk 1:efe9cad8942f 17 <p>
Mahir Ozturk 1:efe9cad8942f 18 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 19
Mahir Ozturk 1:efe9cad8942f 20 <h3 id="Contents">Contents</h3>
Mahir Ozturk 1:efe9cad8942f 21
Mahir Ozturk 1:efe9cad8942f 22 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 23 <a class="contents" href="#_Artistic_Style_Versions">Artistic Style Versions</a></p>
Mahir Ozturk 1:efe9cad8942f 24 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 25 <a class="contents" href="#_Linux_Version">Linux Version</a></p>
Mahir Ozturk 1:efe9cad8942f 26 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 27 <a class="contents" href="#_CodeBlocks_Linux">CodeBlocks Linux</a></p>
Mahir Ozturk 1:efe9cad8942f 28 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 29 <a class="contents" href="#_GCC_Makefile">GCC Makefile</a></p>
Mahir Ozturk 1:efe9cad8942f 30 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 31 <a class="contents" href="#_Clang_Makefile">Clang Makefile</a></p>
Mahir Ozturk 1:efe9cad8942f 32 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 33 <a class="contents" href="#_Intel_Makefile">Intel Makefile</a></p>
Mahir Ozturk 1:efe9cad8942f 34 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 35 <a class="contents" href="#_Other_Makefile_Targets">Other Makefile Targets</a></p>
Mahir Ozturk 1:efe9cad8942f 36 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 37 <a class="contents" href="#_MacOS_Version">MacOS Version</a></p>
Mahir Ozturk 1:efe9cad8942f 38 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 39 <a class="contents" href="#_Xcode">Xcode</a></p>
Mahir Ozturk 1:efe9cad8942f 40 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 41 <a class="contents" href="#_MacOS_Makefile">MacOS Makefile</a></p>
Mahir Ozturk 1:efe9cad8942f 42 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 43 <a class="contents" href="#_Windows_Version">Windows Version</a></p>
Mahir Ozturk 1:efe9cad8942f 44 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 45 <a class="contents" href="#_Precompiled_Executable">Precompiled Executable</a></p>
Mahir Ozturk 1:efe9cad8942f 46 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 47 <a class="contents" href="#_CodeBlocks_Windows">CodeBlocks Windows</a></p>
Mahir Ozturk 1:efe9cad8942f 48 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 49 <a class="contents" href="#_Visual_Studio">Visual Studio</a></p>
Mahir Ozturk 1:efe9cad8942f 50 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 51 <a class="contents" href="#_Other_Development_Environments">Other Development Environments</a></p>
Mahir Ozturk 1:efe9cad8942f 52 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 53 <a class="contents" href="#_Compiler_Options">Compiler Options</a></p>
Mahir Ozturk 1:efe9cad8942f 54
Mahir Ozturk 1:efe9cad8942f 55 <h3 id="_Artistic_Style_Versions">Artistic Style Versions</h3>
Mahir Ozturk 1:efe9cad8942f 56
Mahir Ozturk 1:efe9cad8942f 57 <p>
Mahir Ozturk 1:efe9cad8942f 58 astyle_x.x_linux.tar.gz is the <strong>Linux </strong>version of Artistic Style. It contains the source code,
Mahir Ozturk 1:efe9cad8942f 59 documentation, and makefiles. The Linux Version compile instructions below give information for compiling the
Mahir Ozturk 1:efe9cad8942f 60 source code.</p>
Mahir Ozturk 1:efe9cad8942f 61 <p>
Mahir Ozturk 1:efe9cad8942f 62 astyle_x.x_macos.tar.gz is the <strong>Mac OS </strong>version of Artistic Style. It contains the source code,
Mahir Ozturk 1:efe9cad8942f 63 documentation, Xcode project files, and a makefile. The Mac OS Version compile instructions below give information
Mahir Ozturk 1:efe9cad8942f 64 for compiling the source code.</p>
Mahir Ozturk 1:efe9cad8942f 65 <p>
Mahir Ozturk 1:efe9cad8942f 66 astyle_x.x_windows.zip is the <strong>Windows </strong>version of Artistic Style. It contains the source code,
Mahir Ozturk 1:efe9cad8942f 67 documentation, Visual C project files, and an executable. The Windows Version compile instructions below give
Mahir Ozturk 1:efe9cad8942f 68 information for compiling the source code.</p>
Mahir Ozturk 1:efe9cad8942f 69 <p>
Mahir Ozturk 1:efe9cad8942f 70 Only one platform is supported in each distribution package. If you use Artistic Style on more than one platform
Mahir Ozturk 1:efe9cad8942f 71 you will need to download packages for each platform. The main difference in platforms is the build directories
Mahir Ozturk 1:efe9cad8942f 72 and the line endings. Most compilers and development packages will accept any type of line ending. The source
Mahir Ozturk 1:efe9cad8942f 73 code and documentation are the same for all distributions.</p>
Mahir Ozturk 1:efe9cad8942f 74
Mahir Ozturk 1:efe9cad8942f 75 <h3 id="_Linux_Version">Linux Version</h3>
Mahir Ozturk 1:efe9cad8942f 76
Mahir Ozturk 1:efe9cad8942f 77 <h4 id="_CodeBlocks_Linux">CodeBlocks Linux</h4>
Mahir Ozturk 1:efe9cad8942f 78
Mahir Ozturk 1:efe9cad8942f 79 <p>
Mahir Ozturk 1:efe9cad8942f 80 There are build folders for the following compilers. All compiler folders are in the &quot;build&quot; directory.
Mahir Ozturk 1:efe9cad8942f 81 </p>
Mahir Ozturk 1:efe9cad8942f 82 <ul>
Mahir Ozturk 1:efe9cad8942f 83 <li><strong>cb-clang</strong> contains the workspace and project files for the Linux Clang Compiler.</li>
Mahir Ozturk 1:efe9cad8942f 84 <li><strong>cb-gcc</strong> contains the workspace and project files for the Linux GCC Compiler.</li>
Mahir Ozturk 1:efe9cad8942f 85 <li><strong>cb-intel</strong> contains the workspace and project files for the Linux Intel Compiler.</li>
Mahir Ozturk 1:efe9cad8942f 86 </ul>
Mahir Ozturk 1:efe9cad8942f 87 <p>
Mahir Ozturk 1:efe9cad8942f 88 There are workspace and project files for each folder. All projects have at least Debug and Release
Mahir Ozturk 1:efe9cad8942f 89 configurations. All output will be in the &quot;bin&quot; directory. </p>
Mahir Ozturk 1:efe9cad8942f 90 <p>
Mahir Ozturk 1:efe9cad8942f 91 The workspace contains the following projects.</p>
Mahir Ozturk 1:efe9cad8942f 92 <ul>
Mahir Ozturk 1:efe9cad8942f 93 <li><strong>AStyle </strong>builds the Artistic Style command line program (astyle). </li>
Mahir Ozturk 1:efe9cad8942f 94 <li><strong>AStyle So </strong>builds the Artistic Style program as a shared object (libastyle.so). </li>
Mahir Ozturk 1:efe9cad8942f 95 <li><strong>AStyle Java </strong>builds the Artistic Style program as a shared object (libastylej.so) that can
Mahir Ozturk 1:efe9cad8942f 96 be called from a Java program. The Java Development Kit (JDK) is required for the project to compile. The
Mahir Ozturk 1:efe9cad8942f 97 Project Properties must have an include path to the JDK include directories.</li>
Mahir Ozturk 1:efe9cad8942f 98 <li><strong>AStyle A </strong>builds the Artistic Style program as a Static Library (libastyle.a). This can be
Mahir Ozturk 1:efe9cad8942f 99 statically linked to a user program.</li>
Mahir Ozturk 1:efe9cad8942f 100 </ul>
Mahir Ozturk 1:efe9cad8942f 101
Mahir Ozturk 1:efe9cad8942f 102 <p>
Mahir Ozturk 1:efe9cad8942f 103 For other Linux development environments, follow the instructions in <a href="#_Other_Development_Environments">Other
Mahir Ozturk 1:efe9cad8942f 104 Development
Mahir Ozturk 1:efe9cad8942f 105 Environments</a>.
Mahir Ozturk 1:efe9cad8942f 106 </p>
Mahir Ozturk 1:efe9cad8942f 107
Mahir Ozturk 1:efe9cad8942f 108 <h4 id="_GCC_Makefile">GCC Makefile</h4>
Mahir Ozturk 1:efe9cad8942f 109
Mahir Ozturk 1:efe9cad8942f 110 <p>
Mahir Ozturk 1:efe9cad8942f 111 To compile using the GCC compiler you must have GCC (3.1 or better) installed.</p>
Mahir Ozturk 1:efe9cad8942f 112 <p>
Mahir Ozturk 1:efe9cad8942f 113 The build has no autoconf dependency. To build the Artistic Style configurations, use the makefile located in
Mahir Ozturk 1:efe9cad8942f 114 the astyle/build/gcc directory. The executables will be in the astyle/build/gcc/bin directory. To build the
Mahir Ozturk 1:efe9cad8942f 115 command line configuration, enter the following:</p>
Mahir Ozturk 1:efe9cad8942f 116 <pre>cd astyle/build/gcc<br />make
Mahir Ozturk 1:efe9cad8942f 117 </pre>
Mahir Ozturk 1:efe9cad8942f 118 <p>
Mahir Ozturk 1:efe9cad8942f 119 To build the other astyle configurations, you can enter the file name or a symbolic name. Entering "make astyle"
Mahir Ozturk 1:efe9cad8942f 120 or "make release" will build the command line configuration. Following are the symbolic names and file names (in
Mahir Ozturk 1:efe9cad8942f 121 parens) of the various configurations:</p>
Mahir Ozturk 1:efe9cad8942f 122 <ul>
Mahir Ozturk 1:efe9cad8942f 123 <li><strong>release</strong> or <strong>astyle</strong> builds the Artistic Style command line program. This is the
Mahir Ozturk 1:efe9cad8942f 124 default option. </li>
Mahir Ozturk 1:efe9cad8942f 125 <li><strong>shared</strong> or <strong>libastyle.so</strong> builds the Artistic Style program as a shared
Mahir Ozturk 1:efe9cad8942f 126 library. </li>
Mahir Ozturk 1:efe9cad8942f 127 <li><strong>static</strong> or <strong>libastyle.a</strong> builds the Artistic Style program as a static
Mahir Ozturk 1:efe9cad8942f 128 library. </li>
Mahir Ozturk 1:efe9cad8942f 129 <li><strong>debug</strong> or <strong>astyled</strong> builds the Artistic Style command line program with debugging
Mahir Ozturk 1:efe9cad8942f 130 information </li>
Mahir Ozturk 1:efe9cad8942f 131 <li><strong>shareddebug</strong> or <strong>libastyled.so</strong> builds the Artistic Style program as a shared library
Mahir Ozturk 1:efe9cad8942f 132 with debugging information. </li>
Mahir Ozturk 1:efe9cad8942f 133 <li><strong>staticdebug</strong> or <strong>libastyled.a</strong> builds the Artistic Style program as a static library
Mahir Ozturk 1:efe9cad8942f 134 with debugging information. </li>
Mahir Ozturk 1:efe9cad8942f 135 <li><strong>all</strong> builds all the above configurations.
Mahir Ozturk 1:efe9cad8942f 136 <p>
Mahir Ozturk 1:efe9cad8942f 137 The following Java shared library builds are separate from the above. They include a Java Native Interface (JNI)
Mahir Ozturk 1:efe9cad8942f 138 and require that the Java Development Kit (JDK) be installed. The environment variable JAVA_HOME should be defined.
Mahir Ozturk 1:efe9cad8942f 139 It defines the install directory for the JDK. The makefile also has default install directories for Java 5 and
Mahir Ozturk 1:efe9cad8942f 140 6. If the compile cannot find the file jni.h, either set the variable or change the value in the
Mahir Ozturk 1:efe9cad8942f 141 makefile.</p>
Mahir Ozturk 1:efe9cad8942f 142 </li>
Mahir Ozturk 1:efe9cad8942f 143 <li><strong>java </strong>builds the Artistic Style program as a shared library which includes the JNI (libastylej.so).
Mahir Ozturk 1:efe9cad8942f 144 </li>
Mahir Ozturk 1:efe9cad8942f 145 <li><strong>javadebug </strong>builds the Artistic Style program as a shared library which includes the JNI and debugging
Mahir Ozturk 1:efe9cad8942f 146 information
Mahir Ozturk 1:efe9cad8942f 147 (libastylejd.so).</li>
Mahir Ozturk 1:efe9cad8942f 148 <li><strong>javaall </strong>builds all the above java configurations.</li>
Mahir Ozturk 1:efe9cad8942f 149 </ul>
Mahir Ozturk 1:efe9cad8942f 150 <p>
Mahir Ozturk 1:efe9cad8942f 151 More than one configuration can be built at the same time. For example, to build all the release configurations
Mahir Ozturk 1:efe9cad8942f 152 enter:</p>
Mahir Ozturk 1:efe9cad8942f 153 <pre>cd astyle/build/gcc<br />make release shared static</pre>
Mahir Ozturk 1:efe9cad8942f 154 <p>
Mahir Ozturk 1:efe9cad8942f 155 The <a href="#_Other_Makefile_Targets">Other Makefile Targets</a> section contains additional target
Mahir Ozturk 1:efe9cad8942f 156 options.</p>
Mahir Ozturk 1:efe9cad8942f 157
Mahir Ozturk 1:efe9cad8942f 158 <h4 id="_Clang_Makefile">Clang Makefile</h4>
Mahir Ozturk 1:efe9cad8942f 159
Mahir Ozturk 1:efe9cad8942f 160 <p>
Mahir Ozturk 1:efe9cad8942f 161 Clang has a static analyzer that finds potential bugs in C/C++ and Objective-C programs. It can be run as a standalone
Mahir Ozturk 1:efe9cad8942f 162 tool from the command-line, and runs in tandem with a build. There is a script file, analyze.sh, that will run
Mahir Ozturk 1:efe9cad8942f 163 the analysis on Artistic Style.</p>
Mahir Ozturk 1:efe9cad8942f 164 <p>
Mahir Ozturk 1:efe9cad8942f 165 The build has no autoconf dependency. To build the Artistic Style configurations use the makefile located in the
Mahir Ozturk 1:efe9cad8942f 166 astyle/build/clang directory. The executables will be in the astyle/build/clang/bin directory. To build the command
Mahir Ozturk 1:efe9cad8942f 167 line configuration, enter the following:</p>
Mahir Ozturk 1:efe9cad8942f 168 <pre>cd astyle/build/clang<br />make
Mahir Ozturk 1:efe9cad8942f 169 </pre>
Mahir Ozturk 1:efe9cad8942f 170 <p>
Mahir Ozturk 1:efe9cad8942f 171 To build the other astyle configurations, you can enter the file name or a symbolic name. The configurations for
Mahir Ozturk 1:efe9cad8942f 172 Clang are the same as for the <a href="#_GCC_Makefile">GCC Makefile</a>. More than one configuration can be
Mahir Ozturk 1:efe9cad8942f 173 built at the same time. For example, to build all the release configurations enter:</p>
Mahir Ozturk 1:efe9cad8942f 174 <pre>cd astyle/build/clang<br />make release shared static
Mahir Ozturk 1:efe9cad8942f 175 </pre>
Mahir Ozturk 1:efe9cad8942f 176 <p>
Mahir Ozturk 1:efe9cad8942f 177 The <a href="#_Other_Makefile_Targets">Other Makefile Targets</a> section contains additional target
Mahir Ozturk 1:efe9cad8942f 178 options.</p>
Mahir Ozturk 1:efe9cad8942f 179
Mahir Ozturk 1:efe9cad8942f 180 <h4 id="_Intel_Makefile">Intel Makefile</h4>
Mahir Ozturk 1:efe9cad8942f 181
Mahir Ozturk 1:efe9cad8942f 182 <p>
Mahir Ozturk 1:efe9cad8942f 183 These procedures and the makefile are for recent versions of the compiler. They may not work for earlier versions.
Mahir Ozturk 1:efe9cad8942f 184 Instructions for your compiler are in the compiler documentation file "get_started_lc.htm".</p>
Mahir Ozturk 1:efe9cad8942f 185 <p>
Mahir Ozturk 1:efe9cad8942f 186 To compile with Intel there are environment variables that must be set by running the compiler environment
Mahir Ozturk 1:efe9cad8942f 187 script compilervars.sh (or compilervars.csh) with an argument that specifies the target architecture. This
Mahir Ozturk 1:efe9cad8942f 188 should be done before running the make. If it is not done, &quot;make&quot; will display an error message
Mahir Ozturk 1:efe9cad8942f 189 stating that the compiler environment variables are not set.</p>
Mahir Ozturk 1:efe9cad8942f 190 <p>
Mahir Ozturk 1:efe9cad8942f 191 The build has no autoconf dependency. To build the Artistic Style configurations use the makefile located in the
Mahir Ozturk 1:efe9cad8942f 192 astyle/build/intel directory. The output executables will be in the astyle/build/intel/bin directory. To build
Mahir Ozturk 1:efe9cad8942f 193 the command line configuration, enter the following:</p>
Mahir Ozturk 1:efe9cad8942f 194 <pre>cd astyle/build/intel<br />make</pre>
Mahir Ozturk 1:efe9cad8942f 195 <p>
Mahir Ozturk 1:efe9cad8942f 196 To build the other astyle configurations, you can enter the file name or a symbolic name. The configuration names
Mahir Ozturk 1:efe9cad8942f 197 for Intel are the same as for the <a href="#_GCC_Makefile">GCC Makefile</a>. More than one configuration can be
Mahir Ozturk 1:efe9cad8942f 198 built at the same time. For example, to build the entire debug configurations enter:</p>
Mahir Ozturk 1:efe9cad8942f 199 <pre>cd astyle/build/intel<br />make debug shareddebug staticdebug</pre>
Mahir Ozturk 1:efe9cad8942f 200 <p>
Mahir Ozturk 1:efe9cad8942f 201 The <a href="#_Other_Makefile_Targets">Other Makefile Targets</a> section contains additional target
Mahir Ozturk 1:efe9cad8942f 202 options.</p>
Mahir Ozturk 1:efe9cad8942f 203
Mahir Ozturk 1:efe9cad8942f 204 <h4 id="_Other_Makefile_Targets">Other Makefile Targets</h4>
Mahir Ozturk 1:efe9cad8942f 205
Mahir Ozturk 1:efe9cad8942f 206 <p>
Mahir Ozturk 1:efe9cad8942f 207 The following makefile targets are available for GCC, Clang, Intel, and Mac.</p>
Mahir Ozturk 1:efe9cad8942f 208
Mahir Ozturk 1:efe9cad8942f 209 <h5>clean</h5>
Mahir Ozturk 1:efe9cad8942f 210
Mahir Ozturk 1:efe9cad8942f 211 <p>
Mahir Ozturk 1:efe9cad8942f 212 Removes the object and executable files for all configurations.</p>
Mahir Ozturk 1:efe9cad8942f 213 <p>
Mahir Ozturk 1:efe9cad8942f 214 To remove the files for all configurations:</p>
Mahir Ozturk 1:efe9cad8942f 215 <pre>make clean
Mahir Ozturk 1:efe9cad8942f 216 </pre>
Mahir Ozturk 1:efe9cad8942f 217
Mahir Ozturk 1:efe9cad8942f 218 <h5>cleanobj</h5>
Mahir Ozturk 1:efe9cad8942f 219
Mahir Ozturk 1:efe9cad8942f 220 <p>
Mahir Ozturk 1:efe9cad8942f 221 Removes the object files for all configurations. The executables will not be removed.</p>
Mahir Ozturk 1:efe9cad8942f 222 <p>
Mahir Ozturk 1:efe9cad8942f 223 To remove only the object files for all configurations:</p>
Mahir Ozturk 1:efe9cad8942f 224 <pre>make cleanobj
Mahir Ozturk 1:efe9cad8942f 225 </pre>
Mahir Ozturk 1:efe9cad8942f 226
Mahir Ozturk 1:efe9cad8942f 227 <h5>install</h5>
Mahir Ozturk 1:efe9cad8942f 228
Mahir Ozturk 1:efe9cad8942f 229 <p>
Mahir Ozturk 1:efe9cad8942f 230 Installs the
Mahir Ozturk 1:efe9cad8942f 231 astyle executable and documentation files. The default is /usr/bin for the executable and /usr/share/doc/astyle
Mahir Ozturk 1:efe9cad8942f 232 for the documentation. You must have the appropriate permissions to use install.</p>
Mahir Ozturk 1:efe9cad8942f 233 <p>
Mahir Ozturk 1:efe9cad8942f 234 To install the astyle to the default directories:</p>
Mahir Ozturk 1:efe9cad8942f 235 <pre>sudo make install
Mahir Ozturk 1:efe9cad8942f 236 </pre>
Mahir Ozturk 1:efe9cad8942f 237 <p>
Mahir Ozturk 1:efe9cad8942f 238 To install astyle to a different bin directory set a value for the macro $(prefix). For example, to install the
Mahir Ozturk 1:efe9cad8942f 239 executable to a user's home directory (/home/<i>user</i>/bin):</p>
Mahir Ozturk 1:efe9cad8942f 240 <pre>sudo make prefix=$HOME install
Mahir Ozturk 1:efe9cad8942f 241 </pre>
Mahir Ozturk 1:efe9cad8942f 242
Mahir Ozturk 1:efe9cad8942f 243 <h5>uninstall</h5>
Mahir Ozturk 1:efe9cad8942f 244
Mahir Ozturk 1:efe9cad8942f 245 <p>
Mahir Ozturk 1:efe9cad8942f 246 Uninstalls the executable and documentation. You must have the appropriate permissions to use uninstall.</p>
Mahir Ozturk 1:efe9cad8942f 247 <p>
Mahir Ozturk 1:efe9cad8942f 248 To uninstall astyle from the default directories:</p>
Mahir Ozturk 1:efe9cad8942f 249 <pre>sudo make uninstall
Mahir Ozturk 1:efe9cad8942f 250 </pre>
Mahir Ozturk 1:efe9cad8942f 251 <p>
Mahir Ozturk 1:efe9cad8942f 252 To uninstall the files from a different directory set a value for the macro $(prefix). For example, to uninstall
Mahir Ozturk 1:efe9cad8942f 253 the files from a user's home directory (/home/<i>user</i>):</p>
Mahir Ozturk 1:efe9cad8942f 254 <pre> sudo make prefix=$HOME uninstall
Mahir Ozturk 1:efe9cad8942f 255 </pre>
Mahir Ozturk 1:efe9cad8942f 256 <p>
Mahir Ozturk 1:efe9cad8942f 257 NOTE: The uninstall option will NOT remove the .astylerc files from the users' home directories. The files must
Mahir Ozturk 1:efe9cad8942f 258 be removed individually for each user.</p>
Mahir Ozturk 1:efe9cad8942f 259
Mahir Ozturk 1:efe9cad8942f 260 <h3 id="_MacOS_Version">MacOS Version</h3>
Mahir Ozturk 1:efe9cad8942f 261
Mahir Ozturk 1:efe9cad8942f 262 <h4 id="_Xcode">Xcode</h4>
Mahir Ozturk 1:efe9cad8942f 263
Mahir Ozturk 1:efe9cad8942f 264 <p>
Mahir Ozturk 1:efe9cad8942f 265 Artistic Style workspace and project files for the Xcode development environment are available in the &quot;build/xcode&quot;
Mahir Ozturk 1:efe9cad8942f 266 directory. A workspace can be used to build a single project or all the projects. The project files have Debug
Mahir Ozturk 1:efe9cad8942f 267 and Release configurations. The following projects are available.</p>
Mahir Ozturk 1:efe9cad8942f 268 <ul>
Mahir Ozturk 1:efe9cad8942f 269 <li><strong>AStyle</strong> builds the Artistic Style command line program (astyle). </li>
Mahir Ozturk 1:efe9cad8942f 270 <li><strong>AStyleA</strong> builds the Artistic Style program as a Static Library (libastyle.a). This can be statically
Mahir Ozturk 1:efe9cad8942f 271 linked with an executable.</li>
Mahir Ozturk 1:efe9cad8942f 272 <li><strong>AStyleDylib</strong> builds the Artistic Style program as a Dynamic Library (libastyle.dylib). It can
Mahir Ozturk 1:efe9cad8942f 273 be used with C/C++, Objective C, C#, and Python programs.</li>
Mahir Ozturk 1:efe9cad8942f 274 <li><strong>AStyleJava</strong> builds the Artistic Style program as a Dynamic Library (libastylej.dylib) that can
Mahir Ozturk 1:efe9cad8942f 275 be called from a Java program. The Java Development (JDK) is required for the project to compile. The Project
Mahir Ozturk 1:efe9cad8942f 276 Properties must have an include path to the JDK include directory. The output dylib can also be called from a
Mahir Ozturk 1:efe9cad8942f 277 C++ or C# program.</li>
Mahir Ozturk 1:efe9cad8942f 278 </ul>
Mahir Ozturk 1:efe9cad8942f 279
Mahir Ozturk 1:efe9cad8942f 280 <h5>install</h5>
Mahir Ozturk 1:efe9cad8942f 281
Mahir Ozturk 1:efe9cad8942f 282 <p>
Mahir Ozturk 1:efe9cad8942f 283 Only the astyle executable is installed. The library project installs are sent to UninstalledProjects in
Mahir Ozturk 1:efe9cad8942f 284 the Build directory. The following instructions are for the astyle executable and documentation files. The default
Mahir Ozturk 1:efe9cad8942f 285 install directory is /usr/bin for the executable and /usr/share/doc/astyle for the documentation. You must have
Mahir Ozturk 1:efe9cad8942f 286 the appropriate permissions to use install. If sudo is not used for the install, an error will occur during the
Mahir Ozturk 1:efe9cad8942f 287 build.</p>
Mahir Ozturk 1:efe9cad8942f 288 <p>
Mahir Ozturk 1:efe9cad8942f 289 To install the astyle executable in the default directory:</p>
Mahir Ozturk 1:efe9cad8942f 290 <pre>cd astyle/build/xcode
Mahir Ozturk 1:efe9cad8942f 291 sudo xcodebuild install -project AStyle.xcodeproj
Mahir Ozturk 1:efe9cad8942f 292 </pre>
Mahir Ozturk 1:efe9cad8942f 293 <p>
Mahir Ozturk 1:efe9cad8942f 294 A script is used to install the documentation
Mahir Ozturk 1:efe9cad8942f 295 from the same directory.</p>
Mahir Ozturk 1:efe9cad8942f 296 <pre>sudo bash install.sh
Mahir Ozturk 1:efe9cad8942f 297 </pre>
Mahir Ozturk 1:efe9cad8942f 298
Mahir Ozturk 1:efe9cad8942f 299 <h5>uninstall</h5>
Mahir Ozturk 1:efe9cad8942f 300
Mahir Ozturk 1:efe9cad8942f 301 <p>
Mahir Ozturk 1:efe9cad8942f 302 Uninstalls the executable and documentation. You must have the appropriate permissions to use uninstall.</p>
Mahir Ozturk 1:efe9cad8942f 303 <p>
Mahir Ozturk 1:efe9cad8942f 304 A script is used to uninstall astyle and the documentation:</p>
Mahir Ozturk 1:efe9cad8942f 305 <pre>sudo bash uninstall.sh
Mahir Ozturk 1:efe9cad8942f 306 </pre>
Mahir Ozturk 1:efe9cad8942f 307 <p>
Mahir Ozturk 1:efe9cad8942f 308 NOTE: The uninstall option will NOT remove the .astylerc files from the users' home directories. The files must
Mahir Ozturk 1:efe9cad8942f 309 be removed individually for each user.</p>
Mahir Ozturk 1:efe9cad8942f 310
Mahir Ozturk 1:efe9cad8942f 311 <h4 id="_MacOS_Makefile">MacOS Makefile</h4>
Mahir Ozturk 1:efe9cad8942f 312
Mahir Ozturk 1:efe9cad8942f 313 <p>
Mahir Ozturk 1:efe9cad8942f 314 The Artistic Style makefile compile uses the Mac OS &quot;Command Line Tools&quot;. If you have Xcode 4.3 or newer
Mahir Ozturk 1:efe9cad8942f 315 the command line tools, such as &quot;make&quot;, are NOT installed by default. They must be downloaded and installed
Mahir Ozturk 1:efe9cad8942f 316 separately. Once everything is successfully installed, you should see &quot;make&quot; and other command line
Mahir Ozturk 1:efe9cad8942f 317 developer tools in /usr/bin.</p>
Mahir Ozturk 1:efe9cad8942f 318 <p>
Mahir Ozturk 1:efe9cad8942f 319 The build has no autoconf dependency. To build the Artistic Style configurations use the makefile located in the
Mahir Ozturk 1:efe9cad8942f 320 astyle/build/mac directory. The executables will be in the astyle/build/mac/bin directory. To build the command
Mahir Ozturk 1:efe9cad8942f 321 line configuration, enter the following:</p>
Mahir Ozturk 1:efe9cad8942f 322 <pre>cd astyle/build/mac<br />make
Mahir Ozturk 1:efe9cad8942f 323 </pre>
Mahir Ozturk 1:efe9cad8942f 324 <p>
Mahir Ozturk 1:efe9cad8942f 325 To build the other astyle configurations, you can enter the file name or a symbolic name. The configurations for
Mahir Ozturk 1:efe9cad8942f 326 Mac are the same as for the <a href="#_GCC_Makefile">GCC Makefile</a>. More than one configuration can be
Mahir Ozturk 1:efe9cad8942f 327 built at the same time. For example, to build all the release configurations enter:</p>
Mahir Ozturk 1:efe9cad8942f 328 <pre>cd astyle/build/mac<br />make release shared static
Mahir Ozturk 1:efe9cad8942f 329 </pre>
Mahir Ozturk 1:efe9cad8942f 330 <p>
Mahir Ozturk 1:efe9cad8942f 331 The <a href="#_Other_Makefile_Targets">Other Makefile Targets</a> section contains additional target
Mahir Ozturk 1:efe9cad8942f 332 options.</p>
Mahir Ozturk 1:efe9cad8942f 333
Mahir Ozturk 1:efe9cad8942f 334 <h3 id="_Windows_Version">Windows Version</h3>
Mahir Ozturk 1:efe9cad8942f 335
Mahir Ozturk 1:efe9cad8942f 336 <h4 id="_Precompiled_Executable">Precompiled Executable</h4>
Mahir Ozturk 1:efe9cad8942f 337
Mahir Ozturk 1:efe9cad8942f 338 <p>
Mahir Ozturk 1:efe9cad8942f 339 In addition to the source files, the Windows distribution package contains an Artistic Style Win32 executable
Mahir Ozturk 1:efe9cad8942f 340 (AStyle.exe). If you prefer to compile the executable yourself, pursue the following instructions.</p>
Mahir Ozturk 1:efe9cad8942f 341
Mahir Ozturk 1:efe9cad8942f 342 <h4 id="_CodeBlocks_Windows">CodeBlocks Windows</h4>
Mahir Ozturk 1:efe9cad8942f 343
Mahir Ozturk 1:efe9cad8942f 344 <p>
Mahir Ozturk 1:efe9cad8942f 345 There are build folders for the following compilers. All compiler folders are in the &quot;build&quot; directory.
Mahir Ozturk 1:efe9cad8942f 346 </p>
Mahir Ozturk 1:efe9cad8942f 347 <ul>
Mahir Ozturk 1:efe9cad8942f 348 <li><strong>cb-bcc32c</strong> contains the workspace and project files for the Embarcadero BCC32C Compiler.</li>
Mahir Ozturk 1:efe9cad8942f 349 <li><strong>cb-mingw</strong> contains the workspace and project files for the MinGw or TDM_GCC Compilers.</li>
Mahir Ozturk 1:efe9cad8942f 350 </ul>
Mahir Ozturk 1:efe9cad8942f 351
Mahir Ozturk 1:efe9cad8942f 352 <p>
Mahir Ozturk 1:efe9cad8942f 353 There are workspace and project files for each folder. All projects have at least Debug and Release configurations.
Mahir Ozturk 1:efe9cad8942f 354 All output
Mahir Ozturk 1:efe9cad8942f 355 will be in the &quot;bin&quot; directory.</p>
Mahir Ozturk 1:efe9cad8942f 356 <p>
Mahir Ozturk 1:efe9cad8942f 357 The workspace contains the following projects.</p>
Mahir Ozturk 1:efe9cad8942f 358 <ul>
Mahir Ozturk 1:efe9cad8942f 359 <li><strong>AStyle </strong>builds the Artistic Style command line program (AStyle.exe). </li>
Mahir Ozturk 1:efe9cad8942f 360 <li><strong>AStyle Dll </strong>builds the Artistic Style program as a shared object (AStyle.dll). </li>
Mahir Ozturk 1:efe9cad8942f 361 <li><strong>AStyle Java </strong>builds the Artistic Style program as a shared object AStylej.dll) that can
Mahir Ozturk 1:efe9cad8942f 362 be called from a Java program. The Java Development Kit (JDK) is required for the project to compile. The
Mahir Ozturk 1:efe9cad8942f 363 Project Properties must have an include path to the JDK include directories.</li>
Mahir Ozturk 1:efe9cad8942f 364 <li><strong>AStyle Lib </strong>builds the Artistic Style program as a Static Library (astyle.lib). This can be
Mahir Ozturk 1:efe9cad8942f 365 statically linked to a calling program.</li>
Mahir Ozturk 1:efe9cad8942f 366 </ul>
Mahir Ozturk 1:efe9cad8942f 367 <p>
Mahir Ozturk 1:efe9cad8942f 368 For other development environments, follow the instructions in <a href="#_Other_Development_Environments">Other Development
Mahir Ozturk 1:efe9cad8942f 369 Environments</a>.
Mahir Ozturk 1:efe9cad8942f 370 </p>
Mahir Ozturk 1:efe9cad8942f 371
Mahir Ozturk 1:efe9cad8942f 372 <h4 id="_Visual_Studio">Visual Studio</h4>
Mahir Ozturk 1:efe9cad8942f 373
Mahir Ozturk 1:efe9cad8942f 374 <p>
Mahir Ozturk 1:efe9cad8942f 375 There are solution and project files for several versions of Microsoft Visual Studio. Open an Artistic Style solution
Mahir Ozturk 1:efe9cad8942f 376 file in the appropriate &quot;build&quot; directory. All projects have Debug, Release and Static configurations.
Mahir Ozturk 1:efe9cad8942f 377 Debug file output will be in the &quot;debug&quot; directory. Release file output will be in the &quot;bin&quot;
Mahir Ozturk 1:efe9cad8942f 378 directory. Static file output will be in the "binstatic" directory. The following solution files are
Mahir Ozturk 1:efe9cad8942f 379 available.</p>
Mahir Ozturk 1:efe9cad8942f 380 <ul>
Mahir Ozturk 1:efe9cad8942f 381 <li><strong>All AStyle </strong>builds the release and the debug configurations for all the following.
Mahir Ozturk 1:efe9cad8942f 382 </li>
Mahir Ozturk 1:efe9cad8942f 383 <li><strong>AStyle </strong>builds the Artistic Style command line program (AStyle.exe). This project has an extra
Mahir Ozturk 1:efe9cad8942f 384 "Static" option. It is the same as the "Release" build except that it is linked with a static runtime library.
Mahir Ozturk 1:efe9cad8942f 385 This is needed if the executable is to be run on a system without Visual Studio installed. The builds for this
Mahir Ozturk 1:efe9cad8942f 386 configuration are placed in a separate &quot;binstatic&quot; directory. </li>
Mahir Ozturk 1:efe9cad8942f 387 <li><strong>AStyle Dll </strong>builds the Artistic Style program as a Dynamic Link Library (AStyle.dll). This will
Mahir Ozturk 1:efe9cad8942f 388 also build an export library and a static library for linking the dll. </li>
Mahir Ozturk 1:efe9cad8942f 389 <li><strong>AStyle Java </strong>builds the Artistic Style program as a Dynamic Link Library (AStylej.dll) that can
Mahir Ozturk 1:efe9cad8942f 390 be called from a Java program. The Java Development (JDK) is required for the project to compile. The Project
Mahir Ozturk 1:efe9cad8942f 391 Properties must have an include path to the JDK include and include/win32 directories. This is set in &quot;Project
Mahir Ozturk 1:efe9cad8942f 392 &gt; Properties &gt; C/C++ &gt; General &gt; Additional&nbsp;Include&nbsp;Directories&quot;. The default setting
Mahir Ozturk 1:efe9cad8942f 393 is for the JDK to be installed in the default directory, but it may not be the most current release. The output
Mahir Ozturk 1:efe9cad8942f 394 DLL can also be called from a C++ or C# program.</li>
Mahir Ozturk 1:efe9cad8942f 395 <li><strong>AStyle Lib </strong>builds the Artistic Style program as a Static Library (libAStyle.lib). This can be
Mahir Ozturk 1:efe9cad8942f 396 statically linked to a calling program.</li>
Mahir Ozturk 1:efe9cad8942f 397 </ul>
Mahir Ozturk 1:efe9cad8942f 398
Mahir Ozturk 1:efe9cad8942f 399 <h3 id="_Other_Development_Environments">Other Development Environments</h3>
Mahir Ozturk 1:efe9cad8942f 400
Mahir Ozturk 1:efe9cad8942f 401 <p>
Mahir Ozturk 1:efe9cad8942f 402 To use other development environments a project file must be built.</p>
Mahir Ozturk 1:efe9cad8942f 403 <ul>
Mahir Ozturk 1:efe9cad8942f 404 <li>Create a project using the development environment.</li>
Mahir Ozturk 1:efe9cad8942f 405 <li>Add to the project all the .cpp and .h files in the "src" directory.</li>
Mahir Ozturk 1:efe9cad8942f 406 <li>The Compiler Options section discusses the compiler options to use.</li>
Mahir Ozturk 1:efe9cad8942f 407 <li>Compile.</li>
Mahir Ozturk 1:efe9cad8942f 408 </ul>
Mahir Ozturk 1:efe9cad8942f 409
Mahir Ozturk 1:efe9cad8942f 410 <h3 id="_Compiler_Options">Compiler Options</h3>
Mahir Ozturk 1:efe9cad8942f 411
Mahir Ozturk 1:efe9cad8942f 412 <p>
Mahir Ozturk 1:efe9cad8942f 413 No macro definitions are required to compile the executable. To compile as a static or shared (dynamic) library
Mahir Ozturk 1:efe9cad8942f 414 define the macro ASTYLE_LIB. To compile a Java shared (dynamic) library define the macro ASTYLE_JNI. The
Mahir Ozturk 1:efe9cad8942f 415 option ASTYLE_NO_EXPORTS is sometimes needed for static libraries to prevent compiler error and warning
Mahir Ozturk 1:efe9cad8942f 416 messages. Use the appropriate compiler and linker options to compile the static or shared library. Add debug
Mahir Ozturk 1:efe9cad8942f 417 options to compile the debug versions.</p>
Mahir Ozturk 1:efe9cad8942f 418 <p>
Mahir Ozturk 1:efe9cad8942f 419 Artistic Style is a small program and it is best to optimize for speed. The debug configurations are not usually
Mahir Ozturk 1:efe9cad8942f 420 optimized. To optimize for speed in the release configurations, use the macro NDEBUG to remove asserts. If
Mahir Ozturk 1:efe9cad8942f 421 necessary, use an option to activate the C++11 standards (-std=c++11 or -std=c++0x on most compilers). Use an
Mahir Ozturk 1:efe9cad8942f 422 option that allows inline function expansion. Runtime Type Information (RTTI) is NOT needed and exceptions are
Mahir Ozturk 1:efe9cad8942f 423 NOT used. Use whole program optimization if your compiler supports it. There may be other options you can use
Mahir Ozturk 1:efe9cad8942f 424 depending on the compiler. </p>
Mahir Ozturk 1:efe9cad8942f 425 <p>
Mahir Ozturk 1:efe9cad8942f 426 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 427
Mahir Ozturk 1:efe9cad8942f 428 <p style="margin-left: -0.4in; text-align: center;">
Mahir Ozturk 1:efe9cad8942f 429 <a href="http://sourceforge.net/projects/astyle">
Mahir Ozturk 1:efe9cad8942f 430 <img src="http://sflogo.sourceforge.net/sflogo.php?group_id=2319&type=16" alt="" />
Mahir Ozturk 1:efe9cad8942f 431 </a></p>
Mahir Ozturk 1:efe9cad8942f 432
Mahir Ozturk 1:efe9cad8942f 433 <p>
Mahir Ozturk 1:efe9cad8942f 434 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 435 <p>
Mahir Ozturk 1:efe9cad8942f 436 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 437
Mahir Ozturk 1:efe9cad8942f 438 </body>
Mahir Ozturk 1:efe9cad8942f 439
Mahir Ozturk 1:efe9cad8942f 440 </html>
Mahir Ozturk 1:efe9cad8942f 441