annotate src/linux/doc/man/apt.1 @ 7317:bfae8dda86b1

Added tag jdk7u65-b06 for changeset 7d8e5d907895
author katleman
date Tue, 01 Apr 2014 12:01:47 -0700
parents 42c22d5a2cd0
children
rev   line source
bpatel@4176 1 ." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
duke@0 2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@0 3 ."
duke@0 4 ." This code is free software; you can redistribute it and/or modify it
duke@0 5 ." under the terms of the GNU General Public License version 2 only, as
duke@0 6 ." published by the Free Software Foundation.
duke@0 7 ."
duke@0 8 ." This code is distributed in the hope that it will be useful, but WITHOUT
duke@0 9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@0 10 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@0 11 ." version 2 for more details (a copy is included in the LICENSE file that
duke@0 12 ." accompanied this code).
duke@0 13 ."
duke@0 14 ." You should have received a copy of the GNU General Public License version
duke@0 15 ." 2 along with this work; if not, write to the Free Software Foundation,
duke@0 16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@0 17 ."
ohair@2362 18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@2362 19 ." or visit www.oracle.com if you need additional information or have any
ohair@2362 20 ." questions.
tbell@1178 21 ."
bpatel@4900 22 .TH apt 1 "16 Mar 2012"
duke@0 23
duke@0 24 .LP
duke@0 25 .SH "NAME"
duke@0 26 .LP
duke@0 27 .LP
duke@0 28 \f2apt\fP \- annotation processing tool
duke@0 29 .LP
duke@0 30 .SH "SYNOPSIS"
duke@0 31 .LP
duke@0 32 .LP
duke@0 33 \f2apt [\-classpath \fP\f2classpath\fP] [\-sourcepath \f2sourcepath\fP] [\-d \f2directory\fP] [\-s \f2directory\fP] [\-factorypath \f2path\fP] [\-factory \f2class\fP] [\-print] [\-nocompile] [\-A\f2key\fP[\f2=val\fP] ...] [\f2javac option\fP] sourcefiles [@files]
duke@0 34 .LP
duke@0 35 .SH "PARAMETERS"
duke@0 36 .LP
duke@0 37 .LP
duke@0 38 Options may be in any order. For a discussion of parameters which apply to a specific option, see OPTIONS below.
duke@0 39 .LP
tbell@1178 40 .RS 3
duke@0 41 .TP 3
duke@0 42 sourcefiles
duke@0 43 Zero or more source files to be processed.
duke@0 44 .TP 3
duke@0 45 @files
duke@0 46 One or more files that list source files or other options
tbell@1178 47 .RE
tbell@1178 48
duke@0 49 .LP
duke@0 50 .SH "DESCRIPTION"
duke@0 51 .LP
duke@0 52 .LP
bpatel@4176 53 \f3Note\fP: The \f2apt\fP tool and its associated API contained in the package \f2com.sun.mirror\fP have been deprecated since JDK 7 and are planned to be removed in the next major JDK release. Use the options available in the \f2javac(1)\fP tool and the APIs contained in the packages \f2javax.annotation.processing\fP and \f2javax.lang.model\fP to process annotations.
bpatel@4176 54 .LP
bpatel@4176 55 .LP
bpatel@4176 56 The tool \f2apt\fP, annotation processing tool, includes reflective APIs and supporting infrastructure to process program annotations. The \f2apt\fP reflective APIs provide a build\-time, source\-based, read\-only view of program structure. These reflective APIs are designed to cleanly model the Java(TM) programming language's type system after the addition of generics. First, \f2apt\fP runs annotation processors that can produce new source code and other files. Next, \f2apt\fP can cause compilation of both original and generated source files, easing development. The reflective APIs and other APIs used to interact with the tool are subpackages of \f2com.sun.mirror\fP.
duke@0 57 .LP
duke@0 58 .LP
duke@0 59 A fuller discussion of how the tool operates as well as instructions for developing with \f2apt\fP are in
duke@0 60 .na
duke@0 61 \f4Getting Started with \fP\f4apt\fP. @
duke@0 62 .fi
bpatel@4900 63 http://docs.oracle.com/javase/7/docs/technotes/guides/apt/GettingStarted.html
duke@0 64 .LP
duke@0 65 .SH "OPTIONS"
duke@0 66 .LP
duke@0 67 .SS
duke@0 68 apt specific options
duke@0 69 .LP
tbell@1178 70 .RS 3
duke@0 71 .TP 3
duke@0 72 \-s dir
duke@0 73 Specify the directory root under which processor\-generated source files will be placed; files are placed in subdirectories based on package namespace.
duke@0 74 .TP 3
duke@0 75 \-nocompile
duke@0 76 Do not compile source files to class files.
duke@0 77 .TP 3
duke@0 78 \-print
duke@0 79 Print out textual representation of specified types; perform no annotation processing or compilation.
duke@0 80 .TP 3
duke@0 81 \-A[key[=val]]
duke@0 82 Options to pass to annotation processors \-\- these are not interpreted by \f2apt\fP directly, but are made available for use by individual processors
duke@0 83 .TP 3
duke@0 84 \-factorypath path
duke@0 85 Specify where to find annotation processor factories; if this option is used, the classpath is \f2not\fP searched for factories.
duke@0 86 .TP 3
duke@0 87 \-factory classname
duke@0 88 Name of annotation processor factory to use; bypasses default discovery process
bpatel@4176 89 .TP 3
bpatel@4176 90 \-version
bpatel@4176 91 Print version information.
bpatel@4176 92 .TP 3
bpatel@4176 93 \-X
bpatel@4176 94 Display information about non\-standard options.
tbell@1178 95 .RE
tbell@1178 96
duke@0 97 .LP
duke@0 98 .SS
duke@0 99 Options shared with javac
duke@0 100 .LP
tbell@1178 101 .RS 3
duke@0 102 .TP 3
duke@0 103 \-d dir
duke@0 104 Specify where to place processor and javac generated class files
duke@0 105 .TP 3
tbell@1178 106 \-cp path or \-classpath path
duke@0 107 Specify where to find user class files and annotation processor factories. If \f2\-factorypath\fP is given, the classpath is not searched for factories.
tbell@1178 108 .RE
tbell@1178 109
duke@0 110 .LP
duke@0 111 .LP
duke@0 112 Consult the javac(1) man page for information on \f2javac\fP options.
duke@0 113 .LP
bpatel@4176 114 .SS
bpatel@4176 115 Non\-Standard Options
bpatel@4176 116 .LP
bpatel@4176 117 .RS 3
bpatel@4176 118 .TP 3
bpatel@4176 119 \-XListAnnotationTypes
bpatel@4176 120 List found annotation types.
bpatel@4176 121 .TP 3
bpatel@4176 122 \-XListDeclarations
bpatel@4176 123 List specified and included declarations.
bpatel@4176 124 .TP 3
bpatel@4176 125 \-XPrintAptRounds
bpatel@4176 126 Print information about initial and recursive \f2apt\fP rounds.
bpatel@4176 127 .TP 3
bpatel@4176 128 \-XPrintFactoryInfo
bpatel@4176 129 Print information about which annotations a factory is asked to process.
bpatel@4176 130 .TP 3
bpatel@4176 131 \-XclassesAsDecls
bpatel@4176 132 Treat both class and source files as declarations to process.
bpatel@4176 133 .RE
bpatel@4176 134
bpatel@4176 135 .LP
bpatel@4176 136 .LP
bpatel@4176 137 \f3Note\fP: Because these options are non\-standard, they are subject to change without notice.
bpatel@4176 138 .LP
duke@0 139 .SH "NOTES"
duke@0 140 .LP
duke@0 141 .LP
bpatel@4176 142 The \f2apt\fP tool and its associated API contained in the package \f2com.sun.mirror\fP have been deprecated since JDK 7 and are planned to be removed in the next major JDK release. Use the options available in the \f2javac(1)\fP tool and the APIs contained in the packages \f2javax.annotation.processing\fP and \f2javax.lang.model\fP to process annotations.
duke@0 143 .LP
duke@0 144 .SH "SEE ALSO"
duke@0 145 .LP
duke@0 146 .RS 3
duke@0 147 .TP 2
tbell@1178 148 o
tbell@1178 149 javac(1), java(1)
duke@0 150 .RE
duke@0 151
duke@0 152 .LP
duke@0 153