From e9ed5a153286f8cebccc90fc61f920575160f512 Mon Sep 17 00:00:00 2001
From: defnax <retroshare.project@gmail.com>
Date: Tue, 27 Apr 2010 23:21:35 +0000
Subject: [PATCH] Added Commandline Options to Help Browser

git-svn-id: http://svn.code.sf.net/p/retroshare/code/trunk@2808 b45a01b8-16f6-495d-af2f-9b41ad6348cc
---
 retroshare-gui/src/gui/help/authors.html      | 62 ++++++++---------
 .../src/gui/help/content/content.qrc          |  2 +
 .../src/gui/help/content/de/commandline.html  | 67 +++++++++++++++++++
 .../src/gui/help/content/de/contents.xml      |  2 +-
 .../src/gui/help/content/en/commandline.html  | 67 +++++++++++++++++++
 .../src/gui/help/content/en/contents.xml      |  7 +-
 6 files changed, 173 insertions(+), 34 deletions(-)
 create mode 100644 retroshare-gui/src/gui/help/content/de/commandline.html
 create mode 100644 retroshare-gui/src/gui/help/content/en/commandline.html

diff --git a/retroshare-gui/src/gui/help/authors.html b/retroshare-gui/src/gui/help/authors.html
index e60c7e476..9e9f61740 100644
--- a/retroshare-gui/src/gui/help/authors.html
+++ b/retroshare-gui/src/gui/help/authors.html
@@ -14,57 +14,59 @@
 
 <p></p>
 
-<h1>Lead Developers</h1>
+<h2>Lead Developers</h2>
 <ul>
 <li>&nbsp;<b><a href="mailto:drbob7@users.sourceforge.net">drbob7</a></b></li>
 <li>&nbsp;<b><a href="mailto:defnax@users.sourceforge.net">defnax</a></b></li>
 <li>&nbsp;<b><a href="mailto:csoler@users.sourceforge.net">csoler</a></b></li>
 </ul>
 
-<h1>Active Developers</h1>
+<h2>Active Developers</h2>
+<ul>
+<li>&nbsp;<a href="mailto:joss17@users.sourceforge.net">joss17</a></li>
+<li>&nbsp;<a href="mailto:chrisparker126@users.sourceforge.net">chrisparker126</a></li>
+<li>&nbsp;<a href="mailto:thunder2@users.sourceforge.net">thunder2</a></li>
+<li>&nbsp;<a href="mailto:alexandrut@users.sourceforge.net">alexandrut</a></li>
+<li>&nbsp;<a href="mailto:pacman123@users.sourceforge.net">nishant</a></li>
+</ul>
+
+<h2>The Release Team</h2>
+<ul>
+<li>&nbsp;<a href="mailto:notdefine@users.sourceforge.net">notdefine</a></li>
+<li>&nbsp;<a href="mailto:agent725@users.sourceforge.net">agent725</a></li>
+<li>&nbsp;<a href="mailto:the_mgt@users.sourceforge.net">the_mgt</a></li>
+</ul>
+
+<h2>Past Developers</h2>
 <ul>
 <li>&nbsp;<a href="mailto:beardog_uk@users.sourceforge.net">beardog_uk</a></li>
-<li>&nbsp;<a href="mailto:joss17@users.sourceforge.net">joss17</a></li>
-<li>&nbsp;<a href="mailto:alexandrut@users.sourceforge.net">alexandrut</a></li>
-<li>&nbsp;<a href="mailto:ammorais@users.sourceforge.net">ammorais</a></li>
+<li>&nbsp;<a href="mailto:stockpicker@users.sourceforge.net">stockpicker</a></li>
+<li>&nbsp;<a href="mailto:ewensun@users.sourceforge.net">ewensun</a></li>
+<li>&nbsp;<a href="mailto:cppenthu@users.sourceforge.net">cppenthu</a></li>
+<li>&nbsp;<a href="mailto:rwoodruff91@users.sourceforge.net">rwoodruff91</a></li>
+<li>&nbsp;<a href="mailto:raghu-dev@users.sourceforge.net">raghu-dev</a></li>
 </ul>
 
-<h1>The Release Team</h1>
+<h2>Developed TLV Serialiser</h2>
 <ul>
-<li>&nbsp;<b><a href="mailto:notdefine@users.sourceforge.net">notdefine</a></b></li>
-<li>&nbsp;<b><a href="mailto:agent725@users.sourceforge.net">agent725</a></b></li>
-<li>&nbsp;<b><a href="mailto:the_mgt@users.sourceforge.net">the_mgt</a></b></li>
+<li>&nbsp;<a href="mailto:chrisparker126@users.sourceforge.net">chrisparker126</a></li>
 </ul>
 
