mirrors
/
org.aspectj
mirror of https://github.com/eclipse/org.aspectj.git
Watch 1
Star 0
Fork 0
Code Issues 0 Releases 138 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
8586 Commits
38 Branches
Tree: 651e92a328
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '651e92a328'
${ noResults }
org.aspectj/docs/dist/README-AspectJ.html

README-AspectJ.html 9.2KB
Raw Blame History

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326 
  1. <html>

  2. 

  3. <head>

  4. <meta http-equiv="Content-Language" content="en-us">

  5. <meta http-equiv="Content-Type" content="text/html; charset=windows-1252">

  6. <meta name="GENERATOR" content="Microsoft FrontPage 4.0">

  7. <meta name="ProgId" content="FrontPage.Editor.Document">

  8. <title>AspectJ Readme</title>

  9. <STYLE TYPE="text/css">

  10. <!--

  11. 

  12.    /* FOR THE SDA PAGE */

  13. 

  14. 	/*

  15. 	BODY {margin-top: 15px; margin-left: 15px; margin-right: 15px;}

  16. 	*/

  17. 

  18. 	A:link {

  19. 		color:#4756AC;

  20. 	}

  21. 	A:visited {

  22. 		color:#60657B;

  23. 	}

  24. 	A:hover {

  25. 		color:red

  26. 	}

  27. 

  28. 	INPUT {font:12px "Courier New", sans-serif;}

  29. 

  30. 	H2 {

  31. 		font:18px/18px Verdana, Arial, Helvetica, sans-serif;

  32. 		color:black;

  33. 		font-weight:bold;

  34. 		margin-left: 10px;

  35. 		line-height:110%;

  36. 	}

  37. 	H3 {

  38. 		font:18px/18px Verdana, Arial, Helvetica, sans-serif;

  39. 		color:black;

  40. 		font-weight:bold;

  41. 		margin-left: 10px;

  42. 		line-height:110%;

  43. 	}

  44. 	H4 {

  45. 		font:15px/16px Verdana, Arial, Helvetica, sans-serif;

  46. 		color:black;

  47. 		font-weight:bold;

  48. 		margin-left: 10px;

  49. 		line-height:140%;

  50. 	}

  51. 	P {

  52. 		font:13px/13px Verdana, Arial, Helvetica, sans-serif;

  53. 		margin-right: 10px;

  54. 		margin-left: 10px;

  55. 		line-height:130%;

  56. 	}

  57. 	.paragraph {

  58. 		font:13px/13px Verdana, Arial, Helvetica, sans-serif;

  59. 		margin-right: 10px;

  60. 		margin-left: 10px;

  61. 		line-height:130%;

  62. 	}

  63. 	.smallParagraph {

  64. 		font:11px/11px Verdana, Arial, Helvetica, sans-serif;

  65. 		margin-right: 10px;

  66. 		margin-left: 10px;

  67. 		line-height:130%;

  68. 	}

  69. 	/*

  70. 	LI {

  71. 		font:13px/13px Verdana, Arial, Helvetica, sans-serif;

  72. 		text-align:justify;

  73. 		margin-right: 10px;

  74. 		margin-left: 15px;

  75. 		line-height:120%;

  76. 	}

  77. 

  78. 	UL {

  79. 		font:13px/13px Verdana, Arial, Helvetica, sans-serif;

  80. 		text-align:justify;

  81. 		margin-right: 10px;

  82. 		margin-left: 15px;

  83. 		line-height:120%;

  84. 	}*/

  85. 

  86. 	DL {

  87. 		font:13px/13px Verdana, Arial, Helvetica, sans-serif;

  88. 		text-align:justify;

  89. 		margin-right: 10px;

  90. 		margin-left: 15px;

  91. 		line-height:120%;

  92. 	}

  93. 	B { font:13px/13px Verdana, Arial, Helvetica, sans-serif;

  94. 		font-weight:bold;

  95. 		line-height:140%;

  96. 	}

  97. 	.footer {

  98. 		font:10px/10px Verdana, Arial, Helvetica, sans-serif;

  99. 		color:#888888;

  100. 		text-align:left

  101. 	}

  102. 	.figureTitle {

  103. 		font:13px/13px Verdana, Arial, Helvetica, sans-serif;

  104. 		text-align:justify;

  105. 		text-align:center

  106. 	}

  107. 	.copyrightNotice {

  108. 		font:10px/10px Verdana, Arial, Helvetica, sans-serif;

  109. 		color:#999999;

  110. 		line-height:110%;

  111. 	}

  112. 	.smallHeading {

  113. 		font:13px/13px Verdana, Arial, Helvetica, sans-serif;

  114. 		font-weight:bold;

  115. 		line-height:110%;

  116. 	}

  117. 	.tinyHeading {

  118. 		font:11px/11px Verdana, Arial, Helvetica, sans-serif;

  119. 		font-weight:bold;

  120. 		line-height:120%;

  121. 	}

  122. 	.newsText {

  123. 		font:11px/11px Verdana, Arial, Helvetica, sans-serif;

  124. 		line-height:130%;

  125. 	}

  126. 	.smallParagraph {

  127. 		font:11px/11px Verdana, Arial, Helvetica, sans-serif;

  128. 		line-height:130%;

  129. 	}

  130. 	.fancyHeading {

  131. 		font:20px/20px Chantilly, Arial, Helvetica, sans-serif;

  132. 		margin-right: 10px;

  133. 		color:#6f7a92;

  134. 		margin-left: 10px;

  135. 		line-height:130%;

  136. 	}

  137. 

  138. -->

  139. </STYLE>

  140. </head>

  141. 

  142. <BODY BGCOLOR="white">

  143. 

  144. <h2 align="center">AspectJ<sup><small>TM</small></sup></h2>

  145. 

  146. <p align="center"><i>Version @build.version.long@ released on @build.date@.</i></p>

  147. 

  148. <h3>1 Contents of this Package</h3>

  149. 

  150. <UL>

  151.   <li>the <a href="bin"><CODE>&lt;aspectj install dir&gt;/bin</CODE></a>

  152.       directory has scripts for

  153.        <ul>

  154. 	 <li><CODE>ajc</CODE>: the compiler for the AspectJ language</li>

  155. 

  156.   <li>the directory <a href="lib"><CODE>&lt;aspectj install dir&gt;/lib</CODE></a>

  157.       has the AspectJ binaries,

  158.        <ul>

  159. 	 <li><CODE><a href="lib/aspectjtools.jar">aspectjtools.jar</a></CODE>: libraries for

  160. 	 <code>ajc</code>, <code>ajbrowser</code>, and the Ant tasks</li>

  161. 

  162. 	 <li><CODE>aspectjrt.jar</CODE>: runtime library for AspectJ programs</li>

  163.        </ul>

  164.   </li>

  165.   <li>the directory <a href="doc"><CODE>&lt;aspectj install dir&gt;/doc</CODE></a>

  166.       has examples, programming and development environment guides,

  167.       instructions for the Ant tasks, a README for 1.1 changes,

  168.       and a quick reference, all linked

  169.       from the <a href="doc/index.html">index</a> page.

  170.   </li>

  171.   <li>this <a href="README-AspectJ.html">README-AspectJ.html</a>, and

  172.   </li>

  173.   <li>the <a href="LICENSE-AspectJ.html">LICENSE-AspectJ.html</a>

  174.       applying to this distribution.

  175.   </li>

  176. </UL>

  177. 

  178. <hr>

  179. 

  180. <h3>2 Install Procedure</h3>

  181. 

  182. <p>The AspectJ tool <code>ajc</code> is a

  183. Java program that can be run indirectly from the scripts or

  184. directly from <code>aspectjtools.jar</code>.

  185. The <code>aspectjrt.jar</code> needs to be on the classpath

  186. when compiling or running programs compiled

  187. by <code>ajc</code>.  This procedure shows ways to do that.

  188. </p>

  189. 

  190. <p>After finishing automatic installation, we recommend that the

  191. following steps to complete your installation:</p>

  192. 

  193.   <p><b>2.1 Add <CODE>&lt;aspectj install dir&gt;/lib/aspectjrt.jar</CODE>

  194.       to your class path</b></p>

  195. 

  196. <blockquote>

  197.   <p>This small .jar file contains classes required to compile programs

  198.   with the ajc compiler, and to run programs compiled with the ajc

  199.   compiler.  You must have these classes somewhere on your class path

  200.   when running programs compiled with ajc.  For detailed instructions

  201.   please see the <a href="#configInstructions">Configuration

  202.   Instructions</a> at the bottom of this document.</p>

  203. </blockquote>

  204. 

  205.   <p><b>2.2 Put the AspectJ <code>bin</code> directory on your PATH</b></p>

  206. 

  207. <blockquote>

  208.   <p>Modify your PATH to include <code><b>&lt;aspectj install

  209.   dir&gt;/bin</b></code>.  This will make it easier to run ajc.

  210.   For detailed instructions please see the

  211.   <a href="#configInstructions">Configuration Instructions</a> at the

  212.   bottom of this document.</p>

  213. </blockquote>

  214. 

  215. <p><b>2.3 Review the documentation and examples </b></p>

  216. 

  217. <blockquote>

  218.   <p>Development and programming guides

  219.   are available in <a href="doc/index.html">docs</a>,

  220.   and example programs and an Ant script are available in

  221.   <a href="doc/examples/">examples</a>.

  222. </blockquote>

  223. 

  224. <p>If you did not use the automatic installation process, you may wish

  225. to create short launch scripts to start ajc easily (section 3).</p>

  226. 

  227. <hr>

  228. 

  229. <h3>3. Running the Tools</h3>

  230. 

  231. <p>If you did not use the automatic installation process or the

  232. default launch scripts do not work on your system, you may wish to

  233. create short launch scripts to start ajc easily.</p>

  234. 

  235. <p> You can also create scripts like those created by the installer.

  236. These scripts use full paths that are system dependent so you will

  237. likely have to change these. </p>

  238. 

  239. <p>Here's a sample launch script for WinNT and Win2K (note that this

  240. is single line in the .bat file):</p>

  241. 

  242. <blockquote>

  243. <CODE>C:\jdk1.3\bin\java.exe -classpath D:\aspectj\lib\aspectjtools.jar -Xmx64M

  244. org.aspectj.tools.ajc.Main %*</CODE>

  245. </blockquote>

  246. 

  247. <p>Here's a sample launch script for a Unix shell (on Linux using Sun's JDK1.3):</p>

  248. 

  249. <blockquote>

  250. <CODE>/usr/java/jdk1.3/jre/bin/java -classpath /home/aspectj/lib/aspectjtools.jar -Xmx64M org.aspectj.tools.ajc.Main "$@"</CODE>

  251. </blockquote>

  252. 

  253. <hr>

  254. <h3><a name="configInstructions">4. Configuration Instructions</a></h3>

  255. 

  256. <h4>4.1 Adding <code>&lt;aspectj install dir&gt;/lib/aspectjrt.jar</code> to your classpath</h4>

  257. 

  258. <p>There are several ways to add this jar file to your classpath:</p>

  259. 

  260. <ul>

  261.     <li>

  262.       copy <code>aspectjrt.jar</code> to the <code>jdk/jre/lib/ext</code> directory</li>

  263.     <li>

  264.       add <code>aspectjrt.jar</code> to your CLASSPATH

  265.       environment variable (see the next section for details)</li>

  266.     <li>

  267.       always use the "<code>-classpath aspectjrt.jar</code>" option when running

  268.       programs compiled with ajc</li>

  269. </ul>

  270. <h4>4.2 <A NAME="6.1">Setting the Environment Variables on Windows</A></h4>

  271. 

  272. <P>The following instructions use the PATH variable as an example, but

  273. this process is identical for the CLASSPATH variable.  </P>

  274. 

  275. <P>You can do the variables permanently for all the shells that you

  276. will run or temporarily only for the current shell.  To change the

  277. PATH only in the current shell, and assuming you've installed AspectJ

  278. in <code>C:\apps\aspectj</code>, type:</P>

  279. 

  280. <blockquote><code>&gt; set PATH=%PATH%;C:\apps\aspectj\bin</code></blockquote>

  281. 

  282. <P><b>Changing Environment Variables Permanently on WinNT and Win2000</b>

  283. <ul>

  284.   <li>

  285.     <p class="paragraph">open the Environment Variables dialog

  286.     <ul>

  287.       <li>

  288.         <p class="paragraph">WinNT: in "Control Panels" double-click

  289.         "System" and select the "Environment" tab</li>

  290.       <li>

  291.         <p class="paragraph">Win2K: in "Control Panels" double-click

  292.         "System", select the "Advanced" tab and click the

  293.         "Environment Variables..." button</li>

  294.     </ul>

  295.   </li>

  296.   <li>

  297.     <p class="paragraph">select the environment variable for editing, or add it

  298.     using the "New..." button if it does not exist</li>

  299.   <li>

  300.     <p class="paragraph">add the new entry separated from the others by a

  301.     semi-colon (;) and close the dialog</li>

  302.   <li>

  303.     <p class="paragraph">note that the change will not affect shells that were

  304.     already running </li>

  305. </ul>

  306. <P><b>Changing Environment Variables Permanently on Win9x</b>

  307. <ul>

  308.   <li>

  309.     <p class="paragraph">open the AUTOEXEC.BAT with an editor such as NotePad</li>

  310. 

  311. <LI>

  312.   <p class="paragraph">edit the PATH statement to include the new entry and save

  313.   the file, e.g.<BR>

  314. 

  315. <blockquote>

  316.   <CODE>PATH C:\WINDOWS;C:\WINDOWS\COMMAND;C:\;C:\DOS;C:\apps\aspectj\bin</CODE>

  317.   </blockquote>

  318. </LI>

  319. <LI>

  320.   <p class="paragraph">note that the change will not affect shells that were

  321.   already running

  322. </ul>

  323. 

  324. </body>

  325. 

  326. </html>