Bug 59787 - Incorrect instructions for running HMEF from command-line
Summary: Incorrect instructions for running HMEF from command-line
Status: NEW
Alias: None
Product: POI
Classification: Unclassified
Component: HMEF (show other bugs)
Version: 3.15-dev
Hardware: PC Mac OS X 10.1
: P2 enhancement (vote)
Target Milestone: ---
Assignee: POI Developers List
Depends on:
Reported: 2016-07-03 12:26 UTC by Sebb
Modified: 2016-07-15 18:38 UTC (History)
0 users


Note You need to log in before you can comment on or make changes to this bug.
Description Sebb 2016-07-03 12:26:30 UTC
The HMEF page [1] gives the following sample command-line:

 java -classpath poi-3.14.jar:poi-scratchpad-3.14.jar org.apache.poi.hmef.extractor.HMEFContentsExtractor winmail.dat /tmp/extracted/

However, the jar names in the binary zip are actually:


[1] http://poi.apache.org/hmef/index.html
Comment 1 Nick Burch 2016-07-03 13:26:30 UTC
Those are the filenames for the jars grabbed from Maven Central (eg via Maven or Ivy or Gradle), see http://central.maven.org/maven2/org/apache/poi/poi/3.14/ . 

(The binary downloads do include the release date in them, in part to help people spot when they're using a really old version! The dates get dropped on the maven artifacts though)

If you can think of a suggested tweak to the page that would avoid your issue, not break it for people grabbing jars from maven central, and avoid confusion, please let us know!
Comment 2 Sebb 2016-07-03 14:10:15 UTC
My suggestion would be to rename the jars in the archives so they agree with the normal conventions. Likewise the archive names themselves.

It's really awkward having such long names.
(I suspect that some people don't realise that they are dates anyway)

As to fixing the page, it should be easy enough to add a second command-line showing how to use the class when using the binary archive.

BTW, it might be useful to add a similar couple of command-line examples for the Dumper program since it's included in the jar.