-<h1>Past Developers</h1>
+<h2>Developed Search/Channel features</h2>
 <ul>
-<li>&nbsp;<b><a href="mailto:stockpicker@users.sourceforge.net">stockpicker</a></b></li>
-<li>&nbsp;<b><a href="mailto:ewensun@users.sourceforge.net">ewensun</a></b></li>
-<li>&nbsp;<b><a href="mailto:cppenthu@users.sourceforge.net">cppenthu</a></b></li>
-<li>&nbsp;<b><a href="mailto:rwoodruff91@users.sourceforge.net">rwoodruff91</a></b></li>
-<li>&nbsp;<b><a href="mailto:raghu-dev@users.sourceforge.net">raghu-dev</a></b></li>
-</ul>
-
-<h1>Developed TLV Serialiser</h1>
-<ul>
-<li>&nbsp;<b><a href="mailto:chrisparker126@users.sourceforge.net">chrisparker126</a></b></li>
-</ul>
-
-<h1>Developed Search/Channel features</h1>
-<ul>
-<li>&nbsp;<b><a href="mailto:libris@users.sourceforge.net">libris</a></b></li>
-<li>&nbsp;<b><a href="mailto:kashifkaleem@users.sourceforge.net">kashifkaleem</a></b></li>
+<li>&nbsp;<a href="mailto:libris@users.sourceforge.net">libris</a></li>
+<li>&nbsp;<a href="mailto:kashifkaleem@users.sourceforge.net">kashifkaleem</a></li>
 </ul>
 
 
-<h1>Developed Smiley,Skinobject,Chat Skin</h1>
+<h2>Developed Smiley,Skinobject,Chat Skin</h2>
 <ul>
-<li>&nbsp;<b><a href="mailto:kernelpanix@users.sourceforge.net">kernelpanix</a></b></li>
+<li>&nbsp;<a href="mailto:kernelpanix@users.sourceforge.net">kernelpanix</a></li>
 </ul>
 
-<h1>Developed XProgressBar</h1>
+<h2>Developed XProgressBar</h2>
 <ul>
-<li>&nbsp;<b><a href="mailto:xesk@users.sourceforge.net">xEsk (Xesc & Technology 2008)</a></b></li>
+<li>&nbsp;<a href="mailto:xesk@users.sourceforge.net">xEsk (Xesc & Technology 2008)</a></li>
 </ul>
 
 </body>
diff --git a/retroshare-gui/src/gui/help/content/content.qrc b/retroshare-gui/src/gui/help/content/content.qrc
index ab24fd2e8..4acc22c2d 100644
--- a/retroshare-gui/src/gui/help/content/content.qrc
+++ b/retroshare-gui/src/gui/help/content/content.qrc
@@ -5,10 +5,12 @@
     <file>en/index.html</file>
     <file>en/config.html</file>
     <file>en/links.html</file>
+    <file>en/commandline.html</file>
     <!-- German -->
     <file>de/contents.xml</file>
     <file>de/index.html</file>
     <file>de/links.html</file>
+    <file>de/commandline.html</file>
   </qresource>
 </RCC>
 
