annotate unix-phil.ms @ 41:13ef7042fa28

some rework in ch01; nicer formating
author meillo@marmaro.de
date Fri, 09 Apr 2010 12:44:08 +0200
parents 422679bdf384
children 303e8f449e77
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1 .nr PS 11
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
2 .nr VS 13
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
3 .nr lu 0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
4 .de CW
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
5 .nr PQ \\n(.f
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
6 .if t .ft CW
17
ef67aad148f6 substitutet \a with ^ in CW macro
meillo@marmaro.de
parents: 16
diff changeset
7 .ie ^\\$1^^ .if n .ul 999
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
8 .el .if n .ul 1
17
ef67aad148f6 substitutet \a with ^ in CW macro
meillo@marmaro.de
parents: 16
diff changeset
9 .if t .if !^\\$1^^ \&\\$1\f\\n(PQ\\$2
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
10 .if n .if \\n(.$=1 \&\\$1
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
11 .if n .if \\n(.$>1 \&\\$1\c
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
12 .if n .if \\n(.$>1 \&\\$2
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
13 ..
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
14 .ds [. \ [
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
15 .ds .] ]
1
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
16 .\"----------------------------------------
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
17 .TL
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
18 Why the Unix Philosophy still matters
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
19 .AU
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
20 markus schnalke <meillo@marmaro.de>
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
21 .AB
1
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
22 .ti \n(.iu
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
23 This paper explains the importance of the Unix Philosophy for software design.
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
24 Today, few software designers are aware of these concepts,
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
25 and thus a lot of modern software is more limited than necessary
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
26 and makes less use of software leverage than possible.
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
27 Knowing and following the guidelines of the Unix Philosophy makes software more valuable.
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
28 .AE
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
29
2
fbd7baf6a61f added content about sw design; some formating
meillo@marmaro.de
parents: 1
diff changeset
30 .FS
fbd7baf6a61f added content about sw design; some formating
meillo@marmaro.de
parents: 1
diff changeset
31 .ps -1
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
32 This paper was prepared for the ``Software Analysis'' seminar at University Ulm.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
33 Mentor was professor Schweiggert. 2010-04-05
2
fbd7baf6a61f added content about sw design; some formating
meillo@marmaro.de
parents: 1
diff changeset
34 .br
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
35 You may retrieve this document from
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
36 .CW \s-1http://marmaro.de/docs \ .
2
fbd7baf6a61f added content about sw design; some formating
meillo@marmaro.de
parents: 1
diff changeset
37 .FE
fbd7baf6a61f added content about sw design; some formating
meillo@marmaro.de
parents: 1
diff changeset
38
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
39 .NH 1
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
40 Introduction
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
41 .LP
40
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
42 The Unix Philosophy is the essence of how the Unix operating system,
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
43 especially its toolchest, was designed.
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
44 It is no limited set of fixed rules,
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
45 but a loose set of guidelines which tell how to write software that
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
46 suites well into Unix.
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
47 Actually, the Unix Philosophy describes what is common to typical Unix software.
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
48 The Wikipedia has an accurate definition:
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
49 .[
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
50 %A Wikipedia
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
51 %T Unix philosophy
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
52 %P Wikipedia, The Free Encyclopedia
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
53 %D 2010-03-21 17:20 UTC
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
54 %O .CW \s-1http://en.wikipedia.org/w/index.php?title=Unix_philosophy&oldid=351189719
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
55 .]
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
56 .QP
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
57 .ps -1
40
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
58 The \fIUnix philosophy\fP is a set of cultural norms and philosophical
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
59 approaches to developing software based on the experience of leading
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
60 developers of the Unix operating system.
3
aebbe3e76f5e minor rework
meillo@marmaro.de
parents: 2
diff changeset
61 .PP
40
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
62 As there is no single definition of the Unix Philosophy,
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
63 several people have stated their view on what it comprises.
1
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
64 Best known are:
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
65 .IP \(bu
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
66 Doug McIlroy's summary: ``Write programs that do one thing and do it well.''
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
67 .[
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
68 %A M. D. McIlroy
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
69 %A E. N. Pinson
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
70 %A B. A. Taque
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
71 %T UNIX Time-Sharing System Forward
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
72 %J The Bell System Technical Journal
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
73 %D 1978
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
74 %V 57
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
75 %N 6
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
76 %P 1902
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
77 .]
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
78 .IP \(bu
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
79 Mike Gancarz' book ``The UNIX Philosophy''.
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
80 .[
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
81 %A Mike Gancarz
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
82 %T The UNIX Philosophy
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
83 %D 1995
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
84 %I Digital Press
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
85 .]
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
86 .IP \(bu
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
87 Eric S. Raymond's book ``The Art of UNIX Programming''.
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
88 .[
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
89 %A Eric S. Raymond
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
90 %T The Art of UNIX Programming
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
91 %D 2003
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
92 %I Addison-Wesley
2
fbd7baf6a61f added content about sw design; some formating
meillo@marmaro.de
parents: 1
diff changeset
93 %O .CW \s-1http://www.faqs.org/docs/artu/
1
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
94 .]
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
95 .LP
1
9b555c009f19 further text in intro
meillo@marmaro.de
parents: 0
diff changeset
96 These different views on the Unix Philosophy have much in common.
40
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
97 Especially, the main concepts are similar in all of them.
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
98 McIlroy's definition can surely be called the core of the Unix Philosophy,
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
99 but the fundamental idea behind it all, is ``small is beautiful''.
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
100
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
101 .PP
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
102 The Unix Philosophy tells how to design and write good software for Unix.
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
103 Many concepts described here base on facilities of Unix.
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
104 Other operating systems may not offer such facilities,
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
105 hence it may not be possible to design software in the way of the
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
106 Unix Philosophy for them.
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
107 .PP
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
108 The Unix Philosophy has an idea of how the process of software development
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
109 should look like, but large parts of the philosophy are quite independent
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
110 from the development process used.
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
111 However, one will soon recognize that some development processes work well
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
112 with the ideas of the Unix Philosophy and support them, while others are
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
113 at cross-purposes.
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
114 Kent Beck's books about Extreme Programming are valuable supplimental
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
115 resources.
40
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
116 .PP
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
117 The question of how to actually write code and how the code should looks
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
118 like internally, are out of focus here.
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
119 ``The Practice of Programming'' by Kernighan and Pike,
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
120 .[
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
121 %A Brian W. Kernighan
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
122 %A Rob Pike
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
123 %T The Practice of Programming
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
124 %I Addison-Wesley
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
125 %D 1999
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
126 .]
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
127 is a good book that covers this topic.
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
128 Its point of view matches to the one of this paper.
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
129
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
130 .NH 1
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
131 Importance of software design in general
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
132 .LP
40
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
133 Software design is the planning of how the internal structure
422679bdf384 rework in ch01
meillo@marmaro.de
parents: 39
diff changeset
134 and external interfaces of a software should look like.
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
135 It has nothing to do with visual appearance.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
136 If we take a program as a car, then its color is of no matter.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
137 Its design would be the car's size, its shape, the locations of doors,
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
138 the passenger/space ratio, the luggage capacity, and so forth.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
139 .PP
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
140 Why should software get designed at all?
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
141 It is general knowledge, that even a bad plan is better than no plan.
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
142 Not designing software means programming without plan.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
143 This will pretty sure lead to horrible results.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
144 Horrible to use and horrible to maintain.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
145 These two aspects are the visible ones.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
146 Often invisible are the wasted possible gains.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
147 Good software design can make these gains available.
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
148 .PP
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
149 A software's design deals with quality properties.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
150 Good design leads to good quality, and quality is important.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
151 Any car may be able to drive from A to B,
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
152 but it depends on the car's properties whether it is a good choice
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
153 for passenger transport or not.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
154 It depends on its properties if it is a good choice
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
155 for a rough mountain area.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
156 And it depends on its properties if the ride will be fun.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
157
2
fbd7baf6a61f added content about sw design; some formating
meillo@marmaro.de
parents: 1
diff changeset
158 .PP
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
159 Requirements for a software are twofold:
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
160 functional and non-functional.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
161 .IP \(bu
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
162 Functional requirements define directly the software's functions.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
163 They are the reason why software gets written.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
164 Someone has a problem and needs a tool to solve it.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
165 Being able to solve the problem is the main functional goal.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
166 It is the driving force behind all programming effort.
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
167 Functional requirements are easier to define and to verify.
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
168 .IP \(bu
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
169 Non-functional requirements are also called \fIquality\fP requirements.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
170 The quality of a software are the properties that are not directly related to
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
171 the software's basic functions.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
172 Tools of bad quality often solve the problems they were written for,
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
173 but introduce problems and difficulties for usage and development, later on.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
174 Quality aspects are often overlooked at first sight,
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
175 and they are often difficult to define clearly and to verify.
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
176 .PP
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
177 Quality is of few matter when the software gets built initially,
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
178 but it is of matter for usage and maintenance of the software.
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
179 A short-sighted might see in developing a software mainly building something up.
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
180 But experience shows, that building the software the first time is
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
181 only a small amount of the overall work.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
182 Bug fixing, extending, rebuilding of parts
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
183 \(en maintenance work, for short \(en
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
184 does soon take over the major part of the time spent on a software.
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
185 Not to forget the usage of the software.
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
186 These processes are highly influenced by the software's quality.
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
187 Thus, quality must not be neglected.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
188 The problem with quality is that you hardly ``stumble over''
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
189 bad quality during the first build,
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
190 but this is the time when you should care about good quality most.
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
191 .PP
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
192 Software design is less the basic function of a software \(en
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
193 this requirement will get satisfied anyway.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
194 Software design is more about quality aspects of the software.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
195 Good design leads to good quality, bad design to bad quality.
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
196 The primary functions of the software will be affected modestly by bad quality,
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
197 but good quality can provide a lot of additional gain,
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
198 even at places where one never expected it.
2
fbd7baf6a61f added content about sw design; some formating
meillo@marmaro.de
parents: 1
diff changeset
199 .PP
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
200 The ISO/IEC 9126-1 standard, part 1,
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
201 .[
9
529168f49f29 corrected spelling
meillo@marmaro.de
parents: 8
diff changeset
202 %I International Organization for Standardization
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
203 %T ISO Standard 9126: Software Engineering \(en Product Quality, part 1
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
204 %C Geneve
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
205 %D 2001
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
206 .]
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
207 defines the quality model as consisting out of:
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
208 .IP \(bu
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
209 .I Functionality
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
210 (suitability, accuracy, inter\%operability, security)
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
211 .IP \(bu
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
212 .I Reliability
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
213 (maturity, fault tolerance, recoverability)
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
214 .IP \(bu
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
215 .I Usability
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
216 (understandability, learnability, operability, attractiveness)
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
217 .IP \(bu
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
218 .I Efficiency
9
529168f49f29 corrected spelling
meillo@marmaro.de
parents: 8
diff changeset
219 (time behavior, resource utilization)
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
220 .IP \(bu
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
221 .I Maintainability
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
222 (analyzability, changeability, stability, testability)
6
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
223 .IP \(bu
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
224 .I Portability
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
225 (adaptability, installability, co-existence, replaceability)
a6b837d822b7 rewrote ch02
meillo@marmaro.de
parents: 5
diff changeset
226 .LP
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
227 Good design can improve these properties of a software,
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
228 bad designed software probably suffers from not having them.
7
606f0ffca834 added two more paragraphs to ch02
meillo@marmaro.de
parents: 6
diff changeset
229 .PP
606f0ffca834 added two more paragraphs to ch02
meillo@marmaro.de
parents: 6
diff changeset
230 One further goal of software design is consistency.
606f0ffca834 added two more paragraphs to ch02
meillo@marmaro.de
parents: 6
diff changeset
231 Consistency eases understanding, working on, and using things.
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
232 Consistent internal structure and consistent interfaces to the outside
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
233 can be provided by good design.
7
606f0ffca834 added two more paragraphs to ch02
meillo@marmaro.de
parents: 6
diff changeset
234 .PP
39
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
235 Software should be well designed because good design avoids many
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
236 problems during the software's lifetime.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
237 And software should be well designed because good design can offer
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
238 much additional gain.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
239 Indeed, much effort should be spent into good design to make software more valuable.
c87143793d82 a lot of rework in ch02
meillo@marmaro.de
parents: 38
diff changeset
240 The Unix Philosophy shows a way of how to design software well.
7
606f0ffca834 added two more paragraphs to ch02
meillo@marmaro.de
parents: 6
diff changeset
241 It offers guidelines to achieve good quality and high gain for the effort spent.
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
242
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
243
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
244 .NH 1
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
245 The Unix Philosophy
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
246 .LP
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
247 The origins of the Unix Philosophy were already introduced.
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
248 This chapter explains the philosophy, oriented on Gancarz,
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
249 and shows concrete examples of its application.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
250
16
f89ca78f289e numbered 2nd level headings
meillo@marmaro.de
parents: 15
diff changeset
251 .NH 2
14
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
252 Pipes
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
253 .LP
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
254 Following are some examples to demonstrate how applied Unix Philosophy feels like.
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
255 Knowledge of using the Unix shell is assumed.
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
256 .PP
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
257 Counting the number of files in the current directory:
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
258 .DS
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
259 .CW
9
529168f49f29 corrected spelling
meillo@marmaro.de
parents: 8
diff changeset
260 .ps -1
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
261 ls | wc -l
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
262 .DE
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
263 The
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
264 .CW ls
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
265 command lists all files in the current directory, one per line,
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
266 and
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
267 .CW "wc -l
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
268 counts the number of lines.
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
269 .PP
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
270 Counting the number of files that do not contain ``foo'' in their name:
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
271 .DS
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
272 .CW
9
529168f49f29 corrected spelling
meillo@marmaro.de
parents: 8
diff changeset
273 .ps -1
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
274 ls | grep -v foo | wc -l
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
275 .DE
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
276 Here, the list of files is filtered by
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
277 .CW grep
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
278 to remove all that contain ``foo''.
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
279 The rest is the same as in the previous example.
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
280 .PP
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
281 Finding the five largest entries in the current directory.
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
282 .DS
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
283 .CW
9
529168f49f29 corrected spelling
meillo@marmaro.de
parents: 8
diff changeset
284 .ps -1
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
285 du -s * | sort -nr | sed 5q
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
286 .DE
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
287 .CW "du -s *
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
288 returns the recursively summed sizes of all files
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
289 \(en no matter if they are regular files or directories.
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
290 .CW "sort -nr
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
291 sorts the list numerically in reverse order.
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
292 Finally,
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
293 .CW "sed 5q
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
294 quits after it has printed the fifth line.
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
295 .PP
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
296 The presented command lines are examples of what Unix people would use
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
297 to get the desired output.
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
298 There are also other ways to get the same output.
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
299 It's a user's decision which way to go.
14
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
300 .PP
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
301 The examples show that many tasks on a Unix system
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
302 are accomplished by combining several small programs.
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
303 The connection between the single programs is denoted by the pipe operator `|'.
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
304 .PP
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
305 Pipes, and their extensive and easy use, are one of the great
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
306 achievements of the Unix system.
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
307 Pipes between programs have been possible in earlier operating systems,
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
308 but it has never been a so central part of the concept.
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
309 When, in the early seventies, Doug McIlroy introduced pipes for the
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
310 Unix system,
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
311 ``it was this concept and notation for linking several programs together
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
312 that transformed Unix from a basic file-sharing system to an entirely new way of computing.''
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
313 .[
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
314 %T Unix: An Oral History
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
315 %O .CW \s-1http://www.princeton.edu/~hos/frs122/unixhist/finalhis.htm
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
316 .]
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
317 .PP
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
318 Being able to specify pipelines in an easy way is,
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
319 however, not enough by itself.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
320 It is only one half.
4
c707b0c5c849 new text about pipes
meillo@marmaro.de
parents: 3
diff changeset
321 The other is the design of the programs that are used in the pipeline.
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
322 They have to interfaces that allows them to be used in such a way.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
323
16
f89ca78f289e numbered 2nd level headings
meillo@marmaro.de
parents: 15
diff changeset
324 .NH 2
14
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
325 Interface design
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
326 .LP
11
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
327 Unix is, first of all, simple \(en Everything is a file.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
328 Files are sequences of bytes, without any special structure.
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
329 Programs should be filters, which read a stream of bytes from ``standard input'' (stdin)
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
330 and write a stream of bytes to ``standard output'' (stdout).
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
331 .PP
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
332 If the files \fIare\fP sequences of bytes,
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
333 and the programs \fIare\fP filters on byte streams,
11
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
334 then there is exactly one standardized data interface.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
335 Thus it is possible to combine them in any desired way.
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
336 .PP
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
337 Even a handful of small programs will yield a large set of combinations,
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
338 and thus a large set of different functions.
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
339 This is leverage!
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
340 If the programs are orthogonal to each other \(en the best case \(en
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
341 then the set of different functions is greatest.
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
342 .PP
11
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
343 Programs might also have a separate control interface,
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
344 besides their data interface.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
345 The control interface is often called ``user interface'',
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
346 because it is usually designed to be used by humans.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
347 The Unix Philosophy discourages to assume the user to be human.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
348 Interactive use of software is slow use of software,
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
349 because the program waits for user input most of the time.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
350 Interactive software requires the user to be in front of the computer
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
351 all the time.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
352 Interactive software occupy the user's attention while they are running.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
353 .PP
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
354 Now we come back to the idea of using several small programs, combined,
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
355 to have a more specific function.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
356 If these single tools would all be interactive,
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
357 how would the user control them?
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
358 It is not only a problem to control several programs at once if they run at the same time,
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
359 it also very inefficient to have to control each of the single programs
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
360 that are intended to work as one large program.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
361 Hence, the Unix Philosophy discourages programs to demand interactive use.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
362 The behavior of programs should be defined at invocation.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
363 This is done by specifying arguments (``command line switches'') to the program call.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
364 Gancarz discusses this topic as ``avoid captive user interfaces''.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
365 .[
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
366 %A Mike Gancarz
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
367 %T The UNIX Philosophy
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
368 %I Digital Press
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
369 %D 1995
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
370 %P 88 ff.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
371 .]
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
372 .PP
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
373 Non-interactive use is, during development, also an advantage for testing.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
374 Testing of interactive programs is much more complicated,
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
375 than testing of non-interactive programs.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
376
16
f89ca78f289e numbered 2nd level headings
meillo@marmaro.de
parents: 15
diff changeset
377 .NH 2
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
378 The toolchest approach
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
379 .LP
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
380 A toolchest is a set of tools.
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
381 Instead of having one big tool for all tasks, one has many small tools,
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
382 each for one task.
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
383 Difficult tasks are solved by combining several of the small, simple tools.
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
384 .PP
11
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
385 The Unix toolchest \fIis\fP a set of small, (mostly) non-interactive programs
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
386 that are filters on byte streams.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
387 They are, to a large extend, unrelated in their function.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
388 Hence, the Unix toolchest provides a large set of functions
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
389 that can be accessed by combining the programs in the desired way.
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
390 .PP
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
391 There are also advantages for developing small toolchest programs.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
392 It is easier and less error-prone to write small programs.
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
393 It is also easier and less error-prone to write a large set of small programs,
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
394 than to write one large program with all the functionality included.
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
395 If the small programs are combinable, then they offer even a larger set
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
396 of functions than the single large program.
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
397 Hence, one gets two advantages out of writing small, combinable programs.
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
398 .PP
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
399 There are two drawbacks of the toolchest approach.
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
400 First, one simple, standardized, unidirectional interface has to be sufficient.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
401 If one feels the need for more ``logic'' than a stream of bytes,
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
402 then a different approach might be of need.
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
403 But it is also possible, that he just can not imagine a design where
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
404 a stream of bytes is sufficient.
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
405 By becoming more familiar with the ``Unix style of thinking'',
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
406 developers will more often and easier find simple designs where
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
407 a stream of bytes is a sufficient interface.
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
408 .PP
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
409 The second drawback of a toolchest affects the users.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
410 A toolchest is often more difficult to use for novices.
9
529168f49f29 corrected spelling
meillo@marmaro.de
parents: 8
diff changeset
411 It is necessary to become familiar with each of the tools,
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
412 to be able to use the right one in a given situation.
9
529168f49f29 corrected spelling
meillo@marmaro.de
parents: 8
diff changeset
413 Additionally, one needs to combine the tools in a senseful way on its own.
529168f49f29 corrected spelling
meillo@marmaro.de
parents: 8
diff changeset
414 This is like a sharp knife \(en it is a powerful tool in the hand of a master,
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
415 but of no good value in the hand of an unskilled.
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
416 .PP
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
417 However, learning single, small tool of the toolchest is easier than
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
418 learning a complex tool.
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
419 The user will have a basic understanding of a yet unknown tool,
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
420 if the several tools of the toolchest have a common style.
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
421 He will be able to transfer knowledge over one tool to another.
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
422 .PP
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
423 Moreover, the second drawback can be removed easily by adding wrappers
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
424 around the single tools.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
425 Novice users do not need to learn several tools if a professional wraps
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
426 the single commands into a more high-level script.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
427 Note that the wrapper script still calls the small tools;
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
428 the wrapper script is just like a skin around.
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
429 No complexity is added this way,
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
430 but new programs can get created out of existing one with very low effort.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
431 .PP
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
432 A wrapper script for finding the five largest entries in the current directory
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
433 could look like this:
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
434 .DS
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
435 .CW
9
529168f49f29 corrected spelling
meillo@marmaro.de
parents: 8
diff changeset
436 .ps -1
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
437 #!/bin/sh
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
438 du -s * | sort -nr | sed 5q
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
439 .DE
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
440 The script itself is just a text file that calls the command line
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
441 a professional user would type in directly.
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
442 Making the program flexible on the number of entries it prints,
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
443 is easily possible:
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
444 .DS
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
445 .CW
9
529168f49f29 corrected spelling
meillo@marmaro.de
parents: 8
diff changeset
446 .ps -1
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
447 #!/bin/sh
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
448 num=5
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
449 [ $# -eq 1 ] && num="$1"
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
450 du -sh * | sort -nr | sed "${num}q"
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
451 .DE
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
452 This script acts like the one before, when called without an argument.
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
453 But one can also specify a numerical argument to define the number of lines to print.
5
48f1f3465550 new content about interfaces and toolchests
meillo@marmaro.de
parents: 4
diff changeset
454
16
f89ca78f289e numbered 2nd level headings
meillo@marmaro.de
parents: 15
diff changeset
455 .NH 2
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
456 A powerful shell
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
457 .LP
10
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
458 It was already said, that the Unix shell provides the possibility to
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
459 combine small programs into large ones easily.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
460 A powerful shell is a great feature in other ways, too.
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
461 .PP
10
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
462 For instance by including a scripting language.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
463 The control statements are build into the shell.
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
464 The functions, however, are the normal programs, everyone can use on the system.
10
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
465 Thus, the programs are known, so learning to program in the shell is easy.
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
466 Using normal programs as functions in the shell programming language
10
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
467 is only possible because they are small and combinable tools in a toolchest style.
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
468 .PP
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
469 The Unix shell encourages to write small scripts out of other programs,
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
470 because it is so easy to do.
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
471 This is a great step towards automation.
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
472 It is wonderful if the effort to automate a task equals the effort
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
473 it takes to do it the second time by hand.
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
474 If it is so, then the user will be happy to automate everything he does more than once.
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
475 .PP
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
476 Small programs that do one job well, standardized interfaces between them,
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
477 a mechanism to combine parts to larger parts, and an easy way to automate tasks,
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
478 this will inevitably produce software leverage.
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
479 Getting multiple times the benefit of an investment is a great offer.
10
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
480 .PP
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
481 The shell also encourages rapid prototyping.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
482 Many well known programs started as quickly hacked shell scripts,
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
483 and turned into ``real'' programs, written in C, later.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
484 Building a prototype first is a way to avoid the biggest problems
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
485 in application development.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
486 Fred Brooks writes in ``No Silver Bullet'':
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
487 .[
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
488 %A Frederick P. Brooks, Jr.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
489 %T No Silver Bullet: Essence and Accidents of Software Engineering
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
490 %B Information Processing 1986, the Proceedings of the IFIP Tenth World Computing Conference
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
491 %E H.-J. Kugler
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
492 %D 1986
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
493 %P 1069\(en1076
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
494 %I Elsevier Science B.V.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
495 %C Amsterdam, The Netherlands
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
496 .]
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
497 .QP
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
498 .ps -1
10
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
499 The hardest single part of building a software system is deciding precisely what to build.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
500 No other part of the conceptual work is so difficult as establishing the detailed
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
501 technical requirements, [...].
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
502 No other part of the work so cripples the resulting system if done wrong.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
503 No other part is more difficult to rectify later.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
504 .PP
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
505 Writing a prototype is a great method to become familiar with the requirements
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
506 and to actually run into real problems.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
507 Today, prototyping is often seen as a first step in building a software.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
508 This is, of course, good.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
509 However, the Unix Philosophy has an \fIadditional\fP perspective on prototyping:
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
510 After having built the prototype, one might notice, that the prototype is already
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
511 \fIgood enough\fP.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
512 Hence, no reimplementation, in a more sophisticated programming language, might be of need,
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
513 for the moment.
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
514 Maybe later, it might be necessary to rewrite the software, but not now.
10
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
515 .PP
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
516 By delaying further work, one keeps the flexibility to react easily on
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
517 changing requirements.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
518 Software parts that are not written will not miss the requirements.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
519
16
f89ca78f289e numbered 2nd level headings
meillo@marmaro.de
parents: 15
diff changeset
520 .NH 2
10
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
521 Worse is better
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
522 .LP
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
523 The Unix Philosophy aims for the 80% solution;
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
524 others call it the ``Worse is better'' approach.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
525 .PP
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
526 First, practical experience shows, that it is almost never possible to define the
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
527 requirements completely and correctly the first time.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
528 Hence one should not try to; it will fail anyway.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
529 Second, practical experience shows, that requirements change during time.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
530 Hence it is best to delay requirement-based design decisions as long as possible.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
531 Also, the software should be small and flexible as long as possible
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
532 to react on changing requirements.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
533 Shell scripts, for example, are more easily adjusted as C programs.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
534 Third, practical experience shows, that maintenance is hard work.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
535 Hence, one should keep the amount of software as small as possible;
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
536 it should just fulfill the \fIcurrent\fP requirements.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
537 Software parts that will be written later, do not need maintenance now.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
538 .PP
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
539 Starting with a prototype in a scripting language has several advantages:
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
540 .IP \(bu
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
541 As the initial effort is low, one will likely start right away.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
542 .IP \(bu
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
543 As working parts are available soon, the real requirements can get identified soon.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
544 .IP \(bu
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
545 When a software is usable, it gets used, and thus tested.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
546 Hence problems will be found at early stages of the development.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
547 .IP \(bu
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
548 The prototype might be enough for the moment,
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
549 thus further work on the software can be delayed to a time
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
550 when one knows better about the requirements and problems,
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
551 than now.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
552 .IP \(bu
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
553 Implementing now only the parts that are actually needed now,
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
554 requires fewer maintenance work.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
555 .IP \(bu
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
556 If the global situation changes so that the software is not needed anymore,
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
557 then less effort was spent into the project, than it would have be
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
558 when a different approach had been used.
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
559
16
f89ca78f289e numbered 2nd level headings
meillo@marmaro.de
parents: 15
diff changeset
560 .NH 2
11
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
561 Upgrowth and survival of software
b32a43a62cae some rework about interface arch (ch03)
meillo@marmaro.de
parents: 10
diff changeset
562 .LP
12
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
563 So far it was talked about \fIwriting\fP or \fIbuilding\fP software.
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
564 Although these are just verbs, they do imply a specific view on the work process
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
565 they describe.
12
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
566 The better verb, however, is to \fIgrow\fP.
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
567 .PP
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
568 Creating software in the sense of the Unix Philosophy is an incremental process.
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
569 It starts with a first prototype, which evolves as requirements change.
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
570 A quickly hacked shell script might become a large, sophisticated,
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
571 compiled program this way.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
572 Its lifetime begins with the initial prototype and ends when the software is not used anymore.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
573 While being alive it will get extended, rearranged, rebuilt (from scratch).
12
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
574 Growing software matches the view that ``software is never finished. It is only released.''
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
575 .[
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
576 %O FIXME
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
577 %A Mike Gancarz
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
578 %T The UNIX Philosophy
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
579 %P 26
12
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
580 .]
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
581 .PP
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
582 Software can be seen as being controlled by evolutionary processes.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
583 Successful software is software that is used by many for a long time.
12
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
584 This implies that the software is needed, useful, and better than alternatives.
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
585 Darwin talks about: ``The survival of the fittest.''
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
586 .[
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
587 %O FIXME
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
588 %A Charles Darwin
12
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
589 .]
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
590 Transferred to software: The most successful software, is the fittest,
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
591 is the one that survives.
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
592 (This may be at the level of one creature, or at the level of one species.)
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
593 The fitness of software is affected mainly by four properties:
15
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
594 portability of code, portability of data, range of usability, and reusability of parts.
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
595 .\" .IP \(bu
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
596 .\" portability of code
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
597 .\" .IP \(bu
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
598 .\" portability of data
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
599 .\" .IP \(bu
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
600 .\" range of usability
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
601 .\" .IP \(bu
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
602 .\" reuseability of parts
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
603 .PP
15
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
604 (1)
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
605 .I "Portability of code
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
606 means, using high-level programming languages,
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
607 sticking to the standard,
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
608 and avoiding optimizations that introduce dependencies on specific hardware.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
609 Hardware has a much lower lifetime than software.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
610 By chaining software to a specific hardware,
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
611 the software's lifetime gets shortened to that of this hardware.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
612 In contrast, software should be easy to port \(en
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
613 adaptation is the key to success.
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
614 .\" cf. practice of prog: ch08
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
615 .PP
15
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
616 (2)
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
617 .I "Portability of data
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
618 is best achieved by avoiding binary representations
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
619 to store data, because binary representations differ from machine to machine.
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
620 Textual representation is favored.
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
621 Historically, ASCII was the charset of choice.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
622 In the future, UTF-8 might be the better choice, however.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
623 Important is that it is a plain text representation in a
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
624 very common charset encoding.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
625 Apart from being able to transfer data between machines,
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
626 readable data has the great advantage, that humans are able
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
627 to directly edit it with text editors and other tools from the Unix toolchest.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
628 .\" gancarz tenet 5
12
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
629 .PP
15
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
630 (3)
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
631 A large
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
632 .I "range of usability
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
633 ensures good adaptation, and thus good survival.
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
634 It is a special distinction if a software becomes used in fields of action,
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
635 the original authors did never imagine.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
636 Software that solves problems in a general way will likely be used
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
637 for all kinds of similar problems.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
638 Being too specific limits the range of uses.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
639 Requirements change through time, thus use cases change or even vanish.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
640 A good example in this point is Allman's sendmail.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
641 Allman identifies flexibility to be one major reason for sendmail's success:
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
642 .[
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
643 %O FIXME
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
644 %A Allman
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
645 %T sendmail
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
646 .]
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
647 .QP
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
648 .ps -1
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
649 Second, I limited myself to the routing function [...].
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
650 This was a departure from the dominant thought of the time, [...].
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
651 .QP
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
652 .ps -1
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
653 Third, the sendmail configuration file was flexible enough to adopt
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
654 to a rapidly changing world [...].
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
655 .LP
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
656 Successful software adopts itself to the changing world.
12
018d5f9a2993 wrote about upgrowth and survival (ch03)
meillo@marmaro.de
parents: 11
diff changeset
657 .PP
15
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
658 (4)
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
659 .I "Reuse of parts
00e306ee903b reformated content (ch03)
meillo@marmaro.de
parents: 14
diff changeset
660 is even one step further.
13
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
661 A software may completely lose its field of action,
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
662 but parts of which the software is build may be general and independent enough
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
663 to survive this death.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
664 If software is build by combining small independent programs,
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
665 then there are parts readily available for reuse.
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
666 Who cares if the large program is a failure,
c665b9e7bf8a more about portability and reuse (ch03)
meillo@marmaro.de
parents: 12
diff changeset
667 but parts of it become successful instead?
10
355ed69a34a8 more about the shell and worse is better (ch03)
meillo@marmaro.de
parents: 9
diff changeset
668
16
f89ca78f289e numbered 2nd level headings
meillo@marmaro.de
parents: 15
diff changeset
669 .NH 2
14
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
670 Summary
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
671 .LP
14
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
672 This chapter explained the central ideas of the Unix Philosophy.
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
673 For each of the ideas, it was exposed what advantages they introduce.
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
674 The Unix Philosophy are guidelines that help to write valuable software.
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
675 From the view point of a software developer or software designer,
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
676 the Unix Philosophy provides answers to many software design problem.
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
677 .PP
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
678 The various ideas of the Unix Philosophy are very interweaved
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
679 and can hardly be applied independently.
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
680 However, the probably most important messages are:
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
681 .I "``Do one thing well!''" ,
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
682 .I "``Keep it simple!''" ,
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
683 and
59305c854751 rearrangements of headlines; summary (ch03)
meillo@marmaro.de
parents: 13
diff changeset
684 .I "``Use software leverage!''
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
685
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
686
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
687
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
688 .NH 1
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
689 Case study: \s-1MH\s0
18
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
690 .LP
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
691 The previous chapter introduced and explained the Unix Philosophy
18
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
692 from a general point of view.
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
693 The driving force were the guidelines; references to
18
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
694 existing software were given only sparsely.
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
695 In this and the next chapter, concrete software will be
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
696 the driving force in the discussion.
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
697 .PP
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
698 This first case study is about the mail user agents (\s-1MUA\s0)
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
699 \s-1MH\s0 (``mail handler'') and its descendent \fInmh\fP
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
700 (``new mail handler'').
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
701 \s-1MUA\s0s provide functions to read, compose, and organize mail,
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
702 but (ideally) not to transfer.
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
703 In this document, the name \s-1MH\s0 will be used for both of them.
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
704 A distinction will only be made if differences between
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
705 them are described.
18
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
706
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
707
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
708 .NH 2
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
709 Historical background
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
710 .LP
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
711 Electronic mail was available in Unix very early.
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
712 The first \s-1MUA\s0 on Unix was \f(CWmail\fP,
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
713 which was already present in the First Edition.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
714 .[
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
715 %A Peter H. Salus
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
716 %T A Quarter Century of UNIX
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
717 %D 1994
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
718 %I Addison-Wesley
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
719 %P 41 f.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
720 .]
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
721 It was a small program that either prints the user's mailbox file
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
722 or appends text to someone elses mailbox file,
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
723 depending on the command line arguments.
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
724 .[
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
725 %O http://cm.bell-labs.com/cm/cs/who/dmr/pdfs/man12.pdf
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
726 .]
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
727 It was a program that did one job well.
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
728 This job was emailing, which was very simple then.
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
729 .PP
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
730 Later, emailing became more powerful, and thus more complex.
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
731 The simple \f(CWmail\fP, which knew nothing of subjects,
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
732 independent handling of single messages,
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
733 and long-time storage of them, was not powerful enough anymore.
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
734 At Berkeley, Kurt Shoens wrote \fIMail\fP (with capital `M')
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
735 in 1978 to provide additional functions for emailing.
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
736 Mail was still one program, but now it was large and did
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
737 several jobs.
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
738 Its user interface is modeled after the one of \fIed\fP.
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
739 It is designed for humans, but is still scriptable.
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
740 \fImailx\fP is the adaptation of Berkeley Mail into System V.
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
741 .[
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
742 %A Gunnar Ritter
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
743 %O http://heirloom.sourceforge.net/mailx_history.html
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
744 .]
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
745 Elm, pine, mutt, and a whole bunch of graphical \s-1MUA\s0s
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
746 followed Mail's direction.
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
747 They are large, monolithic programs which include all emailing functions.
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
748 .PP
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
749 A different way was taken by the people of \s-1RAND\s0 Corporation.
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
750 In the beginning, they also had used a monolithic mail system,
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
751 called \s-1MS\s0 (for ``mail system'').
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
752 But in 1977, Stockton Gaines and Norman Shapiro
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
753 came up with a proposal of a new email system concept \(en
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
754 one that honors the Unix Philosophy.
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
755 The concept was implemented by Bruce Borden in 1978 and 1979.
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
756 This was the birth of \s-1MH\s0 \(en the ``mail handler''.
18
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
757 .PP
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
758 Since then, \s-1RAND\s0, the University of California at Irvine and
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
759 at Berkeley, and several others have contributed to the software.
18
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
760 However, it's core concepts remained the same.
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
761 In the late 90s, when development of \s-1MH\s0 slowed down,
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
762 Richard Coleman started with \fInmh\fP, the new mail handler.
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
763 His goal was to improve \s-1MH\s0, especially in regard of
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
764 the requirements of modern emailing.
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
765 Today, nmh is developed by various people on the Internet.
18
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
766 .[
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
767 %T RAND and the Information Evolution: A History in Essays and Vignettes
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
768 %A Willis H. Ware
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
769 %D 2008
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
770 %I The RAND Corporation
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
771 %P 128\(en137
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
772 %O .CW \s-1http://www.rand.org/pubs/corporate_pubs/CP537/
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
773 .]
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
774 .[
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
775 %T MH & xmh: Email for Users & Programmers
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
776 %A Jerry Peek
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
777 %D 1991, 1992, 1995
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
778 %I O'Reilly & Associates, Inc.
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
779 %P Appendix B
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
780 %O Also available online: \f(CW\s-2http://rand-mh.sourceforge.net/book/\fP
e2240a387a84 wrote about history of MH and nmh
meillo@marmaro.de
parents: 17
diff changeset
781 .]
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
782
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
783 .NH 2
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
784 Contrasts to monolithic mail systems
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
785 .LP
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
786 All \s-1MUA\s0s are monolithic, except \s-1MH\s0.
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
787 Although there might actually exist further, very little known,
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
788 toolchest \s-1MUA\s0s, this statement reflects the situation pretty well.
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
789 .PP
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
790 Monolithic \s-1MUA\s0s gather all their functions in one program.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
791 In contrast, \s-1MH\s0 is a toolchest of many small tools \(en one for each job.
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
792 Following is a list of important programs of \s-1MH\s0's toolchest
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
793 and their function.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
794 It gives a feeling of how the toolchest looks like.
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
795 .IP \(bu
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
796 .CW inc :
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
797 incorporate new mail (this is how mail enters the system)
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
798 .IP \(bu
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
799 .CW scan :
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
800 list messages in folder
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
801 .IP \(bu
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
802 .CW show :
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
803 show message
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
804 .IP \(bu
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
805 .CW next\fR/\fPprev :
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
806 show next/previous message
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
807 .IP \(bu
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
808 .CW folder :
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
809 change current folder
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
810 .IP \(bu
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
811 .CW refile :
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
812 refile message into folder
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
813 .IP \(bu
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
814 .CW rmm :
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
815 remove message
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
816 .IP \(bu
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
817 .CW comp :
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
818 compose a new message
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
819 .IP \(bu
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
820 .CW repl :
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
821 reply to a message
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
822 .IP \(bu
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
823 .CW forw :
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
824 forward a message
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
825 .IP \(bu
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
826 .CW send :
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
827 send a prepared message (this is how mail leaves the system)
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
828 .LP
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
829 \s-1MH\s0 has no special user interface like monolithic \s-1MUA\s0s have.
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
830 The user does not leave the shell to run \s-1MH\s0,
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
831 but he uses the various \s-1MH\s0 programs within the shell.
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
832 Using a monolithic program with a captive user interface
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
833 means ``entering'' the program, using it, and ``exiting'' the program.
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
834 Using toolchests like \s-1MH\s0 means running programs,
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
835 alone or in combination with others, even from other toolchests,
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
836 without leaving the shell.
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
837
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
838 .NH 2
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
839 Data storage
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
840 .LP
34
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
841 \s-1MH\s0's mail storage is a directory tree under the user's
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
842 \s-1MH\s0 directory (usually \f(CW$HOME/Mail\fP),
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
843 where mail folders are directories and mail messages are text files
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
844 within them.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
845 Each mail folder contains a file \f(CW.mh_sequences\fP which lists
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
846 the public message sequences of that folder, for instance new messages.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
847 Mail messages are text files located in a mail folder.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
848 The files contain the messages as they were received.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
849 They are numbered in ascending order in each folder.
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
850 .PP
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
851 This mailbox format is called ``\s-1MH\s0'' after the \s-1MUA\s0.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
852 Alternatives are \fImbox\fP and \fImaildir\fP.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
853 In the mbox format all messages are stored within one file.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
854 This was a good solution in the early days, when messages
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
855 were only a few lines of text and were deleted soon.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
856 Today, when single messages often include several megabytes
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
857 of attachments, it is a bad solution.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
858 Another disadvantage of the mbox format is that it is
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
859 more difficult to write tools that work on mail messages,
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
860 because it is always necessary to first find and extract
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
861 the relevant message in the mbox file.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
862 With the \s-1MH\s0 mailbox format,
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
863 each message is a self-standing item, by definition.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
864 Also, the problem of concurrent access to one mailbox is
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
865 reduced to the problem of concurrent access to one message.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
866 Maildir is generally similar to \s-1MH\s0's format,
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
867 but modified towards guaranteed reliability.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
868 This involves some complexity, unfortunately.
34
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
869 .PP
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
870 Working with \s-1MH\s0's toolchest on mailboxes is much like
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
871 working with Unix' toolchest on directory trees:
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
872 \f(CWscan\fP is like \f(CWls\fP,
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
873 \f(CWshow\fP is like \f(CWcat\fP,
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
874 \f(CWfolder\fP is like \f(CWcd\fP and \f(CWpwd\fP,
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
875 \f(CWrefile\fP is like \f(CWmv\fP,
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
876 and \f(CWrmm\fP is like \f(CWrm\fP.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
877 .PP
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
878 The context of tools in Unix consists mainly the current working directory,
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
879 the user identification, and the environment variables.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
880 \s-1MH\s0 extends this context by two more items:
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
881 .IP \(bu
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
882 The current mail folder, which is similar to the current working directory.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
883 For mail folders, \f(CWfolder\fP provides the corresponding functionality
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
884 of \f(CWcd\fP and \f(CWpwd\fP for directories.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
885 .IP \(bu
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
886 Sequences, which are named sets of messages in a mail folder.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
887 The current message, relative to a mail folder, is a special sequence.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
888 It enables commands like \f(CWnext\fP and \f(CWprev\fP.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
889 .LP
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
890 In contrast to Unix' context, which is chained to the shell session,
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
891 \s-1MH\s0's context is independent.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
892 Usually there is one context for each user, but a user can have many
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
893 contexts.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
894 Public sequences are an exception, as they belong to the mail folder.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
895 .[
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
896 %O mh-profile(5) and mh-sequence(5)
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
897 .]
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
898
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
899 .NH 2
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
900 Discussion of the design
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
901 .LP
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
902 The following paragraphs discuss \s-1MH\s0 in regard to the tenets
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
903 of the Unix Philosophy which Gancarz identified.
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
904
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
905 .PP
33
0bd43c4ad9f8 removed quotes and used bold instead of italic
meillo@marmaro.de
parents: 32
diff changeset
906 .B "Small is beautiful
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
907 and
33
0bd43c4ad9f8 removed quotes and used bold instead of italic
meillo@marmaro.de
parents: 32
diff changeset
908 .B "do one thing well
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
909 are two design goals that are directly visible in \s-1MH\s0.
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
910 Gancarz actually presents \s-1MH\s0 as example under the headline
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
911 ``Making UNIX Do One Thing Well'':
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
912 .[
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
913 %A Mike Gancarz
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
914 %T unix-phil
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
915 %P 125
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
916 .]
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
917 .QP
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
918 .ps -1
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
919 [\s-1MH\s0] consists of a series of programs which
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
920 when combined give the user an enormous ability
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
921 to manipulate electronic mail messages.
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
922 A complex application, it shows that not only is it
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
923 possible to build large applications from smaller
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
924 components, but also that such designs are actually preferable.
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
925 .LP
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
926 The various small programs of \s-1MH\s0 were relatively easy
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
927 to write, because each of them is small, limited to one function,
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
928 and has clear boundaries.
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
929 For the same reasons, they are also good to maintain.
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
930 Further more, the system can easily get extended.
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
931 One only needs to put a new program into the toolchest.
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
932 This was done, for instance, when \s-1MIME\s0 support was added
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
933 (e.g. \f(CWmhbuild\fP).
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
934 Also, different programs can exist to do the basically same job
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
935 in different ways (e.g. in nmh: \f(CWshow\fP and \f(CWmhshow\fP).
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
936 If someone needs a mail system with some additionally
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
937 functions that are available nowhere yet, he best takes a
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
938 toolchest system like \s-1MH\s0 where he can add the
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
939 functionality with little work.
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
940
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
941 .PP
34
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
942 .B "Store data in flat text files
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
943 is followed by \s-1MH\s0.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
944 This is not surprising, because email messages are already plain text.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
945 \s-1MH\s0 stores the messages as it receives them,
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
946 thus any other tool that works on RFC 2822 mail messages can operate
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
947 on the messages in an \s-1MH\s0 mailbox.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
948 All other files \s-1MH\s0 uses are plain text too.
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
949 It is therefore possible and encouraged to use the text processing
0b2cf026d93d rework of MH's data storage section
meillo@marmaro.de
parents: 33
diff changeset
950 tools of Unix' toolchest to extend \s-1MH\s0's toolchest.
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
951
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
952 .PP
33
0bd43c4ad9f8 removed quotes and used bold instead of italic
meillo@marmaro.de
parents: 32
diff changeset
953 .B "Avoid captive user interfaces" .
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
954 \s-1MH\s0 is perfectly suited for non-interactive use.
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
955 It offers all functions directly and without captive user interfaces.
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
956 If, nonetheless, users want a graphical user interface,
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
957 they can have it with \fIxmh\fP or \fIexmh\fP, too.
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
958 These are graphical frontends for the \s-1MH\s0 toolchest.
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
959 This means, all email-related work is still done by \s-1MH\s0 tools,
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
960 but the frontend issues the appropriate calls when the user
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
961 clicks on buttons.
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
962 Providing easy-to-use user interfaces in form of frontends is a good
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
963 approach, because it does not limit the power of the backend itself.
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
964 The frontend will anyway only be able to make a subset of the
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
965 backend's power and flexibility available to the user.
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
966 But if it is a separate program,
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
967 then the missing parts can still be accessed at the backend directly.
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
968 If it is integrated, then this will hardly be possible.
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
969 Further more, it is possible to have different frontends to the same
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
970 backend.
19
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
971
d8f428cee0d1 about mh (ch04)
meillo@marmaro.de
parents: 18
diff changeset
972 .PP
33
0bd43c4ad9f8 removed quotes and used bold instead of italic
meillo@marmaro.de
parents: 32
diff changeset
973 .B "Choose portability over efficiency
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
974 and
33
0bd43c4ad9f8 removed quotes and used bold instead of italic
meillo@marmaro.de
parents: 32
diff changeset
975 .B "use shell scripts to increase leverage and portability" .
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
976 These two tenets are indirectly, but nicely, demonstrated by
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
977 Bolsky and Korn in their book about the Korn Shell.
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
978 .[
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
979 %T The KornShell: command and programming language
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
980 %A Morris I. Bolsky
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
981 %A David G. Korn
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
982 %I Prentice Hall
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
983 %D 1989
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
984 %P 254\(en290
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
985 %O \s-1ISBN\s0: 0-13-516972-0
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
986 .]
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
987 They demonstrated, in chapter 18 of the book, a basic implementation
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
988 of a subset of \s-1MH\s0 in ksh scripts.
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
989 Of course, this was just a demonstration, but a brilliant one.
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
990 It shows how quickly one can implement such a prototype with shell scripts,
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
991 and how readable they are.
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
992 The implementation in the scripting language may not be very fast,
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
993 but it can be fast enough though, and this is all that matters.
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
994 By having the code in an interpreted language, like the shell,
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
995 portability becomes a minor issue, if we assume the interpreter
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
996 to be widespread.
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
997 This demonstration also shows how easy it is to create single programs
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
998 of a toolchest software.
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
999 There are eight tools (two of them have multiple names) and 16 functions
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1000 with supporting code.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1001 Each tool comprises between 12 and 38 lines of ksh,
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1002 in total about 200 lines.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1003 The functions comprise between 3 and 78 lines of ksh,
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1004 in total about 450 lines.
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1005 Such small software is easy to write, easy to understand,
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1006 and thus easy to maintain.
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
1007 A toolchest improves the possibility to only write some parts
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1008 and though create a working result.
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1009 Expanding the toolchest without global changes will likely be
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1010 possible, too.
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1011
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1012 .PP
33
0bd43c4ad9f8 removed quotes and used bold instead of italic
meillo@marmaro.de
parents: 32
diff changeset
1013 .B "Use software leverage to your advantage
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1014 and the lesser tenet
33
0bd43c4ad9f8 removed quotes and used bold instead of italic
meillo@marmaro.de
parents: 32
diff changeset
1015 .B "allow the user to tailor the environment
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1016 are ideally followed in the design of \s-1MH\s0.
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1017 Tailoring the environment is heavily encouraged by the ability to
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1018 directly define default options to programs.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1019 It is even possible to define different default options
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1020 depending on the name under which the program was called.
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1021 Software leverage is heavily encouraged by the ease it is to
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1022 create shell scripts that run a specific command line,
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1023 built of several \s-1MH\s0 programs.
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1024 There is few software that so much wants users to tailor their
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1025 environment and to leverage the use of the software, like \s-1MH\s0.
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1026 Just to make one example:
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
1027 One might prefer a different listing format for the \f(CWscan\fP
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1028 program.
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1029 It is possible to take one of the distributed format files
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1030 or to write one yourself.
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1031 To use the format as default for \f(CWscan\fP, a single line,
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1032 reading
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1033 .DS
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1034 .CW
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1035 scan: -form FORMATFILE
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1036 .DE
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1037 must be added to \f(CW.mh_profile\fP.
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1038 If one wants this different format as an additional command,
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
1039 instead of changing the default, he needs to create a link to
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
1040 \f(CWscan\fP, for instance titled \f(CWscan2\fP.
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1041 The line in \f(CW.mh_profile\fP would then start with \f(CWscan2\fP,
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1042 as the option should only be in effect when scan is called as
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1043 \f(CWscan2\fP.
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1044
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1045 .PP
33
0bd43c4ad9f8 removed quotes and used bold instead of italic
meillo@marmaro.de
parents: 32
diff changeset
1046 .B "Make every program a filter
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1047 is hard to find in \s-1MH\s0.
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1048 The reason therefore is that most of \s-1MH\s0's tools provide
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1049 basic file system operations for the mailboxes.
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1050 The reason is the same because of which
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1051 \f(CWls\fP, \f(CWcp\fP, \f(CWmv\fP, and \f(CWrm\fP
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1052 aren't filters neither.
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
1053 However, they build a basis on which filters can operate.
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
1054 \s-1MH\s0 does not provide many filters itself, but it is a basis
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
1055 to write filters for.
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1056 An example would be a mail message text highlighter,
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1057 that means a program that makes use of a color terminal to display
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1058 header lines, quotations, and signatures in distinct colors.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1059 The author's version of this program, for instance,
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1060 is a 25 line awk script.
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1061
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1062 .PP
33
0bd43c4ad9f8 removed quotes and used bold instead of italic
meillo@marmaro.de
parents: 32
diff changeset
1063 .B "Build a prototype as soon as possible
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1064 was again well followed by \s-1MH\s0.
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1065 This tenet, of course, focuses on early development, which is
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1066 long time ago for \s-1MH\s0.
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1067 But without following this guideline at the very beginning,
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
1068 Bruce Borden may have not convinced the management of \s-1RAND\s0
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
1069 to ever create \s-1MH\s0.
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
1070 In Bruce' own words:
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
1071 .[
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
1072 %O FIXME
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
1073 .]
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1074 .QP
41
13ef7042fa28 some rework in ch01; nicer formating
meillo@marmaro.de
parents: 40
diff changeset
1075 .ps -1
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1076 [...] but they [Stockton Gaines and Norm Shapiro] were not able
23
f0511a56416e rework in ch04 and spell check
meillo@marmaro.de
parents: 22
diff changeset
1077 to convince anyone that such a system would be fast enough to be usable.
21
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1078 I proposed a very short project to prove the basic concepts,
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1079 and my management agreed.
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1080 Looking back, I realize that I had been very lucky with my first design.
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1081 Without nearly enough design work,
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1082 I built a working environment and some header files
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1083 with key structures and wrote the first few \s-1MH\s0 commands:
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1084 inc, show/next/prev, and comp.
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1085 [...]
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1086 With these three, I was able to convince people that the structure was viable.
ca929b042039 more on MH (ch04)
meillo@marmaro.de
parents: 20
diff changeset
1087 This took about three weeks.
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1088
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1089 .NH 2
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1090 Problems
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1091 .LP
22
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1092 \s-1MH\s0, for sure is not without problems.
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1093 There are two main problems: one is technical, the other is about human behavior.
22
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1094 .PP
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1095 \s-1MH\s0 is old and email today is very different to email in the time
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1096 when \s-1MH\s0 was designed.
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1097 \s-1MH\s0 adopted to the changes pretty well, but it is limited.
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1098 For example in development resources.
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1099 \s-1MIME\s0 support and support for different character encodings
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1100 is available, but only on a moderate level.
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1101 More active developers could quickly improve there.
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1102 It is also limited by design, which is the larger problem.
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1103 \s-1IMAP\s0, for example, conflicts with \s-1MH\s0's design to a large extend.
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1104 These design conflicts are not easily solvable.
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1105 Possibly, they require a redesign.
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1106 Maybe \s-1IMAP\s0 is too different to the classic mail model which \s-1MH\s0 covers,
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1107 hence \s-1MH\s0 may never work well with \s-1IMAP\s0.
22
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1108 .PP
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1109 The other kind of problem is human habits.
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1110 When in this world almost all \s-1MUA\s0s are monolithic,
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1111 it is very difficult to convince people to use a toolbox style \s-1MUA\s0
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1112 like \s-1MH\s0.
4c21f5b8d716 wrote about problems of MH (ch04)
meillo@marmaro.de
parents: 21
diff changeset
1113 The habits are so strong, that even people who understood the concept
30
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1114 and advantages of \s-1MH\s0 do not like to switch,
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1115 simply because \s-1MH\s0 is different.
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1116 Unfortunately, the frontends to \s-1MH\s0, which could provide familiar look'n'feel,
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1117 are quite outdated and thus not very appealing compared to the modern interfaces
ec17b3a969c7 various minor rework in ch04
meillo@marmaro.de
parents: 23
diff changeset
1118 which monolithic \s-1MUA\s0s offer.
20
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1119
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1120 .NH 2
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1121 Summary \s-1MH\s0
578d5c84e5c0 a lot about mh (ch04)
meillo@marmaro.de
parents: 19
diff changeset
1122 .LP
31
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1123 \s-1MH\s0 is an \s-1MUA\s0 that follows the Unix Philosophy in its design
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1124 and implementation.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1125 It consists of a toolchest of small tools, each of them does one job well.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1126 The tools are orthogonal to each other, to a large extend.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1127 However, for historical reasons, there also exist distinct tools
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1128 that cover the same task.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1129 .PP
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1130 The toolchest approach offers great flexibility to the user.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1131 He can use the complete power of the Unix shell with \s-1MH\s0.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1132 This makes \s-1MH\s0 a very powerful mail system.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1133 Extending and customizing \s-1MH\s0 is easy and encouraged, too.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1134 .PP
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1135 Apart from the user's perspective, \s-1MH\s0 is development-friendly.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1136 Its overall design follows clear rules.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1137 The single tools do only one job, thus they are easy to understand,
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1138 easy to write, and good to maintain.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1139 They are all independent and do not interfere with the others.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1140 Automated testing of their function is a straight forward task.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1141 .PP
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1142 It is sad, that \s-1MH\s0's differentness is its largest problem,
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1143 as its differentness is also its largest advantage.
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1144 Unfortunately, for most people their habits are stronger
0caa9760fca8 wrote summary of ch04
meillo@marmaro.de
parents: 30
diff changeset
1145 than the attraction of the clear design and the power, \s-1MH\s0 offers.
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1146
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
1147
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
1148
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1149 .NH 1
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1150 Case study: uzbl
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1151 .LP
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1152 The last chapter took a look on the \s-1MUA\s0 \s-1MH\s0,
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1153 this chapter is about uzbl, a web browser that adheres to the Unix Philosophy.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1154 ``uzbl'' is the \fIlolcat\fP's word for the English adjective ``usable''.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1155 It is pronounced the identical.
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1156
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1157 .NH 2
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1158 Historical background
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1159 .LP
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1160 Uzbl was started by Dieter Plaetinck in April 2009.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1161 The idea was born in a thread in the Arch Linux forum.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1162 .[
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1163 %O http://bbs.archlinux.org/viewtopic.php?id=67463
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1164 .]
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1165 After some discussion about failures of well known web browsers,
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1166 Plaetinck (alias Dieter@be) came up with a very sketchy proposal
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1167 of how a better web browser could look like.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1168 To the question of another member, if Plaetinck would write that program,
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1169 because it would sound fantastic, Plaetinck replied:
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1170 ``Maybe, if I find the time ;-)''.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1171 .PP
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1172 Fortunately, he found the time.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1173 One day later, the first prototype was out.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1174 One week later, uzbl had an own website.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1175 One month after the first code showed up,
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1176 a mailing list was installed to coordinate and discuss further development.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1177 A wiki was set up to store documentation and scripts that showed up on the
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1178 mailing list and elsewhere.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1179 .PP
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1180 In the, now, one year of uzbl's existence, it was heavily developed in various branches.
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1181 Plaetinck's task became more and more to only merge the best code from the
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1182 different branches into his main branch, and to apply patches.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1183 About once a month, Plaetinck released a new version.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1184 In September 2009, he presented several forks of uzbl.
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1185 Uzbl, actually, opened the field for a whole family of web browsers with similar shape.
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1186 .PP
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1187 In July 2009, \fILinux Weekly News\fP published an interview with Plaetinck about uzbl.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1188 In September 2009, the uzbl web browser was on \fISlashdot\fP.
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1189
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1190 .NH 2
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1191 Contrasts to other web browsers
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1192 .LP
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1193 Like most \s-1MUA\s0s are monolithic, but \s-1MH\s0 is a toolchest,
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1194 most web browsers are monolithic, but uzbl is a frontend to a toolchest.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1195 .PP
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1196 Today, uzbl is divided into uzbl-core and uzbl-browser.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1197 Uzbl-core is, how its name already indicates, the core of uzbl.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1198 It handles commands and events to interface other programs,
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1199 and also displays webpages by using webkit as render engine.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1200 Uzbl-browser combines uzbl-core with a bunch of handler scripts, a status bar,
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1201 an event manager, yanking, pasting, page searching, zooming, and more stuff,
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1202 to form a ``complete'' web browser.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1203 In the following text, the term ``uzbl'' usually stands for uzbl-browser,
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1204 so uzbl-core is included.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1205 .PP
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1206 Unlike most other web browsers, uzbl is mainly the mediator between the
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1207 various tools that cover single jobs of web browsing.
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1208 Therefore, uzbl listens for commands on a named pipe (fifo), a Unix socket,
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1209 and on stdin, and it writes events to a Unix socket and to stdout.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1210 The graphical rendering of the webpage is done by webkit, a web content engine.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1211 Uzbl-core is build around this library.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1212 Loading a webpage in a running uzbl instance requires only:
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1213 .DS
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1214 .CW
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1215 echo 'uri http://example.org' >/path/to/uzbl-fifo
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1216 .DE
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1217 .PP
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1218 Downloads, browsing history, bookmarks, and thelike are not provided
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1219 by uzbl-core itself, as they are in other web browsers.
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1220 Uzbl-browser also only provides, so called, handler scripts that wrap
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1221 external applications which provide the actual functionality.
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1222 For instance, \fIwget\fP is used to download files and uzbl-browser
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1223 includes a script that calls wget with appropriate options in
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1224 a prepared environment.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1225 .PP
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1226 Modern web browsers are proud to have addons, plugins, and modules, instead.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1227 This is their effort to achieve similar goals.
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1228 But instead of using existing, external programs, modern web browsers
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1229 include these functions, although they might be loaded at runtime.
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1230
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1231 .NH 2
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1232 Discussion of the design
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1233 .LP
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1234 This section discusses uzbl in regard of the Unix Philosophy,
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1235 as identified by Gancarz.
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1236
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1237 .PP
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1238 .B "Make each program do one thing well" .
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1239 Uzbl tries to be a web browser and nothing else.
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1240 The common definition of a web browser is, of course, highly influenced by
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1241 existing implementations of web browsers, although they are degenerated.
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1242 Web browsers should be programs to browse the web, and nothing more.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1243 This is the one thing they should do, as demanded by the Unix Philosophy.
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1244 .PP
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1245 Web browsers should, for instance, not manage downloads.
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1246 This is the job download managers exist for.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1247 Download managers do primary care about being good in downloading files.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1248 Modern web browsers provide download management only as a secondary feature.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1249 How could they perform this job better, than programs that exist only for
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1250 this very job?
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1251 And how could anyone want less than the best download manager available?
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1252 .PP
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1253 A web browser's job is to let the user browse the web.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1254 This means, navigating through websites by following links.
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1255 Rendering the \s-1HTML\s0 sources is a different job, too.
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1256 It is covered by the webkit render engine, in uzbl's case.
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1257 Audio and video content and files like PostScript, \s-1PDF\s0, and the like,
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1258 are also not the job of a web browser.
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1259 They should be handled by external applications \(en
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1260 ones which's job is to handle such data.
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1261 Uzbl strives to do it this way.
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1262 .PP
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1263 Remember Doug McIlroy:
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1264 .I
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1265 ``Write programs that do one thing and do it well.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1266 Write programs to work together.''
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1267 .R
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1268 .PP
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1269 The lesser tenet
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1270 .B "allow the user to tailor the environment
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1271 matches good here.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1272 There was the question, how anyone could want anything less than the
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1273 best program for the job.
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1274 But as personal preferences matter much,
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1275 it is probably more important to ask:
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1276 How could anyone want something else than his preferred program for the job?
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1277 .PP
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1278 Usually users want one program for one job.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1279 Hence, whenever the task is, for instance, downloading,
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1280 exactly one download manager should be used.
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1281 More advanced users might want to have this download manager in this
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1282 situation and that one in that situation.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1283 They should be able to configure it this way.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1284 With uzbl, one can use any download manager the user wants.
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1285 To switch to a different one, only one line in a small handler script
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1286 needs to be changed.
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1287 Alternatively it would be possible to query an entry in a global file
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1288 or an environment variable, which specifies the download manager to use,
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1289 in the handler script.
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1290 .PP
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1291 As uzbl does neither have its own download manager nor depends on a
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1292 specific one, thus uzbl's browsing abilities will not be lowered by having
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1293 a bad download manager.
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1294 Uzbl's download capabilities will just as good as the ones of the best
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1295 download manager available on the system.
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1296 Of course, this applies to all of the other supplementary tools, too.
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1297
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1298 .PP
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1299 .B "Use software leverage to your advantage" .
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1300 Shell scripts are a good choice to extend uzbl.
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1301 Uzbl is designed to be extended by external tools.
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1302 These external tools are usually wrapped by small handler shell scripts.
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1303 Shell scripts are the glue in this approach.
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1304 They make the various parts fit together.
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1305 .PP
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1306 As an example, the history mechanism of uzbl shall be presented.
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1307 Uzbl is configured to spawn a script to append an entry to the history
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1308 whenever the event of a fully loaded page occurs.
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1309 The script to append the entry to the history not much more than:
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1310 .DS
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1311 .CW
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1312 #!/bin/sh
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1313 file=/path/to/uzbl-history
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1314 echo `date +'%Y-%m-%d %H:%M:%S'`" $6 $7" >> $file
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1315 .DE
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1316 \f(CW$6\fP and \f(CW$7\fP expand to the \s-1URL\s0 and the page title.
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1317 For loading an entry, a key is bound to spawn a load from history script.
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1318 The script reverses the history to have newer entries first,
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1319 then displays \fIdmenu\fP to select an item,
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1320 and afterwards writes the selected \s-1URL\s0 into uzbl's command input pipe.
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1321 With error checking and corner cases removed, the script looks like this:
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1322 .DS
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1323 .CW
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1324 #!/bin/sh
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1325 file=/path/to/uzbl-history
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1326 goto=`tac $file | dmenu | cut -d' ' -f 3`
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1327 echo "uri $goto" > $4
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1328 .DE
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1329 \f(CW$4\fP expands to the path of the command input pipe of the current
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1330 uzbl instance.
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1331
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1332 .PP
33
0bd43c4ad9f8 removed quotes and used bold instead of italic
meillo@marmaro.de
parents: 32
diff changeset
1333 .B "Avoid captive user interfaces" .
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1334 One could say, that uzbl, to a large extend, actually \fIis\fP
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1335 a captive user interface.
37
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1336 But the difference to most other web browsers is, that uzbl is only
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1337 the captive user interface frontend and the core of the backend.
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1338 Many parts of the backend are independent of uzbl.
37
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1339 Some are distributed with uzbl, for some external programs, handler scripts
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1340 are distributed, arbitrary additional functionality can be added if desired.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1341 .PP
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1342 The frontend is captive \(en that is true.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1343 This is okay for the task of browsing the web, as this task is only relevant
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1344 for humans.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1345 Automated programs would \fIcrawl\fP the web.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1346 That means, they read the source directly.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1347 The source includes all the semantics.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1348 The graphical representation is just for humans to transfer the semantics
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1349 more intuitively.
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1350
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1351 .PP
33
0bd43c4ad9f8 removed quotes and used bold instead of italic
meillo@marmaro.de
parents: 32
diff changeset
1352 .B "Make every program a filter" .
37
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1353 Graphical web browsers are almost dead ends in the chain of information flow.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1354 Thus it is difficult to see what graphical web browsers should filter.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1355 Graphical web browsers exist almost only for interactive use by humans.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1356 The only case when one might want to automate the rendering function is
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1357 to generate images of rendered webpages.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1358
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1359 .PP
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1360 .B "Small is beautiful"
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1361 is not easy to apply to a web browser, primary because modern web technology
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1362 is very complex; hence the rendering task is very complex.
37
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1363 Modern web browsers will always consist of many thousand lines of code,
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1364 unfortunately.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1365 Using the toolchest approach and wrappers can split the browser into
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1366 several small parts, tough.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1367 .PP
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1368 Uzbl-core consists of about 3\,500 lines of C code.
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1369 The distribution includes another 3\,500 lines of Shell and Python code,
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1370 which are the handler scripts and plugins like a modal interface.
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1371 Further more, uzbl uses functionality of external tools like
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1372 \fIwget\fP and \fInetcat\fP.
37
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1373 Up to this point, uzbl looks pretty neat and small.
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1374 The ugly part of uzbl is the web content renderer, webkit.
37
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1375 Webkit consists of roughly 400\,000 (!) lines of code.
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1376 Unfortunately, small web render engines are not possible anymore
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1377 because of the modern web.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1378 The problems section will explain this in more detail.
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1379
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1380 .PP
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1381 .B "Build a prototype as soon as possible" .
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1382 Plaetinck made his code public, right from the beginning.
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1383 Discussion and development was, and still is, open to everyone interested.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1384 Development versions of uzbl can be obtained very simply from the code
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1385 repository.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1386 Within the first year of uzbl's existence, a new version was released
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1387 more often than once a month.
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1388 Different forks and branches arose.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1389 They introduced new features, which were tested for suitability.
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1390 The experiences of using prototypes influenced further development.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1391 Actually, all development was community driven.
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1392 Plaetinck says, three months after uzbl's birth:
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1393 ``Right now I hardly code anything myself for Uzbl.
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1394 I just merge in other people's code, ponder a lot, and lead the discussions.''
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1395 .[
36
4f2b2defbc8c some rework and more about uzbl design (ch05)
meillo@marmaro.de
parents: 35
diff changeset
1396 %A FIXME
35
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1397 %O http://lwn.net/Articles/341245/
f11406a85319 some minor rework; new content in ch05
meillo@marmaro.de
parents: 34
diff changeset
1398 .]
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1399
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1400
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1401 .NH 2
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1402 Problems
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1403 .LP
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1404 Similar to \s-1MH\s0, uzbl, too suffers from being different.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1405 It is sad, but people use what they know.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1406 Fortunately, uzbl's user interface can look and feel very much the
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1407 same as the one of the well known web browsers,
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1408 hiding the internal differences.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1409 But uzbl has to provide this similar look and feel to be accepted
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1410 as a ``normal'' browser by ``normal'' users.
37
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1411 .PP
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1412 The more important problem is the modern web.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1413 The modern web is simply broken.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1414 It has state in a state-less protocol,
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1415 it misuses technologies,
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1416 and it is helplessly overloaded.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1417 The result are web content render engines that must consist
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1418 of hundreds of thousands lines of code.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1419 They also must combine and integrate many different technologies,
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1420 only to make our modern web usable.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1421 Website to image converter are hardly possible to run without
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1422 human interaction because of state in sessions, impossible
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1423 deep-linking, and unautomatable technologies.
37
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1424 .PP
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1425 The web was misused to provide all kinds of imaginable wishes.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1426 Now web browsers, and eventually the users, suffer from it.
37
9282c4cea18c more about uzbl design
meillo@marmaro.de
parents: 36
diff changeset
1427
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
1428
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1429 .NH 2
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1430 Summary uzbl
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1431 .LP
38
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1432 ``Uzbl is a browser that adheres to the Unix Philosophy'',
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1433 that is how uzbl is seen by its authors.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1434 Indeed, uzbl follows the Unix Philosophy in many ways.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1435 It consists of independent parts that work together,
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1436 its core is mainly a mediator which glues the parts together.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1437 .PP
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1438 Software leverage can excellently be seen in uzbl.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1439 It makes use of external tools, separates independent tasks
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1440 in independent parts, and glues them together with small
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1441 handler scripts, around uzbl-core.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1442 .PP
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1443 As uzbl, more or less, consists of a set of tools and a bit
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1444 of glue, anyone can put the parts together and expand it
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1445 in any desired way.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1446 Uzbl is very flexible and customizable.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1447 These properties make it valuable for advanced users,
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1448 but may keep novice users from using it.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1449 .PP
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1450 Uzbl's main problem is the modern web, that makes it hard
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1451 to design a sane web browser.
3628e9649046 wrote uzbl summary and did several spell fixes
meillo@marmaro.de
parents: 37
diff changeset
1452 Despite this bad situation, uzbl does a fairly good job.
32
d632de027d77 wrote about uzbl (ch05)
meillo@marmaro.de
parents: 31
diff changeset
1453
8
924b2ac2d477 new text about toolchest and shell (ch03)
meillo@marmaro.de
parents: 7
diff changeset
1454
0
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1455 .NH 1
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1456 Final thoughts
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1457
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1458 .NH 2
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1459 Quick summary
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1460 .LP
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1461 good design
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1462 .LP
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1463 unix phil
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1464 .LP
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1465 case studies
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1466
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1467 .NH 2
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1468 Why people should choose
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1469 .LP
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1470 Make the right choice!
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1471
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1472 .nr PI .5i
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1473 .rm ]<
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1474 .de ]<
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1475 .LP
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1476 .de FP
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1477 .IP \\\\$1.
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1478 \\..
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1479 .rm FS FE
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1480 ..
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1481 .SH
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1482 References
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1483 .[
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1484 $LIST$
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1485 .]
cecef8bfa812 early version, mainly the outline
meillo@marmaro.de
parents:
diff changeset
1486 .wh -1p