Update to man page : example, explicit [FILE] parameter meaning, update-java-alernati...
[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 \- build 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 creates a Debian package from the given Java
29 distribution FILE.
30 This program works currently with the following Java REs, SDKs and APIs archive files:
31  Oracle(TM) 6 Standard Edition (starting with update 10)
32  Oracle(TM) 7 Standard Edition
33 .PP
34 The following options are recognized:
35 .TP
36 .B --full-name \fINAME\fR
37 full name used in the maintainer field of the package
38 .TP
39 .B --email \fIEMAIL\fR
40 email address used in the maintainer field of the package
41 .TP
42 .B --changes
43 create a .changes file
44 .TP
45 .B --revision
46 add debian revision
47 .TP
48 .B --help
49 display help text and exit
50 .TP
51 .B --version
52 output version information and exit
53 .PP
54 Download a supported Java RE or SDK or API tar.gz or self-extracting archive from
55 .B http://www.oracle.com/technetwork/java/javase/downloads
56 and execute
57 .B make-jpkg
58 .I file
59 with the downloaded file. The program asks the user for additional
60 information and creates a Debian binary package in the current
61 directory.
62 .PP
63 The program requires about 200 MB free disk space in a temporary
64 directory. The temporary directory defaults to 
65 .I /tmp
66 but you can specify an alternate directory by setting the environment
67 variable \fITMPDIR\fR.
68 .SH EXAMPLE
69 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:
70 .IP
71 make-jpkg <path_to_download_directory>/jdk-7u2-linux-x64.tar.gz
72 .PP
73 This generate a Debian package in the current directory, that can be installed using dpkg:
74 .IP
75 dpkg -i oracle-j2sdk1.7_1.7.0+update2_amd64.deb
76 .PP
77 When you're done, you can remove initial download as well as generated package:
78 .IP
79 rm <path_to_download_directory>/jdk-7u2-linux-x64.tar.gz oracle-j2sdk1.7_1.7.0+update2_amd64.deb
80 .PP
81 .SH ENVIRONMENT
82 .TP
83 .SM TMPDIR
84 base directory used for temporary files (defaults to /tmp)
85 .TP
86 .SM J2SE_PACKAGE_FULL_NAME
87 full name used in the maintainer field of the package; if none is supplied
88 then the default of "Debian Java Maintainers" is used.
89 .TP
90 .SM J2SE_PACKAGE_EMAIL
91 email address used in the maintainer field of the package; if none is supplied
92 the default of "pkg-java-maintainers@lists.alioth.debian.org" is used.
93 .SH SEE ALSO
94 .BR update-java-alternatives(1)
95 .SH AUTHOR
96 This manual page was written by Hubert Schmid <j2se-package@z42.de>.
97
98 It is now maintained by the Debian Java Maintainers <pkg-java-maintainers@lists.alioth.debian.org>.