Initial: added urpo files!
[urpo] / src / help / index.html
diff --git a/src/help/index.html b/src/help/index.html
new file mode 100644 (file)
index 0000000..d69b8ae
--- /dev/null
@@ -0,0 +1,134 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html><head>
+  
+  <meta content="text/html; charset=ISO-8859-1" http-equiv="content-type">
+  <title>URPO help</title>
+
+  
+</head><body>
+<h1>URPO 0.9</h1>
+
+<br>
+
+<a href="#features">Features</a>&nbsp; <a href="#requiremets">Requirements</a>&nbsp;
+<a href="#keygen">Generating SSH-keys</a>&nbsp; <a href="#Settings">Settings</a>&nbsp;
+<a href="#Printing">Printing</a>&nbsp; <a href="#Debug">Debug</a><br>
+
+<br>
+
+Unix Remote Printing Operation<br>
+
+A Program for printing files via a server<br>
+
+© Arto Hyvättinen 2010<br>
+
+<br>
+
+URPO is free to use according to GPL 3. No guarantees. See <a href="gpl.html">the lisence</a>.<br>
+
+<h3><a name="features"></a>Features<br>
+</h3>
+
+With URPO you can print files to a printer attached to a
+linux/unix-computer. URPO uses the<a href="http://www.cups.org/"> CUPS</a>-system
+on the computer for printing. It is designed for use on a Maemo 5
+device.<br>
+
+<br>
+
+You can print files in all formats supported by CUPS:<br>
+
+<ul>
+
+  <li>Text files</li>
+  <li>PDF</li>
+  <li>PostScript</li>
+  <li>HP-GL/2</li>
+  <li>Image files: BMP, GIF, JPG, PhotoCD, PIX, PNG, PNM, TIFF</li>
+</ul>
+
+<h3><a name="requiremets"></a>Requirements<br>
+</h3>
+
+You need an <a href="http://www.openssh.org/"><span style="font-weight: bold;">openssh</span>-</a>program on your maemo
+device.<br>
+
+On the computer to which the printer is attached to, you need the <span style="font-weight: bold;">cups</span> and <span style="font-weight: bold;">ssh</span>-servers.
+CUPS (Common Unix Printing System) is a printing server, installed by
+default in several linux distributions. The ssh server is needed to
+safely connect to the computer. The port 22 needs to be opened from the
+computer's firewall. There is no need to open a port for cups.<br>
+
+<h3><a name="keygen"></a>Generating SSH-keys</h3>
+
+A SSH key pair is needed to identify the user. The key pair is created
+in the maemo device:<br>
+
+<code>ssh-keygen -t rsa</code><br>
+
+The password is left empty. Remember where you have saved the keys! You
+cannot save them in the MyDocs folder, since the private key must not
+be accessible to others than the user.<br>
+
+<br>
+
+The access rights of the file need to be set:<br>
+
+<code>chmod 600 ~/.ssh/id_urpo</code><br>
+
+<br>
+
+The public key is added to the server (computer) in the home
+folder's&nbsp; .ssh folder's file&nbsp; authorized_keys . You can use
+ssh for transferring it:<br>
+
+<code>cat ~/.ssh/id_urpo | ssh user@computer 'cat &gt;&gt;
+~./ssh/authorized_keys'</code><br>
+
+<br>
+
+The location of the private key is set in the settings of URPO.<br>
+
+<h3><a name="Settings"></a> Settings<br>
+</h3>
+
+When used for the first time URPO asks for settings. You can access
+these settings later by choosing "Settings"&nbsp; from the menu. <span style="font-weight: bold;"></span><br>
+
+<span style="font-weight: bold;">Host name or ip address:</span> The
+computer's&nbsp; (server's) ip address, or its name if the device can
+find it by name.<br>
+
+<span style="font-weight: bold;">Username: </span>The user account on
+the server .<br>
+
+<span style="font-weight: bold;">Identity file</span>: The private
+ssh-key.<br>
+
+<h3><a name="Printing"></a>Printing</h3>
+
+Choose the file to be printed (<span style="font-weight: bold;">Browse</span>).<br>
+
+Choose the printer.<br>
+
+If desired, limit what pages are to be printed, e.g 1,2 or 3-6 or 1,5-7
+.<br>
+
+You can choose 1, 2 or 4 pages to be printed per sheet.<br>
+
+You can print 1-99 copies.<br>
+
+Printing is started with the <span style="font-weight: bold;">Print</span>-button.<br>
+
+<br>
+
+<h3><a name="Debug"></a>Debug-window</h3>
+
+When<span style="font-weight: bold;"> "Debug</span>" is chosen from the
+menu, a debug window opens. Information useful in solving problems,
+such as the commands given to server trough ssh and their output, is
+printed on that window. <br>
+
+<br>
+
+</body></html>
\ No newline at end of file