aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/html/sisu_remote.8.html
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/html/sisu_remote.8.html')
-rw-r--r--data/doc/sisu/html/sisu_remote.8.html187
1 files changed, 187 insertions, 0 deletions
diff --git a/data/doc/sisu/html/sisu_remote.8.html b/data/doc/sisu/html/sisu_remote.8.html
new file mode 100644
index 00000000..3f731762
--- /dev/null
+++ b/data/doc/sisu/html/sisu_remote.8.html
@@ -0,0 +1,187 @@
+<!-- manual page source format generated by PolyglotMan v3.2, -->
+<!-- available at http://polyglotman.sourceforge.net/ -->
+
+<html>
+<head>
+<title>"sisu_remote"("1") manual page</title>
+</head>
+<body bgcolor='white'>
+<a href='#toc'>Table of Contents</a><p>
+SISU - REMOTE OPERATIONS &nbsp;[0.58], RALPH AMISSAH
+<p> SISU REMOTE OPERATIONS
+
+<p> 1. REMOTE SOURCE DOCUMENTS
+<p> <b>SiSU</b> processing instructions can be run against
+remote source documents by providing the url of the documents against which
+the processing instructions are to be carried out. The remote <b>SiSU</b> documents
+can either be sisu marked up files in plaintext .sst or .ssm or; zipped sisu
+files, sisupod.zip or filename.ssp
+<p> <b>.sst / .ssm - sisu text files</b>
+<p> <b>SiSU</b> can
+be run against source text files on a remote machine, provide the processing
+instruction and the url. The source file and any associated parts (such
+as images) will be downloaded and generated locally.
+<p>
+<p> <br>
+<pre> sisu -3 http://[provide &nbsp;url &nbsp;to &nbsp;valid &nbsp;.sst &nbsp;or &nbsp;.ssm &nbsp;file]
+</pre>
+<p> Any of the source documents in the sisu examples page can be used in
+this way, see &lt;<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a>
+&gt; and use the url for the
+desired document.
+<p> NOTE: to set up a remote machine to serve <b>SiSU</b> documents
+in this way, images should be in the directory relative to the document
+
+<p>source ../_sisu/image
+<p> <b>sisupod - zipped sisu files</b>
+<p> A sisupod is the zipped
+content of a sisu marked up text or texts and any other associated parts
+to the document such as images.
+<p> <b>SiSU</b> can be run against a sisupod on a
+(local or) remote machine, provide the processing instruction and the url,
+the sisupod will be downloaded and the documents it contains generated
+locally.
+<p>
+<p> <br>
+<pre> sisu -3 http://[provide &nbsp;url &nbsp;to &nbsp;valid &nbsp;sisupod.zip &nbsp;or &nbsp;.ssp &nbsp;file]
+</pre>
+<p> Any of the source documents in the sisu examples page can be used in
+this way, see &lt;<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a>
+&gt; and use the url for the
+desired document.
+<p> REMOTE DOCUMENT OUTPUT
+<p> 2. REMOTE OUTPUT
+<p> Once properly
+configured <b>SiSU</b> output can be automatically posted once generated to a
+designated remote machine using either rsync, or scp.
+<p> In order to do this
+some ssh authentication agent and keychain or similar tool will need to
+be configured. Once that is done the placement on a remote host can be done
+seamlessly with the -r (for scp) or -R (for rsync) flag, which may be used
+in conjunction with other processing flags, e.g.
+<p>
+<p> <br>
+<pre> sisu -3R sisu_remote.sst
+</pre>
+<p> 2.1 COMMANDS
+<p>
+<dl>
+
+<dt><b>&nbsp;-R &nbsp;&nbsp;[filename/wildcard]</b> </dt>
+<dd>copies sisu output files to remote
+host using rsync. This requires that sisurc.yml has been provided with information
+on hostname and username, and that you have your different if -R is used
+with other flags from if used alone. Alone the rsync --delete parameter is
+sent, useful for cleaning the remote directory (when -R is used together
+with other flags, it is not). Also see -r
+<p> </dd>
+
+<dt><b>&nbsp;-r &nbsp;&nbsp;[filename/wildcard]</b> </dt>
+<dd>copies sisu
+output files to remote host using scp. This requires that sisurc.yml has
+been provided with information on hostname and username, and that you have
+
+<p>your
+<p> </dd>
+</dl>
+2.2 CONFIGURATION
+<p> [expand &nbsp;on &nbsp;the &nbsp;setting &nbsp;up &nbsp;of &nbsp;an &nbsp;ssh-agent &nbsp;/ &nbsp;keychain]
+
+<p> 3. REMOTE SERVERS
+<p> As <b>SiSU</b> is generally operated using the command line,
+and works within a Unix type environment, <b>SiSU</b> the program and all documents
+can just as easily be on a remote server, to which you are logged on using
+a terminal, and commands and operations would be pretty much the same as
+they would be on your local machine.
+<p> DOCUMENT INFORMATION (METADATA)
+<p>
+METADATA
+<p> Document Manifest @ &lt;<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/sisu_manifest.html</a>
+&gt;
+
+<p> <b>Dublin Core</b> (DC)
+<p> <i>DC</i> tags included with this document are provided here.
+
+<p> DC Title: <i>SiSU</i> - Remote Operations &nbsp;[0.58]
+<p> DC Creator: <i>Ralph</i> Amissah
+<p>
+ DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation,
+
+<p>License GPL 3
+<p> DC Type: <i>information</i>
+<p> DC Date created: <i>2002-08-28</i>
+<p> DC Date
+issued: <i>2002-08-28</i>
+<p> DC Date available: <i>2002-08-28</i>
+<p> DC Date modified: <i>2007-09-16</i>
+
+<p> DC Date: <i>2007-09-16</i>
+<p> <b>Version Information</b>
+<p> Sourcefile: <i>sisu_remote.sst</i>
+
+<p> Filetype: <i>SiSU</i> text 0.58
+<p> Sourcefile Digest, MD5(sisu_remote.sst)= <i>5fe0c81eddcd7e3e18608b8e48b3ccad</i>
+
+<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)=
+
+<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i>
+<p> <b>Generated</b>
+<p> Document (metaverse) last
+generated: <i>Sun</i> Sep 23 01:14:02 +0100 2007
+<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of
+2007w36/4 (2007-09-06)
+<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36)
+&nbsp;[i486-linux]
+<p>
+<p>
+<dl>
+
+<dt>Other versions of this document: </dt>
+<dd></dd>
+
+<dt>manifest: &lt;<a href='http://www.jus.uio.no/sisu/sisu_remote/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_remote/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_remote/sisu_manifest.html</a>
+</a>
+&gt;
+</dt>
+<dd></dd>
+
+<dt>html: &lt;<a href='http://www.jus.uio.no/sisu/sisu_remote/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_remote/toc.html'>http://www.jus.uio.no/sisu/sisu_remote/toc.html</a>
+</a>
+&gt; </dt>
+<dd></dd>
+
+<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu_remote/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_remote/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_remote/portrait.pdf</a>
+</a>
+&gt;
+</dt>
+<dd></dd>
+
+<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu_remote/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_remote/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_remote/landscape.pdf</a>
+</a>
+&gt; </dt>
+<dd> </dd>
+
+<dt>at: &lt;<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
+</a>
+&gt;
+</dt>
+<dd></dd>
+
+<dt>* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06) </dt>
+<dd></dd>
+
+<dt>* Ruby version: ruby
+1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt>
+<dd></dd>
+
+<dt>* Last Generated on: Sun Sep 23
+01:14:07 +0100 2007 </dt>
+<dd></dd>
+
+<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
+ </dt>
+<dd></dd>
+</dl>
+<p>
+</body>
+</html>