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
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="Docutils 0.20.1: https://docutils.sourceforge.io/" />
<meta name="author" content="B Daix" />
<meta name="date" content="2003-09-10" />
<title>Managing BRLTTY with Stow</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="managing-brltty-with-stow">
<h1 class="title">Managing BRLTTY with Stow</h1>
<table class="docinfo" frame="void" rules="none">
<col class="docinfo-name" />
<col class="docinfo-content" />
<tbody valign="top">
<tr><th class="docinfo-name">Author:</th>
<td>B Daix</td></tr>
<tr><th class="docinfo-name">Date:</th>
<td>2003-09-10</td></tr>
</tbody>
</table>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#purpose" id="toc-entry-1">Purpose</a></li>
<li><a class="reference internal" href="#why-stow-can-help" id="toc-entry-2">Why Stow can help</a></li>
<li><a class="reference internal" href="#the-procedure" id="toc-entry-3">The procedure</a><ul>
<li><a class="reference internal" href="#compiling-installing-brltty-for-stow-file-management" id="toc-entry-4">Compiling/installing BRLTTY for Stow file management</a></li>
<li><a class="reference internal" href="#managing-safely-kept-versions-with-stow" id="toc-entry-5">Managing safely kept versions with Stow</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="purpose">
<h2><a class="toc-backref" href="#toc-entry-1">Purpose</a></h2>
<p>BRLTTY is a critical software for those who rely on it to access their box.
Upgrading such a tool can't be done without paying some special attention.</p>
<p>What will be explained here is how to keep <tt class="docutils literal">/usr/local/bin/brltty</tt> up to date
without removing old versions. We decide to put BRLTTY in <tt class="docutils literal">/usr/local</tt> as
we don't want to break filesystem root distribution (i.e. <tt class="docutils literal">/bin/brltty</tt>
should only come from a packaged version of BRLTTY for your distribution. If
you install software that adheres to this rule, you'd install it in
<tt class="docutils literal">/usr/local</tt>). Also, we want not to have to keep source files to be able to
remove things cleanly. After installing a software, you shouldn't have to rely
on a by-software uninstallation suite.</p>
<p>You should install Stow to be able to run it and to find more details about it.
It's a common utility:</p>
<dl class="docutils">
<dt>On Debian:</dt>
<dd><tt class="docutils literal"><span class="pre">apt-get</span> install stow</tt></dd>
<dt>On Fedora:</dt>
<dd><tt class="docutils literal">yum install stow</tt></dd>
</dl>
</div>
<div class="section" id="why-stow-can-help">
<h2><a class="toc-backref" href="#toc-entry-2">Why Stow can help</a></h2>
<p>Stow manages files as if they were packaged by creating symlinks
to sets of files, each of which in its own directory, instead of directly copying them.</p>
<p>We recommend to attentively read Stow Info files, to realize what it can do,
how, and specially why it is so useful when you have to manage personally
compiled software you rely on.</p>
</div>
<div class="section" id="the-procedure">
<h2><a class="toc-backref" href="#toc-entry-3">The procedure</a></h2>
<p>So we want to run a BRLTTY version, taken from a set of personally compiled
ones, and safely keep all of them around. The current working release will be run
from the <tt class="docutils literal">/usr/local</tt> root, while the files for all releases will be kept in a "safe
place" - the <strong>Stow directory</strong> (<tt class="docutils literal">/usr/local/stow/</tt>). For example, releases
(bins/configs/libs/mans, not source trees) will be stored there like this:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">/usr/local/stow/brltty-3.2/</span></tt></li>
<li><tt class="docutils literal"><span class="pre">/usr/local/stow/brltty-3.3-with-api/</span></tt></li>
<li><tt class="docutils literal"><span class="pre">/usr/local/stow/brltty-3.3/</span></tt></li>
<li>and so on</li>
</ul>
<div class="section" id="compiling-installing-brltty-for-stow-file-management">
<h3><a class="toc-backref" href="#toc-entry-4">Compiling/installing BRLTTY for Stow file management</a></h3>
<p>We have to use <tt class="docutils literal">configure</tt> flags to indicate we want BRLTTY to be run
From <tt class="docutils literal">/usr/local</tt> root, and installed in <tt class="docutils literal"><span class="pre">/usr/local/stow/brltty-3.2/</span></tt>
root. Stow will do symlinks for us then. The distinction between execution root
and installation root is critical (c.f. Stow Info):</p>
<pre class="literal-block">
./configure --with-execute-root=/usr/local \
--with-install-root=/usr/local/stow/brltty-3.2
</pre>
<p>You may add whatever flags then, except those which change directories as we
already managed this.</p>
<p>Then, simply:</p>
<pre class="literal-block">
make
make install
</pre>
<p>The command:</p>
<pre class="literal-block">
ls /usr/local/stow/brltty-3.2/
</pre>
<p>should show you all what would have been put in <tt class="docutils literal">/usr/local</tt> if we haven't
managed files with Stow.</p>
<p>Reproduce this for each version you want to install, for example, we built a
brltty-3.3-with-api directory by applying above principles and adding dedicated
flag for enabling API to <tt class="docutils literal">configure</tt> command line. We did the same for a
standard brltty-3.3 too, and so on, all stored in <tt class="docutils literal">/usr/local/stow/</tt>. As you
see, we cleanly separate things - one directory per version on one hand,
building vs. using on the other. Testing is now far lighter.</p>
</div>
<div class="section" id="managing-safely-kept-versions-with-stow">
<h3><a class="toc-backref" href="#toc-entry-5">Managing safely kept versions with Stow</a></h3>
<p>Before asking for Stow to create symlinks, we have to be sure we won't get any
conflicts, i.e. we haven't already asked for Stow to create symlinks on the
same software without removing them first, or we don't forget we have already
installed BRLTTY directly:</p>
<pre class="literal-block">
ls /usr/local/{bin,sbin}
</pre>
<p>should be enough to see if we have to clean things up before going any further.
Note we'll see how to use Stow to remove created symlinks just after explaining
how to ask for it to create them (we hope you read from up to below...):</p>
<pre class="literal-block">
cd /usr/local/stow
stow brltty-3.2
</pre>
<p>will create the symlinks, in parent directory. For example:</p>
<ul class="simple">
<li><tt class="docutils literal">ln <span class="pre">-s</span> <span class="pre">brltty-3.2/bin</span> <span class="pre">../bin</span></tt> (if <tt class="docutils literal"><span class="pre">../bin</span></tt> didn't exist)</li>
<li><tt class="docutils literal">ln <span class="pre">-s</span> <span class="pre">brltty-3.2/bin/brltty</span> <span class="pre">../bin/brltty</span></tt> (otherwise)</li>
<li>and so on</li>
</ul>
<p>Now, running <tt class="docutils literal">/usr/local/bin/brltty</tt> will work perfectly, looking for its
config files in <tt class="docutils literal">/usr/local/etc/brltty/</tt> and so on, even if it's all
symlinks - as if BRLTTY-3.2 was installed there.</p>
<p>When you want to switch to another version, you simply have to ask for Stow to
remove symlinks it created:</p>
<pre class="literal-block">
cd /usr/local/stow/
stow -D brltty-3.2 # if current release points to this version
</pre>
<p>and then:</p>
<pre class="literal-block">
stow brltty-3.3-with-api
</pre>
<p>Doesn't it look powerful?!</p>
</div>
</div>
</div>
</body>
</html>
|
