aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/manuals_generated/sisu_manual/sisu_remote/scroll.xhtml
blob: 1a80e3c9cb5b186db24354799127382a3ee8dc4a (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
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?xml-stylesheet type="text/css" href="../_sisu/css/xhtml.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:20 +0100 2007
     * SiSU http://www.jus.uio.no/sisu
-->

<document>
<head>
	<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
	<meta>Title:</meta>
	<title class="dc">
		SiSU - Remote Operations [0.58]
	</title>
	<br />
	<meta>Creator:</meta>
	<creator class="dc">
		Ralph Amissah
	</creator>
	<br />
	<meta>Rights:</meta>
	<rights class="dc">
		Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
	</rights>
	<br />
	<meta>Type:</meta>
	<type class="dc">
		information
	</type>
	<br />
	<meta>Subject:</meta>
	<subject class="dc">
		ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
	</subject>
	<br />
	<meta>Date created:</meta>
	<date_created class="extra">
		2002-08-28
	</date_created>
	<br />
	<meta>Date issued:</meta>
	<date_issued class="extra">
		2002-08-28
	</date_issued>
	<br />
	<meta>Date available:</meta>
	<date_available class="extra">
		2002-08-28
	</date_available>
	<br />
	<meta>Date modified:</meta>
	<date_modified class="extra">
		2007-09-16
	</date_modified>
	<br />
	<meta>Date:</meta>
	<date class="dc">
		2007-09-16
	</date>
	<br />
</head>
<body>
<object id="1">
	<text class="h1">
		SiSU - Remote Operations [0.58],<br /> Ralph Amissah
	</text>
	<ocn>1</ocn>
</object>
<object id="2">
	<text class="h2">
		SiSU Remote Operations
	</text>
	<ocn>2</ocn>
</object>
<object id="3">
	<text class="h4">
		1. Remote Source Documents 
	</text>
	<ocn>3</ocn>
</object>
<object id="4">
	<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>
	<ocn>4</ocn>
</object>
<object id="5">
	<text class="norm">
		<b>.sst / .ssm - sisu text files</b>
	</text>
	<ocn>5</ocn>
</object>
<object id="6">
	<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>
	<ocn>6</ocn>
</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">
	<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>
	<ocn>8</ocn>
</object>
<object id="9">
	<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>
	<ocn>9</ocn>
</object>
<object id="10">
	<text class="norm">
		<b>sisupod - zipped sisu files</b>
	</text>
	<ocn>10</ocn>
</object>
<object id="11">
	<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>
	<ocn>11</ocn>
</object>
<object id="12">
	<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>
	<ocn>12</ocn>
</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">
	<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>
	<ocn>14</ocn>
</object>
<object id="15">
	<text class="h3">
		Remote Document Output
	</text>
	<ocn>15</ocn>
</object>
<object id="16">
	<text class="h4">
		2. Remote Output 
	</text>
	<ocn>16</ocn>
</object>
<object id="17">
	<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>
	<ocn>17</ocn>
</object>
<object id="18">
	<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>
	<ocn>18</ocn>
</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>
<object id="20">
	<text class="h5">
		2.1 commands
	</text>
	<ocn>20</ocn>
</object>
<object id="21">
	<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>
	<ocn>21</ocn>
</object>
<object id="22">
	<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>
	<ocn>22</ocn>
</object>
<object id="23">
	<text class="h5">
		2.2 configuration
	</text>
	<ocn>23</ocn>
</object>
<object id="24">
	<text class="norm">
		[expand on the setting up of an ssh-agent / keychain]
	</text>
	<ocn>24</ocn>
</object>
<object id="25">
	<text class="h4">
		3. Remote Servers 
	</text>
	<ocn>25</ocn>
</object>
<object id="26">
	<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>
	<ocn>26</ocn>
</object>
</body>
</document>