aboutsummaryrefslogtreecommitdiffhomepage
path: root/man/man8/sisu_remote.8
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2007-09-23 05:16:21 +0100
committerRalph Amissah <ralph@amissah.com>2007-09-23 05:16:21 +0100
commit50d45c6deb0afd2e4222d2e33a45487a9d1fa676 (patch)
tree100c62d678f009139999bf77c26c81653a721eeb /man/man8/sisu_remote.8
parentsisu-0.58.3 + md5s (diff)
primarily todo with sisu documentation, changelog reproduced below:
* start documenting sisu using sisu * sisu markup source files in data/doc/sisu/sisu_markup_samples/sisu_manual/ /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ * default output [sisu -3] in data/doc/manuals_generated/sisu_manual/ /usr/share/doc/manuals_generated/sisu_manual/ (adds substantially to the size of sisu package!) * help related edits * manpage, work on ability to generate manpages, improved * param, exclude footnote mark count when occurs within code block * plaintext changes made * shared_txt, line wrap visited * file:// link option introduced (in addition to existing https?:// and ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and hub] * minor adjustments * html url match refinement * css added tiny_center * plaintext * endnotes fix * footnote adjustment to make more easily distinguishable from substantive text * flag -a only [flags -A -e -E dropped] controlled by modifiers --unix/msdos --footnote/endnote * defaults, homepage * renamed homepage (instead of index) implications for modifying skins, which need likewise to have any homepage entry renamed * added link to sisu_manual in homepage * css the css for the default homepage is renamed homepage.css (instead of index.css) [consider removing this and relying on html.css] * ruby version < ruby1.9 * place stop on installation and working with for now [ruby String.strip broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux], 2007-09-18:38/2] * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * debian * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * sisu-doc new sub-package for sisu documentation debian/control and sisu-doc.install
Diffstat (limited to 'man/man8/sisu_remote.8')
-rw-r--r--man/man8/sisu_remote.8251
1 files changed, 251 insertions, 0 deletions
diff --git a/man/man8/sisu_remote.8 b/man/man8/sisu_remote.8
new file mode 100644
index 00000000..9da648f2
--- /dev/null
+++ b/man/man8/sisu_remote.8
@@ -0,0 +1,251 @@
+.TH "sisu_remote" "1" "2007-09-16" "0.58.3" "SiSU"
+.SH
+SISU \- REMOTE OPERATIONS \ [0.58],
+RALPH AMISSAH
+.BR
+
+.SH
+SISU REMOTE OPERATIONS
+.BR
+
+.SH
+1. REMOTE SOURCE DOCUMENTS
+.BR
+
+.BR
+.B 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
+.B SiSU
+documents can either be sisu marked up files in plaintext .sst or .ssm or;
+zipped sisu files, sisupod.zip or filename.ssp
+
+.BR
+.B .sst / .ssm \- sisu text files
+
+.BR
+.B 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.
+
+
+.nf
+ sisu \-3 http://[provide \ url \ to \ valid \ .sst \ or \ .ssm \ file]
+.fi
+
+.BR
+Any of the source documents in the sisu examples page can be used in this way,
+see <http://www.jus.uio.no/sisu/SiSU/2.html> and use the url for the desired
+document.
+
+.BR
+NOTE: to set up a remote machine to serve
+.B SiSU
+documents in this way, images should be in the directory relative to the
+document source ../_sisu/image
+
+.BR
+.B sisupod \- zipped sisu files
+
+.BR
+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.
+
+.BR
+.B 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.
+
+
+.nf
+ sisu \-3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ .ssp \ file]
+.fi
+
+.BR
+Any of the source documents in the sisu examples page can be used in this way,
+see <http://www.jus.uio.no/sisu/SiSU/2.html> and use the url for the desired
+document.
+
+.SH
+REMOTE DOCUMENT OUTPUT
+.BR
+
+.SH
+2. REMOTE OUTPUT
+.BR
+
+.BR
+Once properly configured
+.B SiSU
+output can be automatically posted once generated to a designated remote
+machine using either rsync, or scp.
+
+.BR
+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.
+
+
+.nf
+ sisu \-3R sisu_remote.sst
+.fi
+
+.SH
+2.1 COMMANDS
+
+.TP
+.B \ \-R \ \ [filename/wildcard]
+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
+
+.TP
+.B \ \-r \ \ [filename/wildcard]
+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
+
+.SH
+2.2 CONFIGURATION
+
+.BR
+[expand \ on \ the \ setting \ up \ of \ an \ ssh\-agent \ / \ keychain]
+
+.SH
+3. REMOTE SERVERS
+.BR
+
+.BR
+As
+.B SiSU
+is generally operated using the command line, and works within a Unix type
+environment,
+.B 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.
+
+.SH
+DOCUMENT INFORMATION (METADATA)
+.BR
+
+.SH
+METADATA
+.BR
+
+.BR
+Document Manifest @
+<http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/sisu_manifest.html>
+
+.BR
+.B Dublin Core
+(DC)
+
+.BR
+.I DC tags included with this document are provided here.
+
+.BR
+DC Title:
+.I SiSU \- Remote Operations \ [0.58]
+
+.BR
+DC Creator:
+.I Ralph Amissah
+
+.BR
+DC Rights:
+.I Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL
+3
+
+.BR
+DC Type:
+.I information
+
+.BR
+DC Date created:
+.I 2002\-08\-28
+
+.BR
+DC Date issued:
+.I 2002\-08\-28
+
+.BR
+DC Date available:
+.I 2002\-08\-28
+
+.BR
+DC Date modified:
+.I 2007\-09\-16
+
+.BR
+DC Date:
+.I 2007\-09\-16
+
+.BR
+.B Version Information
+
+.BR
+Sourcefile:
+.I sisu_remote.sst
+
+.BR
+Filetype:
+.I SiSU text 0.58
+
+.BR
+Sourcefile Digest, MD5(sisu_remote.sst)=
+.I 5fe0c81eddcd7e3e18608b8e48b3ccad
+
+.BR
+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)=
+.I 20fc43cf3eb6590bc3399a1aef65c5a9
+
+.BR
+.B Generated
+
+.BR
+Document (metaverse) last generated:
+.I Sun Sep 23 01:14:02 +0100 2007
+
+.BR
+Generated by:
+.I SiSU
+.I 0.58.3
+of 2007w36/4 (2007\-09\-06)
+
+.BR
+Ruby version:
+.I ruby 1.8.6 (2007\-06\-07 patchlevel 36) \ [i486\-linux]
+
+
+.TP
+Other versions of this document:
+.TP
+manifest: <http://www.jus.uio.no/sisu/sisu_remote/sisu_manifest.html>
+.TP
+html: <http://www.jus.uio.no/sisu/sisu_remote/toc.html>
+.TP
+pdf: <http://www.jus.uio.no/sisu/sisu_remote/portrait.pdf>
+.TP
+pdf: <http://www.jus.uio.no/sisu/sisu_remote/landscape.pdf>
+." .TP
+." manpage: http://www.jus.uio.no/sisu/sisu_remote/sisu_remote.1
+.TP
+at: <http://www.jus.uio.no/sisu>
+.TP
+.TP
+* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06)
+.TP
+* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
+.TP
+* Last Generated on: Sun Sep 23 01:14:07 +0100 2007
+.TP
+* SiSU http://www.jus.uio.no/sisu