-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinstall.html
432 lines (219 loc) · 15.8 KB
/
install.html
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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
<!DOCTYPE HTML>
<html lang="" >
<head>
<title>Installation · GitBook</title>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.0">
<link rel="stylesheet" href="gitbook/style.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="obtaining_test_scripts.html" />
<link rel="prev" href="overview.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="chapter " data-level="1.1" data-path="./">
<a href="./">
Introduction
</a>
</li>
<li class="chapter " data-level="1.2" data-path="help.html">
<a href="help.html">
Getting help
</a>
</li>
<li class="chapter " data-level="1.3" data-path="overview.html">
<a href="overview.html">
System overview
</a>
</li>
<li class="chapter active" data-level="1.4" data-path="install.html">
<a href="install.html">
Installation
</a>
</li>
<li class="chapter " data-level="1.5" data-path="obtaining_test_scripts.html">
<a href="obtaining_test_scripts.html">
Obtaining test scripts
</a>
</li>
<li class="chapter " data-level="1.6" data-path="executing_scripts.html">
<a href="executing_scripts.html">
Executing test scripts to obtain traces
</a>
</li>
<li class="chapter " data-level="1.7" data-path="checking_traces.html">
<a href="checking_traces.html">
Checking the traces using SibylFS
</a>
</li>
<li class="chapter " data-level="1.8" data-path="generating_html.html">
<a href="generating_html.html">
Generating HTML output
</a>
</li>
<li class="chapter " data-level="1.9" data-path="faq.html">
<a href="faq.html">
FAQ
</a>
</li>
<li class="chapter " data-level="1.10" data-path="projects.html">
<a href="projects.html">
Possible projects using SibylFS
</a>
</li>
<li class="chapter " data-level="1.11" data-path="acks.html">
<a href="acks.html">
Acknowledgements
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >Installation</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="installation">Installation</h1><p>The repository for the project is <a href="https://github.com/sibylfs/sibylfs_src" target="_blank">https://github.com/sibylfs/sibylfs_src</a>.</p><p>Nix is a package manager available on Linux (x86-64) and Mac (Darwin,
x86-64) (and possibly others e.g. Linux i686; unfortunately it is not
supported under FreeBSD). SibylFS is also available via nix (see
<a href="#nix-install">Installing with nix</a>). Nix is likely to be more stable
than opam (ie, you are more likely to be able to build using Nix).</p><p>N.B. 2016-07-15 nix changed its hashing function recently;
unfortunately there are two hashing functions now in existence; if you
get a message similar to:</p><pre><code>output path ‘/nix/store/77hcsyrhmr70dp720jdhxqfvzfcqyvlr-lem-5b4a168’ has r:sha256 hash ‘19642yadi089p8si87n0rbn0mwwxyvzjrv33g848gaqy811i0zak’ when ‘0z1chfa2q4h7rdzabyjjh3zhgdafjhjhxyna5hd6q11ns88v7xds’ was expected</code></pre>
<p>then you are probably running into this problem; the fix is on branch
<code>2016-07-14_fix_nix</code> from github.</p><p>OPAM is the OCaml Package Manager which manages sets of complete OCaml
package development environments per user. It's available on Linux, OS
X, and FreeBSD. See <a href="#opam-install">Installing with OPAM</a> and <a href="#opam-develop">Developing
with OPAM</a> for instructions.</p><p>On Linux, the simplest way to install is using prebuilt binaries via nix
(see <a href="#nix-binaries">Installing binaries with nix</a>).</p><!-- Potentially quicker, but fragile, is to
install "plain binaries". -->
<h2 id="installing-with-opam"><a name="opam-install"></a> Installing with OPAM</h2><ul><li><p>Install <em>opam</em></p><ul><li><p><a href="http://opam.ocaml.org/doc/Install.html#OSX" target="_blank">On OS X</a></p></li>
<li><p><a href="http://opam.ocaml.org/doc/Install.html#Ubuntu" target="_blank">On Ubuntu</a></p></li>
<li><p><a href="http://opam.ocaml.org/doc/Install.html" target="_blank">On other operating systems</a></p></li></ul>
</li></ul>
<ul><li>Ensure you have loaded OPAM's configuration into <code>bash</code> with
</li></ul>
<pre><code>eval `opam config env`</code></pre>
<ul><li><p>Or another shell with</p><p>eval <code>opam config env --shell=[sh|csh|zsh|fish]</code></p></li>
<li><p>Run</p></li></ul>
<pre><code>opam install sibylfs</code></pre>
<h2 id="developing-with-opam"><a name="opam-develop"></a> Developing with OPAM</h2><ul><li>Run
</li></ul>
<pre><code>git clone https://github.com/sibylfs/sibylfs_src
opam pin add sibylfs sibylfs_src</code></pre>
<h2 id="installing-with-nix"><a name="nix-install"></a> Installing with nix</h2><ul><li>Install nix following <a href="https://nixos.org/nix/" target="_blank">https://nixos.org/nix/</a> : type
</li></ul>
<pre><code>curl https://nixos.org/nix/install | sh</code></pre>
<p>This requires
root access; alternatives without root are described at
<a href="https://nixos.org/wiki/How_to_install_nix_in_home_(on_another_distribution" target="_blank">https://nixos.org/wiki/How<em>to_install_nix_in_home</em>(on_another_distribution)</a>)</p><ul><li>Use git to clone the SibylFS source code:
</li></ul>
<pre><code>git clone https://github.com/sibylfs/sibylfs_src</code></pre>
<ul><li><p>This will create a directory <code>sibylfs_src</code>. In the following, paths starting
with <code>sibylfs_src/</code> refer to this directory.</p></li>
<li><p>Change to the <code>sibylfs_src/</code> directory:</p></li></ul>
<pre><code>cd sibylfs_src/</code></pre>
<ul><li>Build SibylFS (this may take a long time) by typing:
</li></ul>
<pre><code>nix-build</code></pre>
<ul><li>Install SibylFS by typing:
</li></ul>
<pre><code>nix-env -i ./result</code></pre>
<p>An example install is as follows:</p><p><a href="https://asciinema.org/a/c4nxhmnn1ctsi1w1615wzgrrf" target="_blank"><img alt="asciicast" src="https://asciinema.org/a/c4nxhmnn1ctsi1w1615wzgrrf.png"></a></p><h2 id="installing-prebuilt-binaries-via-nix-linux-mac"><a name="nix-binaries"></a> Installing prebuilt binaries via nix (Linux, Mac)</h2><ul><li><p>Install nix as above</p></li>
<li><p>Follow the instructions to make sure your environment is set up:</p></li></ul>
<pre><code>. <your home directory>/.nix-profile/etc/profile.d/nix.sh</code></pre>
<ul><li><p>Download the prebuilt binaries for your platform. Go to the binary releases page <a href="https://github.com/sibylfs/sibylfs_binaries/releases" target="_blank">https://github.com/sibylfs/sibylfs_binaries/releases</a>, select the newest release, and download the closure file that corresponds to your architecture:</p><ul><li>Linux 64-bit binaries: <code>sibylfs_nix_linux_amd64.closure</code>
</li>
<li>Mac OS X 10.10.3 (and maybe others) 64-bit binaries: <code>sibylfs_nix_mac_amd64.closure</code>
</li></ul>
</li>
<li><p>Place the binaries in the nix store:</p></li></ul>
<pre><code>nix-store --import < [path to downloaded binay]</code></pre>
<ul><li>This will print various entries; the last entry will be a path to sibylfs, something like:
<code>/nix/store/f77518afhrq1jsih7rgr5y2gc9v8zsi3-fs_test</code>. Now install the binaries into your path:
</li></ul>
<pre><code>nix-env -i /nix/store/f77518afhrq1jsih7rgr5y2gc9v8zsi3-fs_test # N.B. replace this with the path from the import!</code></pre>
<h2 id="installing-plain-binaries-linux">Installing plain binaries (Linux)</h2><p><strong><em>This option is not really supported</em></strong>, but is probably the
quickest way to install (if it works). Go to
<a href="https://github.com/sibylfs/sibylfs_binaries/releases/" target="_blank">https://github.com/sibylfs/sibylfs_binaries/releases/</a>, select the
latest release, and download the <code>.tar.gz</code> file corresponding to your OS
and architecture (eg <code>sibylfs_linux_amd64.tar.gz</code> for Linux, 64
bit). Unpack this file:</p><pre><code>tar xvzf <file you downloaded></code></pre>
<p>This should create a directory <code>sibylfs/bin</code> containing the
executables. You should place these on your path (or execute from
inside that directory).</p><h2 id="after-installation">After installation</h2><p>SibylFS provides several command-line tools. <code>fs_test --help</code> displays a
man page showing the various subcommands available (check, clean, exec
etc.). Each subcommand also has online help available. For instance, for
the check subcommand usage information is available via <code>fs_test check --help</code>.</p>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="overview.html" class="navigation navigation-prev " aria-label="Previous page: System overview">
<i class="fa fa-angle-left"></i>
</a>
<a href="obtaining_test_scripts.html" class="navigation navigation-next " aria-label="Next page: Obtaining test scripts">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Installation","level":"1.4","depth":1,"next":{"title":"Obtaining test scripts","level":"1.5","depth":1,"path":"obtaining_test_scripts.md","ref":"obtaining_test_scripts.md","articles":[]},"previous":{"title":"System overview","level":"1.3","depth":1,"path":"overview.md","ref":"overview.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"install.md","mtime":"2016-07-15T15:42:36.475Z","type":"markdown"},"gitbook":{"version":"3.2.0","time":"2016-07-15T15:42:46.577Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="gitbook/gitbook-plugin-search/search.js"></script>
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
</body>
</html>