aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/manuals_generated/sisu_manual/man/sisu_remote.8
blob: 94ba07f1028493a8139b6c531d2d19a747cc79bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
.TH "sisu_remote" "1" "2007-09-16" "0.59.0" "SiSU"
.SH
SISU \- REMOTE OPERATIONS,
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

.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 9bdac464998dc3f034fbd8f80df23b83

.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 Mon Sep 24 15:36:17 +0100 2007

.BR
Generated by:
.I SiSU
.I 0.59.0
of 2007w38/0 (2007\-09\-23)

.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.59.0 of 2007w38/0 (2007-09-23)
.TP
* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
.TP
* Last Generated on: Mon Sep 24 15:36:32 +0100 2007
.TP
* SiSU http://www.jus.uio.no/sisu