aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/manuals_generated/sisu_manual/sisu_remote/dom.xml
blob: a372d89f0af5996d2c2cd01aad96e6a3a8537f05 (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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?xml-stylesheet type="text/css" href="../_sisu/css/dom.css"?>
<!-- Document processing information:
     * Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23)
     * Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
     * 
     * Last Generated on: Sun Sep 23 04:12:12 +0100 2007
     * SiSU http://www.jus.uio.no/sisu
-->

<document>

<head>

	<header>
		<meta>Title:</meta>
		<title>
			SiSU - Remote Operations [0.58]
		</title>
	</header>

	<header>
		<meta>Creator:</meta>
		<creator>
			Ralph Amissah
		</creator>
	</header>

	<header>
		<meta>Rights:</meta>
		<rights>
			Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
		</rights>
	</header>

	<header>
		<meta>Type:</meta>
		<type>
			information
		</type>
	</header>

	<header>
		<meta>Subject:</meta>
		<subject>
			ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
		</subject>
	</header>

	<header>
		<meta>Date created:</meta>
		<date_created>
			2002-08-28
		</date_created>
	</header>

	<header>
		<meta>Date issued:</meta>
		<date_issued>
			2002-08-28
		</date_issued>
	</header>

	<header>
		<meta>Date available:</meta>
		<date_available>
			2002-08-28
		</date_available>
	</header>

	<header>
		<meta>Date modified:</meta>
		<date_modified>
			2007-09-16
		</date_modified>
	</header>

	<header>
		<meta>Date:</meta>
		<date>
			2007-09-16
		</date>
	</header>






</head>

<body>

<heading1>
	<heading>
		<object id="1">
			<ocn>1</ocn>
			<text>SiSU - Remote Operations [0.58],<br /> Ralph Amissah</text>
		</object>
	</heading>

	<heading2>
		<heading>
			<object id="2">
				<ocn>2</ocn>
				<text>SiSU Remote Operations</text>
			</object>
		</heading>

			<contents1>
				<heading>
					<object id="3">
						<ocn>3</ocn>
						<nametag>remote_source</nametag>

						<text>1. Remote Source Documents </text>
					</object>
				</heading>
					<content>

						<object id="4">


							<ocn>4</ocn>


							<text class="norm"><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</text>

						</object>


						<object id="5">


							<ocn>5</ocn>


							<text class="norm"><b>.sst / .ssm - sisu text files</b></text>

						</object>


						<object id="6">


							<ocn>6</ocn>


							<text class="norm"><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.</text>

						</object>


						<object id="7">


							<ocn>7</ocn>


							<text class="code">	

								&#160;&#160; &nbsp;&nbsp;sisu -3 http://[provide url to valid .sst or .ssm file]&#160;&#160;&#160;&#160;	

							</text>

						</object>


						<object id="8">


							<ocn>8</ocn>


							<text class="norm">Any of the source documents in the sisu examples page can be used in this way, see &lt;<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/SiSU/2.html">http://www.jus.uio.no/sisu/SiSU/2.html</link>&gt; and use the url for the desired document.</text>

						</object>


						<object id="9">


							<ocn>9</ocn>


							<text class="norm">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 source ../_sisu/image</text>

						</object>


						<object id="10">


							<ocn>10</ocn>


							<text class="norm"><b>sisupod - zipped sisu files</b></text>

						</object>


						<object id="11">


							<ocn>11</ocn>


							<text class="norm">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.</text>

						</object>


						<object id="12">


							<ocn>12</ocn>


							<text class="norm"><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.</text>

						</object>


						<object id="13">


							<ocn>13</ocn>


							<text class="code">	

								&#160;&#160; &nbsp;&nbsp;sisu -3 http://[provide url to valid sisupod.zip or .ssp file]&#160;&#160;&#160;&#160;	

							</text>

						</object>


						<object id="14">


							<ocn>14</ocn>


							<text class="norm">Any of the source documents in the sisu examples page can be used in this way, see &lt;<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/SiSU/2.html">http://www.jus.uio.no/sisu/SiSU/2.html</link>&gt; and use the url for the desired document.</text>

						</object>


					</content>

		</contents1>

		<heading3>
			<heading>
				<object id="15">
					<ocn>15</ocn>
					<text>Remote Document Output</text>
				</object>
			</heading>

			<contents1>
				<heading>
					<object id="16">
						<ocn>16</ocn>
						<nametag>remote_output</nametag>

						<text>2. Remote Output </text>
					</object>
				</heading>
					<content>

						<object id="17">


							<ocn>17</ocn>


							<text class="norm">Once properly configured <b>SiSU</b> output can be automatically posted once generated to a designated remote machine using either rsync, or scp.</text>

						</object>


						<object id="18">


							<ocn>18</ocn>


							<text class="norm">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.</text>

						</object>


						<object id="19">


							<ocn>19</ocn>


							<text class="code">	

								&#160;&#160; &nbsp;&nbsp;sisu -3R sisu_remote.sst&#160;&#160;&#160;&#160;	

							</text>

						</object>


					</content>

				<contents2>
					<heading>
						<object id="20">
							<ocn>20</ocn>
							<nametag>2.1</nametag>

							<text>2.1 commands</text>
						</object>
					</heading>
					<content>

						<object id="21">


							<ocn>21</ocn>


							<text class="norm"><b>-R [filename/wildcard] </b><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</text>

						</object>


						<object id="22">


							<ocn>22</ocn>


							<text class="norm"><b>-r [filename/wildcard] </b><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</text>

						</object>


					</content>

				</contents2>

				<contents2>
					<heading>
						<object id="23">
							<ocn>23</ocn>
							<nametag>2.2</nametag>

							<text>2.2 configuration</text>
						</object>
					</heading>
					<content>

						<object id="24">


							<ocn>24</ocn>


							<text class="norm">[expand on the setting up of an ssh-agent / keychain]</text>

						</object>


					</content>

			</contents2>

			</contents1>

			<contents1>
				<heading>
					<object id="25">
						<ocn>25</ocn>
						<nametag>remote_servers</nametag>

						<text>3. Remote Servers </text>
					</object>
				</heading>
					<content>

						<object id="26">


							<ocn>26</ocn>


							<text class="norm">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.</text>

						</object>


					</content>
			</contents1>

		</heading3>

	</heading2>

</heading1>

</body>

</document>