summaryrefslogtreecommitdiffstats
path: root/data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst')
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst88
1 files changed, 88 insertions, 0 deletions
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst
new file mode 100644
index 0000000..959fbcf
--- /dev/null
+++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst
@@ -0,0 +1,88 @@
+% SiSU 4.0
+
+@title: SiSU
+ :subtitle: Remote Operations
+
+@creator:
+ :author: Amissah, Ralph
+
+@date:
+ :published: 2007-09-16
+ :created: 2002-08-28
+ :issued: 2002-08-28
+ :available: 2002-08-28
+ :modified: 2012-10-03
+
+@rights:
+ :copyright: Copyright (C) Ralph Amissah 2007
+ :license: GPL 3 (part of SiSU documentation)
+
+@classify:
+ :topic_register: electronic documents:SiSU:document:remote;SiSU:manual:remote;electronic documents:SiSU:manual:remote;SiSU:document:remote;SiSU:document:remote
+ :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
+
+:A~? @title @creator
+
+:B~? SiSU Remote Operations
+
+1~remote_source Remote Source Documents
+
+SiSU 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 SiSU documents can either be sisu marked up files in plaintext .sst or .ssm or; zipped sisu files, sisupod.zip or filename.ssp
+
+!_ .sst / .ssm - sisu text files
+
+SiSU 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.
+
+code{
+
+sisu -3 http://[provide url to valid .sst or .ssm file]
+
+}code
+
+Any of the source documents in the sisu examples page can be used in this way, see http://www.jus.uio.no/sisu/SiSU/examples.html and use the url to the .sst for the desired document.
+
+NOTE: to set up a remote machine to serve SiSU documents in this way, images should be in the directory relative to the document source ../_sisu/image
+
+!_ sisupod - zipped sisu files
+
+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.
+
+SiSU 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.
+
+code{
+
+sisu -3 http://[provide url to valid sisupod.zip or .ssp file]
+
+}code
+
+Any of the source documents in the sisu examples page can be used in this way, see http://www.jus.uio.no/sisu/SiSU/examples.html and use the url for the desired document.
+
+:C~ Remote Document Output
+
+1~remote_output Remote Output
+
+Once properly configured SiSU output can be automatically posted once generated to a designated remote machine using either rsync, or scp.
+
+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.
+
+code{
+
+sisu -3R sisu_remote.sst
+
+}code
+
+2~ commands
+
+!_ -R [filename/wildcard] <br>
+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 "keys" and ssh agent in place. Note the behavior of rsync 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
+
+!_ -r [filename/wildcard] <br>
+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 your "keys" and ssh agent in place. Also see -R
+
+2~ configuration
+
+[expand on the setting up of an ssh-agent / keychain]
+
+1~remote_servers Remote Servers
+
+As SiSU is generally operated using the command line, and works within a Unix type environment, SiSU 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.