Update to man page : example, explicit [FILE] parameter meaning, update-java-alernati...

[sven/java-package.git] / make-jpkg.1

diff --git a/make-jpkg.1 b/make-jpkg.1
index dee5358f14d1984acc3b9fc88d4a5e714bfb47bf..96c30a02a1005d20eb1e66067178b624502383be 100644 (file)
--- a/make-jpkg.1
+++ b/make-jpkg.1
@@ -2,7 +2,7 @@
 .\" First parameter, NAME, should be all caps
 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 .\" other parameters are allowed: see man(7), man(1)
-.TH MAKE-JPKG 1 "November 04, 2005"
+.TH MAKE-JPKG 1 "January 22, 2012"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -16,7 +16,7 @@
 .\" .sp <n>    insert n+1 empty lines
 .\" for manpage-specific macros, see man(7)
 .SH NAME
-make-jpkg \- build Debian packages from Java(TM) 2 binary distributions
+make-jpkg \- build Debian packages from Java binary distributions
 .SH SYNOPSIS
 .B make-jpkg
 [\fIOPTION\fR]... [\fIFILE\fR]
@@ -25,10 +25,11 @@ make-jpkg \- build Debian packages from Java(TM) 2 binary distributions
 .\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
 .\" respectively.
 .PP
-\fBmake-jpkg\fP creates a Debian package from a Java(TM) 2
-distribution. This program works currently with the following Java(TM) 2 REs, SDKs and APIs:
- Oracle(TM) 1.6 Standard Edition (starting with update 10)
- Oracle(TM) 1.7 Standard Edition
+\fBmake-jpkg\fP creates a Debian package from the given Java
+distribution FILE.
+This program works currently with the following Java REs, SDKs and APIs archive files:
+ Oracle(TM) 6 Standard Edition (starting with update 10)
+ Oracle(TM) 7 Standard Edition
 .PP
 The following options are recognized:
 .TP
@@ -50,7 +51,7 @@ display help text and exit
 .B --version
 output version information and exit
 .PP
-Download a supported Java(TM) 2 RE or SDK or API tar.gz or self-extracting archive from
+Download a supported Java RE or SDK or API tar.gz or self-extracting archive from
 .B http://www.oracle.com/technetwork/java/javase/downloads
 and execute
 .B make-jpkg
@@ -64,6 +65,19 @@ directory. The temporary directory defaults to
 .I /tmp
 but you can specify an alternate directory by setting the environment
 variable \fITMPDIR\fR.
+.SH EXAMPLE
+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:
+.IP
+make-jpkg <path_to_download_directory>/jdk-7u2-linux-x64.tar.gz
+.PP
+This generate a Debian package in the current directory, that can be installed using dpkg:
+.IP
+dpkg -i oracle-j2sdk1.7_1.7.0+update2_amd64.deb
+.PP
+When you're done, you can remove initial download as well as generated package:
+.IP
+rm <path_to_download_directory>/jdk-7u2-linux-x64.tar.gz oracle-j2sdk1.7_1.7.0+update2_amd64.deb
+.PP
 .SH ENVIRONMENT
 .TP
 .SM TMPDIR
@@ -76,6 +90,8 @@ then the default of "Debian Java Maintainers" is used.
 .SM J2SE_PACKAGE_EMAIL
 email address used in the maintainer field of the package; if none is supplied
 the default of "pkg-java-maintainers@lists.alioth.debian.org" is used.
+.SH SEE ALSO
+.BR update-java-alternatives(1)
 .SH AUTHOR
 This manual page was written by Hubert Schmid <j2se-package@z42.de>.