Modified the final message to better see the install command
[sven/java-package.git] / make-jpkg.1
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH MAKE-JPKG 1 "January 22, 2012"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 make-jpkg \- builds Debian packages from Java binary distributions
20 .SH SYNOPSIS
21 .B make-jpkg
22 [\fIOPTION\fR]... [\fIFILE\fR]
23 .SH DESCRIPTION
24 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
25 .\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
26 .\" respectively.
27 .PP
28 \fBmake-jpkg\fP builds a Debian package from the given Java
29 distribution FILE.
30 .PP
31 Supported java binary distributions currently include:
32   * Oracle (http://www.oracle.com/technetwork/java/javase/downloads) :
33     - The Java Development Kit (JDK), version 6, 7 and 8
34     - The Java Runtime Environment (JRE), version 6, 7 and 8
35     - The Java API Javadoc, version 6, 7 and 8
36   (Choose tar.gz archives or self-extracting archives, do _not_ choose the RPM!)
37 .PP
38 The following options are recognized:
39 .TP
40 .B --full-name \fINAME\fR
41 full name used in the maintainer field of the package
42 .TP
43 .B --email \fIEMAIL\fR
44 email address used in the maintainer field of the package
45 .TP
46 .B --changes
47 create a .changes file
48 .TP
49 .B --revision
50 add debian revision
51 .TP
52 .B --help
53 display help text and exit
54 .TP
55 .B --version
56 output version information and exit
57 .PP
58 Download a supported JRE, JDK, API tar.gz or self-extracting archive from
59 .B http://www.oracle.com/technetwork/java/javase/downloads
60 and execute
61 .B make-jpkg
62 .I file
63 with the downloaded file. The program asks the user for additional
64 information and builds a Debian binary package in the current
65 directory.
66 .PP
67 The program requires about 200 MB free disk space in a temporary
68 directory. The temporary directory defaults to 
69 .I /tmp
70 but you can specify an alternate directory by setting the environment
71 variable \fITMPDIR\fR.
72 .SH EXAMPLE
73 To install Oracle(TM) 7 Standard Edition JDK, download a release - 64 bits version of update 2 from http://www.oracle.com/technetwork/java/javase/downloads/jdk-7u2-download-1377129.html in this example - and invoke make-jpkg:
74 .IP
75 make-jpkg <path_to_download_directory>/jdk-7u2-linux-x64.tar.gz
76 .PP
77 This generate a Debian package in the current directory, that can be installed using dpkg:
78 .IP
79 dpkg \-i oracle-java7-jdk_7u2_amd64.deb
80 .PP
81 When you're done, you can delete initial download as well as generated package:
82 .IP
83 rm <path_to_download_directory>/jdk-7u2-linux-x64.tar.gz oracle-java7-jdk_7u2_amd64.deb
84 .PP
85 .SH ENVIRONMENT
86 .TP
87 .SM TMPDIR
88 base directory used for temporary files (defaults to /tmp)
89 .TP
90 .SM J2SE_PACKAGE_FULL_NAME
91 full name used in the maintainer field of the package; if none is supplied
92 then the default of "Debian Java Maintainers" is used.
93 .TP
94 .SM J2SE_PACKAGE_EMAIL
95 email address used in the maintainer field of the package; if none is supplied
96 the default of "pkg-java-maintainers@lists.alioth.debian.org" is used.
97 .SH SEE ALSO
98 .BR update-java-alternatives(1)
99 .SH AUTHOR
100 This manual page was written by Hubert Schmid <j2se-package@z42.de>.
101
102 It is now maintained by the Debian Java Maintainers <pkg-java-maintainers@lists.alioth.debian.org>.