summaryrefslogtreecommitdiff
path: root/doc/execline.html
blob: 25611d2756a4b8af4d8a19489b6de5352ca5b187 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="Content-Language" content="en" />
    <title>execline: the execline program</title>
    <meta name="Description" content="execline: the execline program" />
    <meta name="Keywords" content="execline command multicall" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="index.html">execline</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> The <tt>execline</tt> program </h1>

<p>
The <tt>execline</tt> program is only available when the
<tt>--enable-multicall</tt> option has been given to the <tt>configure</tt>
program at build time. In this configuration, <tt>execline</tt> is
a multicall binary implementing the functionality of <em>all</em>
the programs in the execline package; and the other programs, instead
of being executables of their own, are symbolic links to the
execline binary.
</p>

<h2> Interface </h2>

<pre>
     execline <em>subcommand</em> <em>subcommand_arguments...</em>
</pre>

<p>
 execline will run the <em>subcommand</em> with its arguments. For
instance, <tt>execline cd / ls</tt> will run the equivalent of the
<a href="cd.html">cd</a> program, so this command will list the contents
of the <tt>/</tt> directory.
</p>

<p>
 Alternatively, if execline is called with the name of an existing
command, it will run the equivalent of that command. For instance,
if the <tt>/usr/bin/cd</tt> file is a (hard or symbolic) link to
the <tt>execline</tt> binary, <tt>/usr/bin/cd / ls</tt> will list
the contents of the <tt>/</tt> directory.
</p>

<h2> Notes on the multicall configuration </h2>

<p>
 The <tt>--enable-multicall</tt> option is a user-requested feature
to save disk space. Its goal is purely to save disk space;
functionality-wise, the execline package should be the exact same
whether it has been built with <tt>--enable-multicall</tt> or not.
That means: any execline script should work the exact same way.
</p>

<p>
 Multicall binaries have a number of issues, most of them hidden
from regular users. One user-visible issue is that their behaviour
changes depending on how they are called, which is not good
practice (it breaks naming agnosticism) despite being common in
traditional Unix. Other, more important issues are only visible
to software authors and maintainers: for instance, they make it
difficult to add functionality to a software package without
inadvertently blowing up the amount of RAM used by the software,
and they encourage bad engineering practices to work around
specific problems created by this configuration.
</p>

<p>
 I am not a fan of multicall binaries at all.
</p>

<p>
 However, it just so happens that the execline package already was
a good candidate for a multicall configuration, and several users
had been asking for it (and complaining about the amount of disk
space that the traditional execline package uses). So I did an
experiment, and it turned out that a multicall execline binary
does save a <strong>huge</strong> amount of space. Depending on
your shared/static library configuration and your libc, the gain
in disk space on Linux can range from 66% to 87%! The results were
contrary to my expectations &mdash; and simply too good to pass up.
</p>

<p>
 So now, the multicall configuration is supported for execline.
Do not expect anything similar for other skarnet.org packages
such as <a href="//skarnet.org/software/s6/">s6</a>, because
they're not as good candidates and it would require a tremendous
amount of work for less benefit.
</p>

</body>
</html>