From 44e7c9988fce9145069f2c962fd51a4582352932 Mon Sep 17 00:00:00 2001 From: gvenzl Date: Fri, 25 Oct 2013 21:40:53 +0100 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e9a7476..28c9fc2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,23 @@ ClassFinder =========== -Java Class Finder tool to search jar files for classes +Java Class Finder tool to search .jar and .zip files for Java classes. + +ClassFinder does provide a CLI as well as a GUI. +When no parameters are provided ClassFinder will try to instantiate a GUI on an X11 terminal. +If this isn't successful, either because $DISPLAY hasn't been exported appropriately or +be cause no X11 terminal exists, the program will automatically print its CLI parameters and exit: + +Usage: java -jar ClassFinder.jar|com.optit.ClassFinder -d [directory] -c [classname] -m -v -help|-h|--help|-? + +[-d] The directory to search in +[-c] The classname to search for +[-m] Match case +[-r] Recursive search (search sub directories) +[-v] Enables verbose output +[-help|--help|-h|-?] Display this help + +The directory specified will be searched recursviely. +The class name can either just be the class name (e.g. String) or the fully qualified name (e.g. java.lang.String) + +Good hunting!