diff --git a/retroshare-gui/src/gui/help/content/de/commandline.html b/retroshare-gui/src/gui/help/content/de/commandline.html
new file mode 100644
index 000000000..700e2439c
--- /dev/null
+++ b/retroshare-gui/src/gui/help/content/de/commandline.html
@@ -0,0 +1,67 @@
+<!--/****************************************************************
+ * This file is distributed under the following license:
+ *
+ * Copyright (c) 2008, defnax
+ * Copyright (c) 2008, edmanm
+ *
+ *  This program is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU General Public License
+ *  as published by the Free Software Foundation; either version 2
+ *  of the License, or (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, 
+ *  Boston, MA  02110-1301, USA.
+ ****************************************************************
+-->
+
+<html>
+<body>
+
+<h1>Kommandozeilen-Optionen</h1>
+<hr />
+
+<p>
+Kommandozeilen-Optionen für retroshare-nogui. 
+</p>
+
+<a name="commands"/>
+<h3>Kommandozeilen-Befehle :</h3>
+
+<ul>
+  <li><b>-h Show the help </b></li>
+  <li><b>-l [logfile] Set the logfilename  </b></li>
+  <li><b>-w [password] Set the password  </b></li>
+  <li><b>-i [ip_adress] Set IP Adress to use </b></li>
+  <li><b>-p [port] Set the Port to listen on  </b></li>
+  <li><b>-c [basedir] Set the config basdir</b></li>
+  <li><b>-s Output to Stderr  </b></li>
+  <li><b>-d [debuglevel] Set the debuglevel  </b></li>
+  <li><b>-u Only listen to UDP  </b></li>
+  <li><b>-e Use a forwarded external Port </b></li>
+  <li><b>-U username (ssl id) to login with </b></li>
+</ul>
+
+<a name="example"/>
+<h3>Beispiel:</h3>
+
+<ul>
+  <li><b>./retroshare-nogui -w meingeheimespasswort -e </b></li>
+</ul>
+  
+
+
+
+
+
+
+
+</body>
+</html>
+
diff --git a/retroshare-gui/src/gui/help/content/de/contents.xml b/retroshare-gui/src/gui/help/content/de/contents.xml
index 9b666cc82..f7f0a4482 100644
--- a/retroshare-gui/src/gui/help/content/de/contents.xml
+++ b/retroshare-gui/src/gui/help/content/de/contents.xml
@@ -11,7 +11,7 @@
 -->
 
 <Contents name="RetroShare Hilfe" html="index.html">
-
+  <Topic id="commands" name="Kommandozeilen-Optionen" html="commandline.html"/>
   <Topic id="links" name="N&#252;tzliche Links" html="links.html"/>
 </Contents>
 
diff --git a/retroshare-gui/src/gui/help/content/en/commandline.html b/retroshare-gui/src/gui/help/content/en/commandline.html
new file mode 100644
index 000000000..e3f5ec8e3
--- /dev/null
+++ b/retroshare-gui/src/gui/help/content/en/commandline.html
@@ -0,0 +1,67 @@
+<!--/****************************************************************
+ * This file is distributed under the following license:
+ *
+ * Copyright (c) 2008, defnax
+ * Copyright (c) 2008, edmanm
+ *
+ *  This program is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU General Public License
+ *  as published by the Free Software Foundation; either version 2
+ *  of the License, or (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, 
+ *  Boston, MA  02110-1301, USA.
+ ****************************************************************
+-->
+
+<html>
+<body>
+
+<h1>Commandline Options</h1>
+<hr />
+
+<p>
+The commandline options are for retroshare-nogui, a headless server in a shell, or systems without QT. 
+</p>
+
+<a name="commands"/>
+<h3>Commands:</h3>
+
+<ul>
+  <li><b>-h Show the help </b></li>
+  <li><b>-l [logfile] Set the logfilename  </b></li>
+  <li><b>-w [password] Set the password  </b></li>
+  <li><b>-i [ip_adress] Set IP Adress to use </b></li>
+  <li><b>-p [port] Set the Port to listen on  </b></li>
+  <li><b>-c [basedir] Set the config basdir</b></li>
+  <li><b>-s Output to Stderr  </b></li>
+  <li><b>-d [debuglevel] Set the debuglevel  </b></li>
+  <li><b>-u Only listen to UDP  </b></li>
+  <li><b>-e Use a forwarded external Port </b></li>
+  <li><b>-U username (ssl id) to login with </b></li>
+</ul>
+
+<a name="example"/>
+<h3>Example:</h3>
+
+<ul>
+  <li><b>./retroshare-nogui -w mysecretpassword -e </b></li>
+</ul>
+  
+
+
+
+
+
+
+
+</body>
+</html>
+
diff --git a/retroshare-gui/src/gui/help/content/en/contents.xml b/retroshare-gui/src/gui/help/content/en/contents.xml
index 4b6ef1a51..a317ea427 100644
--- a/retroshare-gui/src/gui/help/content/en/contents.xml
+++ b/retroshare-gui/src/gui/help/content/en/contents.xml
@@ -1,7 +1,7 @@
 <!--/****************************************************************
- * This file is distributed under the following license:
- *
- * Copyright (c) 2008, defnax
+ * This file is distributed under the following license:
+ *
+ * Copyright (c) 2008, defnax
  * Copyright (c) 2008, edmanm
  *
  *  This program is free software; you can redistribute it and/or
@@ -28,6 +28,7 @@
     <Topic id="directories" name="Directories Settings" html="config.html" section="directories"/>
     <Topic id="appearance" name="Appearance Settings" html="config.html" section="appearance"/>
   </Topic>
+  <Topic id="commands" name="Commandline Options" html="commandline.html"/>
   <Topic id="links" name="Helpful Links" html="links.html"/>
 </Contents>