From 18e57d19db0e244a8cf91fe3b734eb5abc97503e Mon Sep 17 00:00:00 2001
From: zzz <zzz@mail.i2p>
Date: Sun, 22 May 2011 14:31:56 +0000
Subject: [PATCH] doc update
---
INSTALL-headless.txt | 26 +++++++++++++-------------
INSTALL.txt | 28 +++++++++++++++++++++-------
LICENSE.txt | 16 +++++++++++-----
README.txt | 8 ++++----
4 files changed, 49 insertions(+), 29 deletions(-)
diff --git a/INSTALL-headless.txt b/INSTALL-headless.txt
index c009bac206..1907311f6e 100644
--- a/INSTALL-headless.txt
+++ b/INSTALL-headless.txt
@@ -1,4 +1,4 @@
-Headless I2P installation instructions
+Headless (console mode) I2P installation instructions
1) java -jar i2pinstall.exe -console (you've already done this)
@@ -6,9 +6,9 @@ This will run the installer in text mode, including running the postinstall.sh
script. After that, you may run 'sh i2prouter start'
which will start the router and attempt to launch a browser.
-If you do not have an X server running, the browser launch will probably fail, and
+If you do not have an X server running, the browser launch may fail, and
you may use:
- lynx http://localhost:7657/index.jsp
+ lynx http://localhost:7657/
to configure the router.
If you're having trouble, swing by http://forum.i2p2.de/, check the
@@ -24,22 +24,22 @@ edit the files i2prouter (Linux) and wrapper.config (Linux and Windows)
where there are comments labeled "PORTABLE". Do this before you
run I2P for the first time.
-To run I2P explicitly:
+To start I2P:
(*nix): sh i2prouter start
(win*): I2P.exe
- (Platforms unsupported by the wrapper - PPC, ARM, etc): sh runplain.sh
+ (non-x86 platforms PPC, ARM, etc): sh runplain.sh
-To stop the router (gracefully):
- lynx http://localhost:7657/configservice.jsp ("Shutdown gracefully")
+To stop I2P (gracefully):
+ lynx http://localhost:7657/summaryframe (click "Shutdown")
-To stop the router (immediately):
+To stop I2P immediately:
sh i2prouter stop
To uninstall I2P:
- rm -rf $i2pInstallDir
+ rm -rf $I2PInstallDir ~/.i2p
Supported JVMs:
- Windows: Latest available from http://java.sun.com/ (1.5+ supported)
- Linux: Latest available from http://java.sun.com/ (1.5+ supported)
- FreeBSD: Sun 1.5-compatible (NIO required)
- various: http://www.kaffe.org/ Sun 1.5-compatible (NIO required)
+ Windows: Latest available from http://java.com/download (1.5+ supported)
+ Linux: Latest available from http://java.com/download (1.5+ supported)
+ FreeBSD: 1.5-compatible (NIO required)
+ Other operating systems and JVMs: See http://trac.i2p2.de/wiki/java
diff --git a/INSTALL.txt b/INSTALL.txt
index acc220c5e8..47563b5753 100644
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -1,8 +1,8 @@
I2P source installation instructions
Prerequisites to build from source:
- Java SDK (preferably Sun) 1.5.0 or higher (1.6 recommended)
- The SDK must have Pack200 support (java.util.jar.Pack200)
+ Java SDK (preferably Oracle/Sun or OpenJDK) 1.6.0 or higher
+ Non-linux operating systems and JVMs: See http://trac.i2p2.de/wiki/java
Apache Ant 1.7.0 or higher
Optional, For multilanguage support: The xgettext, msgfmt, and msgmerge tools installed
from the GNU gettext package http://www.gnu.org/software/gettext/
@@ -24,10 +24,24 @@ From there, you can run the headless (console mode) installer:
Or run the GUI installer:
java -jar i2pinstall.exe
-Or move the update file into an existing installation directory and restart.
+Or move the i2pupdate.zip file into an existing installation directory and restart.
+
+To start I2P:
+ (*nix): sh i2prouter start
+ (win*): I2P.exe
+ (non-x86 platforms PPC, ARM, etc): sh runplain.sh
+
+To stop I2P (gracefully):
+ lynx http://localhost:7657/summaryframe (click "Shutdown")
+
+To stop I2P immediately:
+ sh i2prouter stop
+
+To uninstall I2P:
+ rm -rf $I2PInstallDir ~/.i2p
Supported JVMs:
- Windows: Latest available from http://java.sun.com/ (1.5+ supported)
- Linux: Latest available from http://java.sun.com/ (1.5+ supported)
- FreeBSD: Sun 1.5-compatible (NIO required)
- various: http://www.kaffe.org/ Sun 1.5-compatible (NIO required)
+ Windows: Latest available from http://java.com/download (1.5+ supported)
+ Linux: Latest available from http://java.com/download (1.5+ supported)
+ FreeBSD: 1.5-compatible (NIO required)
+ Other operating systems and JVMs: See http://trac.i2p2.de/wiki/java
diff --git a/LICENSE.txt b/LICENSE.txt
index 28be433480..08c810e0fa 100644
--- a/LICENSE.txt
+++ b/LICENSE.txt
@@ -56,7 +56,7 @@ Public domain except as listed below:
Copyright (C) 2001, 2002, Free Software Foundation, Inc.
See licenses/LICENSE-LGPLv2.1.txt
- GMP 4.1.3:
+ GMP 4.1.3 / 4.1.4:
Copyright 1991, 1996, 1999, 2000 Free Software Foundation, Inc.
See licenses/LICENSE-LGPLv2.1.txt
@@ -194,6 +194,10 @@ Applications:
Copyright (c) 2003 Direct Information Pvt. Ltd. All Rights Reserved.
See licenses/LICENSE-GeoIP.txt
+ Router Console and I2PSnark themes:
+ "Man with hat over face" & related images licensed under a Creative Commons 2.0 license.
+ Original photos by Florian Kuhlmann. http://www.flickr.com/photos/floriankuhlmann/3117758155
+
SAM:
Public domain.
@@ -203,6 +207,8 @@ Applications:
SusiDNS:
Copyright (C) 2005 <susi23@mail.i2p>
See licenses/LICENSE-GPLv2.txt
+ Uses Apache Jakarta Standard Tag Library 1.1.2:
+ See licenses/LICENSE-Apache2.0.txt
SusiMail:
Copyright (C) 2004-2005 <susi23@mail.i2p>
@@ -227,6 +233,10 @@ distributions. See the source package for the additional license information.
Atalk:
Public domain
+ BOB Demos:
+ Copyright (C) sponge
+ DWTFYWTPL
+
Desktopgui
Copyright (c) Mathias De Maré
See apps/desktopgui/LICENSE
@@ -244,7 +254,3 @@ distributions. See the source package for the additional license information.
SAM Python Library:
Public domain.
-
- I2PSnark/Console themes:
- "Man with hat over face" & related images licensed under a Creative Commons 2.0 license.
- Original photos by Florian Kuhlmann. http://www.flickr.com/photos/floriankuhlmann/3117758155
diff --git a/README.txt b/README.txt
index c235f89ba0..84424ecf2b 100644
--- a/README.txt
+++ b/README.txt
@@ -1,9 +1,9 @@
Prerequisites to build from source:
- Java SDK (preferably Sun) 1.5.0 or higher (1.6 recommended)
- The SDK must have Pack200 support (java.util.jar.Pack200)
+ Java SDK (preferably Oracle/Sun or OpenJDK) 1.6.0 or higher
+ Non-linux operating systems and JVMs: See http://trac.i2p2.de/wiki/java
Apache Ant 1.7.0 or higher
Optional, For multilanguage support: The xgettext, msgfmt, and msgmerge tools installed
- from the GNU gettext package http://www.gnu.org/software/gettext/
+ from the GNU gettext package http://www.gnu.org/software/gettext/
To build:
ant pkg
@@ -11,7 +11,7 @@ To build:
See INSTALL.txt or http://www.i2p2.de/download.html for installation instructions.
Documentation:
- http://www.i2p2.de/
+ http://www.i2p2.de/how
API: run 'ant javadoc' then start at build/javadoc/index.html
Latest release:
--
GitLab