X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=Instance.java;h=d0d1c84ab7643b65b34a91859a1b75ca59533091;hb=42cdf6f0c7a4d9175bd5c75dc3adc3a4bcc731bc;hp=f48d05b7d4cd84994eeb7e5e238018e99317afbd;hpb=2e1300b9580ae1b6dded5a734c617a66a116c16d;p=fanfix.git

diff --git a/Instance.java b/Instance.java
index f48d05b..d0d1c84 100644
--- a/Instance.java
+++ b/Instance.java
@@ -48,8 +48,19 @@ public class Instance {
 	/**
 	 * Initialise the instance -- if already initialised, nothing will happen.
 	 * <p>
-	 * Before calling this method, you may call {@link Bundles#setDirectory(String)}
-	 * if wanted.
+	 * Before calling this method, you may call
+	 * {@link Bundles#setDirectory(String)} if wanted.
+	 * <p>
+	 * Note that this method will honour some environment variables, the 3 most
+	 * important ones probably being:
+	 * <ul>
+	 * <li><tt>DEBUG</tt>: will enable DEBUG output if set to 1 (or Y or TRUE or
+	 * ON, case insensitive)</li>
+	 * <li><tt>CONFIG_DIR</tt>: will use this directory as configuration
+	 * directory (supports $HOME notation, defaults to $HOME/.fanfix</li>
+	 * <li><tt>BOOKS_DIR</tt>: will use this directory as library directory
+	 * (supports $HOME notation, defaults to $HOME/Books</li>
+	 * </ul>
 	 */
 	static public void init() {
 		init(false);
@@ -465,7 +476,6 @@ public class Instance {
 		BasicLibrary lib = null;
 
 		boolean useRemote = config.getBoolean(Config.REMOTE_LIBRARY_ENABLED, false);
-
 		if (useRemote) {
 			String host = null;
 			int port = -1;